This is the base class for generating objects that contain the contents of a progress file generated by a ParaMonte sampler.
More...

Inheritance diagram for FileContentsProgress:

[legend]

Collaboration diagram for FileContentsProgress:

[legend]

Public Member Functions
function	FileContentsProgress (in file, in silent, in sep)
	Return a scalar object of class pm.sampling.FileContentsProgress. More...

Detailed Description

This is the base class for generating objects that contain the contents of a progress 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.

Note: 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.

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.
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, 1:09 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 FileContentsProgress.m.

Constructor & Destructor Documentation

◆ FileContentsProgress()

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

Return a scalar object of class pm.sampling.FileContentsProgress.

This is the constructor of the class pm.sampling.FileContentsProgress.

Parameters

[in]	file	: The input scalar MATLAB string containing the path to an external file.
[in]	silent	: The input scalar MATLAB logical. if `true`, all descriptive messages will be suppressed. Setting this option to `false` is particularly useful in MPI-parallel simulations. (optional, default = `false`)
[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.FileContentsProgress.

Possible calling interfaces ⛓

: contents = pm.sampling.FileContentsProgress(file)

contents = pm.sampling.FileContentsProgress(file, [])

contents = pm.sampling.FileContentsProgress(file, silent)

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

contents = pm.sampling.FileContentsProgress(file, silent, sep)