Functions
function	len (in obj)
	Return a scalar MATLAB whole-number containing the length of the input scalar or vector object. More...

Function Documentation

◆ len()

function len ( in obj )

Return a scalar MATLAB whole-number containing the length of the input scalar or vector object.

The following rules apply to computing the length:

If the input obj is a scalar object of type char or string and empty, then the output val is 0.
If the input obj is a scalar object of type char or string and non-empty, then the output val is 1.
If the input obj is a scalar object of type other than char or string, then the output val is 1. This is similar to the behavior of the MATLAB intrinsic length().
If the input obj is a vector and empty, then the output val is 0. This is similar to the behavior of the MATLAB intrinsic length().
If the input obj is a vector and non-empty, then the output val is the vector length as returned by length(obj) minus the number of empty elements.

Parameters

[in] obj : The input scalar or vector object whose length is to returned according to the rules above.

Returns: val : The output scalar MATLAB whole-number representing the length of the input object.

Possible calling interfaces ⛓

: val = pm.array.len(obj);

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

4assert(pm.array.len(1) == 1);

5assert(pm.array.len("") == 0);

6assert(pm.array.len([]) == 0);

7assert(pm.array.len('paramonte') == 1);

8assert(pm.array.len("paramonte") == 1);

9assert(pm.array.len(["pm", 'array']) == 2);

10assert(pm.array.len(["pm", 'array', []]) == 2);

11

12disp('pm.array.len("paramonte")')

13disp( pm.array.len("paramonte") )

14

15disp("pm.array.len('paramonte') == length('paramonte')")

16disp( pm.array.len('paramonte') == length('paramonte') )

17

18disp('pm.array.len("paramonte") == length("paramonte")')

19disp( pm.array.len("paramonte") == length("paramonte") )

len
function len(in obj)
Return a scalar MATLAB whole-number containing the length of the input scalar or vector object.

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

Example output ⛓
1pm.array.len("paramonte")

2 1

3pm.array.len('paramonte') == length('paramonte')

4 0

5pm.array.len("paramonte") == length("paramonte")

6 1

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, 4:25 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

Functions

Function Documentation

◆ len()