FileContentsTabular Class Reference

This is the base class for generating objects that contain the tabular contents of a given file. More...

Inheritance diagram for FileContentsTabular:

Collaboration diagram for FileContentsTabular:

Public Member Functions
function	FileContentsTabular (in file, in silent, in sep)
	Construct and return a scalar object of class pm.io.FileContentsTabular. More...

Data Fields
Property	sep
Property	ncol
Property	nrow
Property	df

Detailed Description

This is the base class for generating objects that contain the tabular contents of a given file.

This class is meant to be primarily internally used by the ParaMonte library routines (e.g., samplers).

Tabular file comprises a header line followed by a table of data.
If there are more than one header line, only the last such line is considered as header and the rest are discarded as text.

Note

See the documentation of the class constructor.

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.

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, 6:08 PM, 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 28 of file FileContentsTabular.m.

Constructor & Destructor Documentation

FileContentsTabular()

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

Construct and return a scalar object of class pm.io.FileContentsTabular.

This is the constructor of the class pm.io.FileContentsTabular.

Parameters

[in]	file	: See the documentation of the corresponding argument of pm.io.FileContents.
[in]	silent	: See the documentation of the corresponding argument of pm.io.FileContents.
[in]	sep	: The input scalar MATLAB string containing the field separator used in the file. Use "\t" to represent the horizontal tab character. (optional. The default is inferred from the contents of the specified input file.)

Returns

self : The output scalar object of class pm.io.FileContentsTabular.

Possible calling interfaces ⛓

contents = pm.io.FileContentsTabular(file)
contents = pm.io.FileContentsTabular(file, [])
contents = pm.io.FileContentsTabular(file, silent)
contents = pm.io.FileContentsTabular(file, [], [])
contents = pm.io.FileContentsTabular(file, [], sep)
contents = pm.io.FileContentsTabular(file, silent, [])
contents = pm.io.FileContentsTabular(file, silent, sep)

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, 6:11 PM, 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

df

Property FileContentsTabular::df

df

The scalar MATLAB table containing the contents of the file as a dataframe.

Definition at line 67 of file FileContentsTabular.m.

ncol

Property FileContentsTabular::ncol

ncol

The scalar MATLAB integer representing the number of columns identified in the file.

Definition at line 51 of file FileContentsTabular.m.

nrow

Property FileContentsTabular::nrow

nrow

The scalar MATLAB integer representing the number of rows identified in the file.

Definition at line 59 of file FileContentsTabular.m.

sep

Property FileContentsTabular::sep

sep

The scalar MATLAB string representing the field separator used in the file.
This property is either specified by the user or is inferred from the file to be read.

Definition at line 43 of file FileContentsTabular.m.

---

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

• src/matlab/main/+pm/+io/FileContentsTabular.m