This is the base class for generating objects that contain the contents of a chain file generated by the ParaMonte MCMC samplers such as pm.sampling.Paradram.
More...

Inheritance diagram for FileContentsChainMCMC:

[legend]

Collaboration diagram for FileContentsChainMCMC:

[legend]

Public Member Functions
function	FileContentsChainMCMC (in file, in silent, in sep, in format)
	Return a scalar object of class pm.sampling.FileContentsChainMCMC. More...

function	setstats (in self)
	Compute the statistics of the parent object of class pm.sampling.FileContentsChainMCMC and store the results in the respective fields of the `stats` attribute of the parent object. More...

function	setvis (in self)
	Compute the statistics of the parent object of class pm.sampling.FileContentsChainMCMC and store the results in the respective fields of the `stats` attribute of the parent object. More...

Detailed Description

This is the base class for generating objects that contain the contents of a chain file generated by the ParaMonte MCMC samplers such as pm.sampling.Paradram.

This class is meant to be primarily internally used by the ParaMonte MATLAB library samplers.
This class merely adds a number of visualizations to its superclass which are specific to the pm.sampling.Paradram sampler.

Note: See also the documentation of the class constructor pm.sampling.FileContentsChainMCMC::FileContentsChainMCMC.; See also the documentation of the superclass pm.sampling.FileContentsChain.; See below for information on the attributes (properties).; See below for information on the class 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.

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:: 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 28 of file FileContentsChainMCMC.m.

Constructor & Destructor Documentation

◆ FileContentsChainMCMC()

function FileContentsChainMCMC::FileContentsChainMCMC	(	in	file,
		in	silent,
		in	sep,
		in	format
	)

Return a scalar object of class pm.sampling.FileContentsChainMCMC.

This is the constructor of the class pm.sampling.FileContentsChainMCMC.

Parameters

[in]	file	: The input scalar MATLAB string containing the path or web address to an external file.
[in]	silent	: See the corresponding argument of the superclass constructor pm.sampling.FileContentsChain::FileContentsChain. (optional. The default is set by the superclass constructor pm.sampling.FileContentsChain::FileContentsChain.)
[in]	sep	: See the corresponding argument of the superclass constructor pm.sampling.FileContentsChain::FileContentsChain. (optional. The default is set by the superclass constructor pm.sampling.FileContentsChain::FileContentsChain.)
[in]	format	: The input scalar MATLAB string containing the reading format of the Markov chain: If `format` is set to `"compact"`, the Markov chain will be read in compact (weighted) format. This format is fast and potentially highly memory-efficient. Beware that this format does not necessarily generate a compact chain when the specified chain file is already written in verbose format. If `format` is set to `"verbose"`, the Markov chain will be read in verbose (unweighted or unrolled) format. While the chain in this format is the actual Markov chain, reading the chain in this format can be highly inefficient as it can use too much memory for high-dimensional density functions. (optional, default = `"compact"`.)

Returns: self : The output scalar object of class pm.sampling.FileContentsChainMCMC.

Possible calling interfaces ⛓

: contents = pm.sampling.FileContentsChainMCMC(file)

contents = pm.sampling.FileContentsChainMCMC(file, [])

contents = pm.sampling.FileContentsChainMCMC(file, silent)

contents = pm.sampling.FileContentsChainMCMC(file, [], sep)

contents = pm.sampling.FileContentsChainMCMC(file, silent, sep)

Remarks: See also the documentation of the subclasses for example usage.

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

◆ setstats()

function FileContentsChainMCMC::setstats ( in self )

Compute the statistics of the parent object of class pm.sampling.FileContentsChainMCMC and store the results in the respective fields of the stats attribute of the parent object.

This is a dynamic Hidden method of class pm.sampling.FileContentsChainMCMC.
It is inaccessible to the end users of the library.

Parameters

[in] self : The input parent object of class pm.sampling.FileContentsChainMCMC which is implicitly passed to this dynamic method (not by the user).

Possible calling interfaces ⛓

: contents = pm.sampling.FileContentsChainMCMC();

contents.setstats();

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:: Amir Shahmoradi, 2:11 PM Friday, November 8, 2024, Dallas, TX
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

◆ setvis()

function FileContentsChainMCMC::setvis ( in self )

Compute the statistics of the parent object of class pm.sampling.FileContentsChainMCMC and store the results in the respective fields of the stats attribute of the parent object.

This is a dynamic Hidden method of class pm.sampling.FileContentsChainMCMC.
It is inaccessible to the end users of the library.

Parameters

[in] self : The input parent object of class pm.sampling.FileContentsChainMCMC which is implicitly passed to this dynamic method (not by the user).

Possible calling interfaces ⛓

: contents = pm.sampling.FileContentsChainMCMC();

contents.setvis();

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:: Amir Shahmoradi, 2:12 PM Friday, November 8, 2024, Dallas, TX
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.

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

src/matlab/main/+pm/+sampling/FileContentsChainMCMC.m

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FileContentsChainMCMC()

Member Function Documentation

◆ setstats()

◆ setvis()