SpecDRAM Class Reference

This is the base class for the ParaMonte sampler DRAM specifications.
More...

Inheritance diagram for SpecDRAM:

Collaboration diagram for SpecDRAM:

Public Member Functions
function	SpecDRAM (in method, in silent)
	Construct and return an object of class pm.sampling.SpecDRAM. More...
function	getEntriesNML (in self, in ndim)
	Ensure all specification properties of the parent object are sensible. More...

Data Fields
Property	proposalAdaptationBurnin
Property	proposalAdaptationCount
Property	proposalAdaptationCountGreedy
Property	proposalAdaptationPeriod
Property	proposalDelayedRejectionCount
Property	proposalDelayedRejectionScale

Detailed Description

This is the base class for the ParaMonte sampler DRAM specifications.

This is an abstract class that is not meant to be used by the user.
See the class constructor documentation.

Note

All class attributes can be set after constructing an instance of this class.

The DRAM simulation specifications are all described on this page: ParaDRAM simulation specifications listing

See below for information on the methods.

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 3:45 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Definition at line 24 of file SpecDRAM.m.

Constructor & Destructor Documentation

SpecDRAM()

function SpecDRAM::SpecDRAM	(	in	method,
		in	silent
	)

Construct and return an object of class pm.sampling.SpecDRAM.

Parameters

[in]	method	: The input scalar MATLAB string containing the name of the specific ParaMonte sampler whose simulation specifications are to be stored in the output of this constructor.
[in]	silent	: The input scalar MATLAB logical. If true, all descriptive messages on the MATLAB command line will be suppressed. (optional, default = false)

Returns

The output scalar object of class pm.sampling.SpecDRAM.

Possible calling interfaces ⛓

spec = pm.sampling.SpecDRAM()
spec = pm.sampling.SpecDRAM([])
spec = pm.sampling.SpecDRAM([], [])
spec = pm.sampling.SpecDRAM(method)
spec = pm.sampling.SpecDRAM(method, [])
spec = pm.sampling.SpecDRAM([], silent)
spec = pm.sampling.SpecDRAM(method, silent)

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 3:46 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Member Function Documentation

getEntriesNML()

function SpecDRAM::getEntriesNML	(	in	self,
		in	ndim
	)

Ensure all specification properties of the parent object are sensible.

This is a dynamic method of the class pm.sampling.SpecDRAM.

Parameters

[in]	self	: The input parent object of class pm.sampling.SpecDRAM which is implicitly passed to this dynamic method (not by the user).
[in]	ndim	: The input scalar MATLAB integer containing the number of dimensions of the domain of the object function that is to be explored.

Returns

entries : The output scalar MATLAB string containing the simulation specifications converted to a Fortran-namelist-compatible entry.

Possible calling interfaces ⛓

entries = self.getEntriesNML(ndim)

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 3:48 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Field Documentation

proposalAdaptationBurnin

Property SpecDRAM::proposalAdaptationBurnin

Definition at line 32 of file SpecDRAM.m.

proposalAdaptationCount

Property SpecDRAM::proposalAdaptationCount

Definition at line 34 of file SpecDRAM.m.

proposalAdaptationCountGreedy

Property SpecDRAM::proposalAdaptationCountGreedy

Definition at line 36 of file SpecDRAM.m.

proposalAdaptationPeriod

Property SpecDRAM::proposalAdaptationPeriod

Definition at line 38 of file SpecDRAM.m.

proposalDelayedRejectionCount

Property SpecDRAM::proposalDelayedRejectionCount

Definition at line 40 of file SpecDRAM.m.

proposalDelayedRejectionScale

Property SpecDRAM::proposalDelayedRejectionScale

Definition at line 42 of file SpecDRAM.m.

---

The documentation for this class was generated from the following file:

• src/matlab/main/+pm/+sampling/SpecDRAM.m