Functions
function	list (in path)
	Return a cell vector of MATLAB string values each of which corresponds to one non-default file or folder path in the specified input directory path. More...

Function Documentation

◆ list()

function list ( in path )

Return a cell vector of MATLAB string values each of which corresponds to one non-default file or folder path in the specified input directory path.

Note: The primary use of this function is to create a list of items in a given folder while excluding the default system items which includes the current and parent directories.

Parameters

[in] path : The input scalar MATLAB string or character containing the path to an existing directory whose file and folder contents should be listed, excluding the default "." and ".." system paths.
(optional, default = ".")

Returns: namelist : A MATLAB cell vector, each element of which corresponds to an existing non-default file or folder in the specified input directory path.
If the input path contains a base directory name, the name will be prefixed to each item in the output namelist.
If the input path is not a directory or is empty, the output namelist will be empty.

Possible calling interfaces ⛓

: namelist = pm.sys.path.list()

namelist = pm.sys.path.list(path)

Example usage ⛓

: 1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.

2addpath('../../../../'); % Add the ParaMonte library root directory to the search path.

3

4pm.matlab.show()

5pm.matlab.show('pm.sys.path.list()')

6pm.matlab.show( pm.sys.path.list() )

7

8pm.matlab.show()

9pm.matlab.show('pm.sys.path.list("*.out*")')

10pm.matlab.show( pm.sys.path.list("*.out*") )

11

12pm.matlab.show()

13pm.matlab.show('pm.sys.path.list("..")')

14pm.matlab.show( pm.sys.path.list("..") )

root
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output ⛓
1

2pm.sys.path.list()

3 "main.m"

4 "main.out.m"

5

6pm.sys.path.list("*.out*")

7

8pm.sys.path.list("..")

9 "abs"

10 "glob"

11 "home"

12 "list"

13 "mpiexec"

14 "rmfile"

15 "webglob"

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, 5:26 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

Functions

Function Documentation

◆ list()