SpecBase Class Reference

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
Property	domain
Property	domainAxisName
Property	domainBallAvg
Property	domainBallCor
Property	domainBallCov
Property	domainBallStd
Property	domainCubeLimitLower
Property	domainCubeLimitUpper
Property	domainErrCount
Property	domainErrCountMax
Property	outputChainFileFormat
Property	outputColumnWidth
Property	outputFileName
Property	outputStatus
Property	outputPrecision
Property	outputReportPeriod
Property	outputRestartFileFormat
Property	outputSampleSize
Property	outputSeparator
Property	outputSplashMode
Property	parallelism
Property	parallelismMpiFinalizeEnabled
Property	parallelismNumThread
Property	randomSeed
Property	targetAcceptanceRate

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.

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: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)

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: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)

Example usage ⛓

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

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

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

Field Documentation

description

Property SpecBase::description

Definition at line 33 of file SpecBase.m.

domain

Property SpecBase::domain

Definition at line 35 of file SpecBase.m.

domainAxisName

Property SpecBase::domainAxisName

Definition at line 37 of file SpecBase.m.

domainBallAvg

Property SpecBase::domainBallAvg

Definition at line 39 of file SpecBase.m.

domainBallCor

Property SpecBase::domainBallCor

Definition at line 41 of file SpecBase.m.

domainBallCov

Property SpecBase::domainBallCov

Definition at line 43 of file SpecBase.m.

domainBallStd

Property SpecBase::domainBallStd

Definition at line 45 of file SpecBase.m.

domainCubeLimitLower

Property SpecBase::domainCubeLimitLower

Definition at line 47 of file SpecBase.m.

domainCubeLimitUpper

Property SpecBase::domainCubeLimitUpper

Definition at line 49 of file SpecBase.m.

domainErrCount

Property SpecBase::domainErrCount

Definition at line 51 of file SpecBase.m.

domainErrCountMax

Property SpecBase::domainErrCountMax

Definition at line 53 of file SpecBase.m.

method

Property SpecBase::method

protected

Definition at line 92 of file SpecBase.m.

nmlsep

Property SpecBase::nmlsep

protected

Definition at line 96 of file SpecBase.m.

outputChainFileFormat

Property SpecBase::outputChainFileFormat

Definition at line 55 of file SpecBase.m.

outputColumnWidth

Property SpecBase::outputColumnWidth

Definition at line 57 of file SpecBase.m.

outputFileName

Property SpecBase::outputFileName

Definition at line 59 of file SpecBase.m.

outputPrecision

Property SpecBase::outputPrecision

Definition at line 63 of file SpecBase.m.

outputReportPeriod

Property SpecBase::outputReportPeriod

Definition at line 65 of file SpecBase.m.

outputRestartFileFormat

Property SpecBase::outputRestartFileFormat

Definition at line 67 of file SpecBase.m.

outputSampleSize

Property SpecBase::outputSampleSize

Definition at line 69 of file SpecBase.m.

outputSeparator

Property SpecBase::outputSeparator

Definition at line 71 of file SpecBase.m.

outputSplashMode

Property SpecBase::outputSplashMode

Definition at line 73 of file SpecBase.m.

outputStatus

Property SpecBase::outputStatus

Definition at line 61 of file SpecBase.m.

parallelism

Property SpecBase::parallelism

Definition at line 75 of file SpecBase.m.

parallelismMpiFinalizeEnabled

Property SpecBase::parallelismMpiFinalizeEnabled

Definition at line 77 of file SpecBase.m.

parallelismNumThread

Property SpecBase::parallelismNumThread

Definition at line 79 of file SpecBase.m.

randomSeed

Property SpecBase::randomSeed

Definition at line 81 of file SpecBase.m.

silent

Property SpecBase::silent

protected

Definition at line 94 of file SpecBase.m.

targetAcceptanceRate

Property SpecBase::targetAcceptanceRate

Definition at line 83 of file SpecBase.m.

url

Property SpecBase::url

protected

Definition at line 90 of file SpecBase.m.

---

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

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