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 restart file generated by a ParaMonte sampler.
More...
Public Member Functions | |
function | FileContentsRestart (in file, in silent, in method) |
Return a scalar object of class pm.sampling.FileContentsRestart. More... | |
Data Fields | |
Property | count |
Property | ndim |
Property | domainAxisName |
Property | contents |
Property | method |
Property | lineList |
Property | lineListLen |
Property | ilast |
This is the base class for generating objects that contain the contents of a restart file generated by a ParaMonte sampler.
This class is meant to be primarily internally used by the ParaMonte MATLAB library samplers.
See the documentation of the class constructor.
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 26 of file FileContentsRestart.m.
function FileContentsRestart::FileContentsRestart | ( | in | file, |
in | silent, | ||
in | method | ||
) |
Return a scalar object of class pm.sampling.FileContentsRestart.
This is the constructor of the class pm.sampling.FileContentsRestart.
[in] | file | : The input scalar MATLAB string containing the path to an external restart file. |
[in] | silent | : See the corresponding argument of pm.io.FileContents class. (optional. The default is set by pm.io.FileContents.) |
[in] | method | : The input scalar MATLAB string containing the sampling method name. The input value must be any of the following:
|
self
: The output scalar object of class pm.sampling.FileContentsRestart.
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 FileContentsRestart::contents |
contents
: The scalar MATLAB string containing the entire contents of the restart file with all Carriage Return characters removed (relevant only to Windows OS).
Definition at line 55 of file FileContentsRestart.m.
Property FileContentsRestart::count |
count
: The scalar MATLAB integer containing the number of restart entries in the specified restart file.
Definition at line 36 of file FileContentsRestart.m.
Property FileContentsRestart::domainAxisName |
domainAxisName
: The vector of MATLAB strings of size ndim
containing the domain axes names of the density function explored.
Definition at line 48 of file FileContentsRestart.m.
Property FileContentsRestart::ilast |
Definition at line 66 of file FileContentsRestart.m.
Property FileContentsRestart::lineList |
Definition at line 62 of file FileContentsRestart.m.
Property FileContentsRestart::lineListLen |
Definition at line 64 of file FileContentsRestart.m.
Property FileContentsRestart::method |
Definition at line 60 of file FileContentsRestart.m.
Property FileContentsRestart::ndim |
ndim
: The scalar MATLAB integer containing the number of dimensions of the domain of the objective function.
Definition at line 42 of file FileContentsRestart.m.