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

Inheritance diagram for SpecBase:

Collaboration diagram for SpecBase:

Public Member Functions
function	SpecBase (in method, in silent)
	Construct and return an object of class pm.sampling.SpecBase. More...

function	doc (in self, in specification)
	Return documentation help for the input simulation specification name. More...

function	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.SpecBase. More...

Data Fields
Property	description
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#description More...

Property	domain
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domain More...

Property	domainAxisName
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainaxisname More...

Property	domainBallAvg
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballavg More...

Property	domainBallCor
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcor More...

Property	domainBallCov
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcov More...

Property	domainBallStd
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballstd More...

Property	domainCubeLimitLower
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitlower More...

Property	domainCubeLimitUpper
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitupper More...

Property	domainErrCount
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcount More...

Property	domainErrCountMax
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcountmax More...

Property	outputChainFileFormat
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputchainfileformat More...

Property	outputColumnWidth
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputcolumnwidth More...

Property	outputFileName
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputfilename More...

Property	outputStatus
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputstatus More...

Property	outputPrecision
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputprecision More...

Property	outputReportPeriod
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputreportperiod More...

Property	outputRestartFileFormat
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputrestartfileformat More...

Property	outputSampleSize
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsamplesize More...

Property	outputSeparator
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputseparator More...

Property	outputSplashMode
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsplashmode More...

Property	parallelism
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelism More...

Property	parallelismMpiFinalizeEnabled
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelismmpifinalizeenabled More...

Property	parallelismNumThread
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelismnumthread More...

Property	randomSeed
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#randomseed More...

Property	targetAcceptanceRate
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#targetacceptancerate More...

Protected Attributes
Property	url

Property	method

Property	silent

Property	nmlsep

Detailed Description

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

This is a low-level class that is not meant to be used by the user.

Note: See the documentation of the class constructor.; All class attributes can be set after constructing an instance of this class.; See below for information on the methods.

See also: ParaDRAM simulation specifications listing

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.

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.
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:38 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 25 of file SpecBase.m.

Constructor & Destructor Documentation

◆ SpecBase()

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

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

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

See also: ParaDRAM simulation specifications listing

Possible calling interfaces ⛓

: spec = pm.sampling.SpecBase()

spec = pm.sampling.SpecBase([])

spec = pm.sampling.SpecBase([], [])

spec = pm.sampling.SpecBase(method)

spec = pm.sampling.SpecBase(method, [])

spec = pm.sampling.SpecBase([], silent)

spec = pm.sampling.SpecBase(method, silent)

SpecBase::silent
Property silent
Definition: SpecBase.m:120

SpecBase::method
Property method
Definition: SpecBase.m:118

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.

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.
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:40 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

◆ doc()

function SpecBase::doc	(	in	self,
		in	specification
	)

Return documentation help for the input simulation specification name.

Otherwise, return documentation help for all simulation specifications if the input specification argument is missing.

Developer Remark:: The underlying reason for unifying documentation of object attributes within a single online page is to significantly reduce duplication and work required for generating and maintaining such documentation across all supported programming language environments.

Parameters

[in]	self	: The input parent object of class pm.sampling.SpecBase which is implicitly passed to this dynamic method (not by the user).
[in]	specification	: The input scalar MATLAB string containing the name of a simulation specification corresponding an attribute of the parent object.

Returns: weblink : The output scalar MATLAB string containing the web address for the documentation of the requested simulation specification.

Possible calling interfaces ⛓

: weblink = self.doc()

weblink = self.doc(specification)

weblink
function weblink(in silent)
Return a scalar MATLAB string containing the download weblink to latest ParaMonte MATLAB library vers...

Example usage ⛓

: pmpd.spec.doc() % return help for all specifications.

pmpd.spec.doc("outputFileName") % return help for the specification ``outputFileName``.

SpecBase::outputFileName
Property outputFileName
See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/...
Definition: SpecBase.m:73

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.

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.
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:42 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

◆ getEntriesNML()

function SpecBase::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.SpecBase.

Parameters

[in,out]	self	: The input/output parent object of class pm.sampling.SpecBase 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.

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.
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:43 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