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 | FileContentsRestartDRAM (in file, in silent) |
Return a scalar object of class pm.sampling.FileContentsRestartDRAM. More... | |
function | warn (in self) |
Data Fields | |
Property | meanAcceptanceRateSinceStart |
Property | proposalAdaptiveScaleSq |
Property | proposalCor |
Property | proposalCov |
Property | proposalLogVolume |
Property | proposalMean |
Property | uniqueStateVisitCount |
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 30 of file FileContentsRestartDRAM.m.
function FileContentsRestartDRAM::FileContentsRestartDRAM | ( | in | file, |
in | silent | ||
) |
Return a scalar object of class pm.sampling.FileContentsRestartDRAM.
This is the constructor of the class pm.sampling.FileContentsRestartDRAM.
[in] | file | : The input scalar MATLAB string containing the path to an external report file. |
[in] | silent | : See the corresponding argument of pm.sampling.FileContentsRestart class. (optional. The default is set by pm.sampling.FileContentsRestart.) |
self
: The output scalar object of class pm.sampling.FileContentsRestartDRAM.
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.
function FileContentsRestartDRAM::warn | ( | in | self | ) |
Property FileContentsRestartDRAM::meanAcceptanceRateSinceStart |
meanAcceptanceRateSinceStart
: The real-valued MATLAB array of rank 1
of shape (1:self.count)
containing the set of average MCMC acceptance rates of the sampler proposal distribution over the course of the simulation.
Definition at line 44 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::proposalAdaptiveScaleSq |
Definition at line 52 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::proposalCor |
Definition at line 61 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::proposalCov |
Definition at line 70 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::proposalLogVolume |
Definition at line 79 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::proposalMean |
Definition at line 88 of file FileContentsRestartDRAM.m.
Property FileContentsRestartDRAM::uniqueStateVisitCount |
Definition at line 96 of file FileContentsRestartDRAM.m.