ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
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...
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 |
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.
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.
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.
Definition at line 23 of file FileContentsSample.m.
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.
[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 = "," ) |
self
: The output scalar object of class pm.sampling.FileContentsSample.
Possible calling interfaces ⛓
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.
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.
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.
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.
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.
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.
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.