FileContentsSample Class Reference

This is the base class for generating objects that contain the contents of a sample/chain file generated by a ParaMonte sampler.
This class is meant to be primarily internally used by the ParaMonte MATLAB library samplers.
More...

Inheritance diagram for FileContentsSample:

Collaboration diagram for FileContentsSample:

Public Member Functions
function	FileContentsSample (in file, in silent, in sep)
	Return a scalar object of class pm.sampling.FileContentsSample. This is the constructor of the class pm.sampling.FileContentsSample. More...

Data Fields
Property	stats
Property	ndim
Property	sampleLogFuncColIndex
Property	sampleLogFuncColName

Detailed Description

This is the base class for generating objects that contain the contents of a sample/chain file generated by a ParaMonte sampler.
This class is meant to be primarily internally used by the ParaMonte MATLAB library samplers.

Note

See the documentation of the class constructor.

See below for information on the attributes (properties).

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:32 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 23 of file FileContentsSample.m.

Constructor & Destructor Documentation

FileContentsSample()

function FileContentsSample::FileContentsSample	(	in	file,
		in	silent,
		in	sep
	)

Return a scalar object of class pm.sampling.FileContentsSample.
This is the constructor of the class pm.sampling.FileContentsSample.

Parameters

[in]	file	: The input scalar MATLAB string containing the path to an external file.
[in]	silent	: See the corresponding argument of pm.sampling.FileContentsRestart class. (optional. The default is set by pm.sampling.FileContentsRestart.)
[in]	sep	: The input scalar MATLAB string containing the field separator used in the file. (optional, default = ",")

Returns

self : The output scalar object of class pm.sampling.FileContentsSample.

Possible calling interfaces ⛓

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

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

ndim

Property FileContentsSample::ndim

ndim : The scalar MATLAB integer representing the number of dimensions of the domain of the objective function sampled.
This integer is also the number of columns in the file that correspond that contain the sampled states from the domain of the mathematical objective function.

Definition at line 42 of file FileContentsSample.m.

sampleLogFuncColIndex

Property FileContentsSample::sampleLogFuncColIndex

sampleLogFuncColIndex : The scalar MATLAB integer representing the column index of the dataframe component df that contains the natural logarithm of the objective function values corresponding to the sampled states next to this column, such that the following relationship holds.

FileContentsSample.ndim =
FileContentsSample.ncol -
FileContentsSample.sampleLogFuncColIndex<br>

While this column index can be readily inferred by exploring the contents of the dataframe component, this column index is also computed and explicitly offered to conveniently slice the values of the sampled states and their corresponding log-function values.

Definition at line 60 of file FileContentsSample.m.

sampleLogFuncColName

Property FileContentsSample::sampleLogFuncColName

sampleLogFuncColName : The scalar MATLAB string representing the column name of the dataframe component df that contains the natural logarithm of the objective function values corresponding to the sampled states next to this column.

Definition at line 71 of file FileContentsSample.m.

stats

Property FileContentsSample::stats

stats : The scalar MATLAB object containing the set of computed properties of the contents of the file.

Definition at line 33 of file FileContentsSample.m.

---

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

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