SpecMCMC Class Reference

This is the base class for the ParaMonte sampler MCMC specifications.
This is an abstract class that is not meant to be used by the user.
See the class constructor.
More...

Inheritance diagram for SpecMCMC:

Collaboration diagram for SpecMCMC:

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

Data Fields
Property	outputChainSize
Property	outputSampleRefinementCount
Property	outputSampleRefinementMethod
Property	proposal
Property	proposalCor
Property	proposalCov
Property	proposalScale
Property	proposalStart
Property	proposalStartDomainCubeLimitLower
Property	proposalStartDomainCubeLimitUpper
Property	proposalStartRandomized
Property	proposalStd

Detailed Description

This is the base class for the ParaMonte sampler MCMC specifications.
This is an abstract class that is not meant to be used by the user.
See the class constructor.

Note

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

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, 12:54 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 18 of file SpecMCMC.m.

Constructor & Destructor Documentation

SpecMCMC()

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

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

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.SpecMCMC.

Possible calling interfaces ⛓

spec = pm.sampling.SpecMCMC()
spec = pm.sampling.SpecMCMC([])
spec = pm.sampling.SpecMCMC([], [])
spec = pm.sampling.SpecMCMC(method)
spec = pm.sampling.SpecMCMC(method, [])
spec = pm.sampling.SpecMCMC([], silent)
spec = pm.sampling.SpecMCMC(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, 12:58 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 SpecMCMC::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.SpecMCMC.

Parameters

[in]	self	: The input parent object of class pm.sampling.SpecMCMC 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, 1:01 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

outputChainSize

Property SpecMCMC::outputChainSize

Definition at line 26 of file SpecMCMC.m.

outputSampleRefinementCount

Property SpecMCMC::outputSampleRefinementCount

Definition at line 28 of file SpecMCMC.m.

outputSampleRefinementMethod

Property SpecMCMC::outputSampleRefinementMethod

Definition at line 30 of file SpecMCMC.m.

proposal

Property SpecMCMC::proposal

Definition at line 32 of file SpecMCMC.m.

proposalCor

Property SpecMCMC::proposalCor

Definition at line 34 of file SpecMCMC.m.

proposalCov

Property SpecMCMC::proposalCov

Definition at line 36 of file SpecMCMC.m.

proposalScale

Property SpecMCMC::proposalScale

Definition at line 38 of file SpecMCMC.m.

proposalStart

Property SpecMCMC::proposalStart

Definition at line 40 of file SpecMCMC.m.

proposalStartDomainCubeLimitLower

Property SpecMCMC::proposalStartDomainCubeLimitLower

Definition at line 42 of file SpecMCMC.m.

proposalStartDomainCubeLimitUpper

Property SpecMCMC::proposalStartDomainCubeLimitUpper

Definition at line 44 of file SpecMCMC.m.

proposalStartRandomized

Property SpecMCMC::proposalStartRandomized

Definition at line 46 of file SpecMCMC.m.

proposalStd

Property SpecMCMC::proposalStd

Definition at line 48 of file SpecMCMC.m.

---

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

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