2%> This is the base
class for generating objects
3%> that contain the contents of a progress file
4%> generated by a ParaMonte sampler.<br>
7%> This
class is meant to be primarily internally
8%> used by the ParaMonte MATLAB library samplers.<br>
9%> See the documentation of the
class constructor.<br>
12%> See below
for information on the attributes (properties).<br>
15%> See below
for information on the methods.<br>
20%> \JoshuaOsborne, May 21 2024, 1:09 AM, University of Texas at Arlington<br>
21%> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
22%> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute
for Computational Engineering and Sciences (ICES), UT Austin<br>
25 properties(Access =
public)
31 methods(Access = public)
39 %> \param[in] file : The input scalar MATLAB
string containing the path to an external file.<br>
40 %> \param[in] silent : The input scalar MATLAB logical.<br>
41 %> if ``true``, all descriptive messages will be suppressed.<br>
42 %> Setting this option to ``false`` is particularly useful
44 %> (**optional**, default = ``false``)
45 %> \param[in] sep : The input scalar MATLAB
string
46 %> containing the field separator used in the file.<br>
47 %> (**optional**, default = ``","``)
56 %> contents = pm.sampling.FileContentsProgress(file, [])
57 %> contents = pm.sampling.FileContentsProgress(file, silent)
58 %> contents = pm.sampling.FileContentsProgress(file, [], sep)
59 %> contents = pm.sampling.FileContentsProgress(file, silent, sep)
66 %> \JoshuaOsborne, May 21 2024, 1:11 AM, University of Texas at Arlington<br>
67 %> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
68 %> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute
for Computational Engineering and Sciences (ICES), UT Austin<br>
76 self = self@pm.io.FileContentsTabular(file, silent, sep);
This is the base class for generating objects that contain the contents of a progress file generated ...
function FileContentsProgress(in file, in silent, in sep)
Return a scalar object of class pm.sampling.FileContentsProgress.
This is the base class for generating objects that contain the tabular contents of a given file.
function parallel()
Return a scalar MATLAB logical that is true if and only if the current installation of MATLAB contain...