FileContentsRestart Class Reference

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

Inheritance diagram for FileContentsRestart:

Collaboration diagram for FileContentsRestart:

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

Detailed Description

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.

Note

See below for information on the attributes (properties).

See below for information on the methods.

Returns

An object of class pm.sampling.FileContentsRestart.

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.

1. 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.
   
2. 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, 3:19 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 26 of file FileContentsRestart.m.

Constructor & Destructor Documentation

FileContentsRestart()

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.

Parameters

[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: "ParaDRAM" "ParaDISE" "ParaNest" (optional. If missing, some of the restart file contents will not be (properly) parsed.)

Returns

self : The output scalar object of class pm.sampling.FileContentsRestart.

Possible calling interfaces ⛓

contents = pm.sampling.FileContentsRestart(file)
contents = pm.sampling.FileContentsRestart(file, [])
contents = pm.sampling.FileContentsRestart(file, silent)
contents = pm.sampling.FileContentsRestart(file, [], [])
contents = pm.sampling.FileContentsRestart(file, silent, [])
contents = pm.sampling.FileContentsRestart(file, silent, method)

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.

1. 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.
   
2. 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, 3:25 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

Field Documentation

contents

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 65 of file FileContentsRestart.m.

count

Property FileContentsRestart::count

count

The scalar MATLAB integer containing the number of restart entries in the specified restart file.

Definition at line 40 of file FileContentsRestart.m.

domainAxisName

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 56 of file FileContentsRestart.m.

ilast

Property FileContentsRestart::ilast

ilast

The Hidden scalar MATLAB whole-number component containing the number of the lines parsed up a given point in the internals of the class methods.

Warning

This is an internal class attribute that is inaccessible to the end users.

Definition at line 119 of file FileContentsRestart.m.

lineList

Property FileContentsRestart::lineList

lineList

The Hidden scalar MATLAB string array containing the list of all restart file lines.

Warning

This is an internal class attribute that is inaccessible to the end users.

Definition at line 94 of file FileContentsRestart.m.

lineListLen

Property FileContentsRestart::lineListLen

lineListLen

The Hidden scalar MATLAB whole-number containing the length of the class component lineList.

Warning

This is an internal class attribute that is inaccessible to the end users.

Definition at line 106 of file FileContentsRestart.m.

method

Property FileContentsRestart::method

method

The Hidden scalar MATLAB string component containing the sampling method name.

Warning

This is an internal class attribute that is inaccessible to the end users.

Definition at line 82 of file FileContentsRestart.m.

ndim

Property FileContentsRestart::ndim

ndim

The scalar MATLAB integer containing the number of dimensions of the domain of the objective function.

Definition at line 48 of file FileContentsRestart.m.

---

The documentation for this class was generated from the following file:

• src/matlab/main/+pm/+sampling/FileContentsRestart.m