locname.m File Reference

Go to the source code of this file.

Functions
function	locname (in strlist, in keylist)
	Return the lists of values and indices of elements of the input strlist that match the input scalar (or vector of) string(s) or integer(s) index keylist. More...

Function Documentation

locname()

function locname	(	in	strlist,
		in	keylist
	)

Return the lists of values and indices of elements of the input strlist that match the input scalar (or vector of) string(s) or integer(s) index keylist.

Parameters

[in]	strlist	: The input scalar (or vector of) MATLAB string(s).
[in]	keylist	: The input scalar (or vector of) MATLAB string(s) or cell array of char vectors or vector of MATLAB integers or a cell array of mix of the element types to match the input strlist.

Returns

loclist : The output scalar (or vector of same size as keylist of) MATLAB integer(s) containing the location(s) of the occurrence(s) of the input keylist.
namlist : The output scalar (or vector of same size as keylist of) MATLAB string(s) containing the name(s) of the occurrence(s) of the input keylist.

Possible calling interfaces ⛓

[loclist, namlist] = pm.str.locname(strlist, keylist)

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.matlab.show()
pm.matlab.show('[loclist, namlist] = pm.str.locname(["library", "paramonte"], "paramonte")')
                [loclist, namlist] = pm.str.locname(["library", "paramonte"], "paramonte")
pm.matlab.show('loclist')
pm.matlab.show( loclist )
pm.matlab.show('namlist')
pm.matlab.show( namlist )
assert(namlist == "paramonte")
assert(loclist == 2)
 
pm.matlab.show()
pm.matlab.show('[loclist, namlist] = pm.str.locname(["library", "paramonte"], "paramonte")')
                [loclist, namlist] = pm.str.locname(["library", "paramonte"], ["paramonte", 1])
pm.matlab.show('loclist')
pm.matlab.show( loclist )
pm.matlab.show('namlist')
pm.matlab.show( namlist )
assert(all(namlist == ["paramonte", "library"]))
assert(all(loclist == [2, 1]))

Example output ⛓

 
[loclist, namlist] = pm.str.locname(["library", "paramonte"], "paramonte")
loclist =
     2
namlist = 
    "paramonte"
loclist
loclist
     2
namlist
namlist
paramonte
 
[loclist, namlist] = pm.str.locname(["library", "paramonte"], "paramonte")
loclist =
     2     1
namlist = 
  1x2 string array
    "paramonte"    "library"
loclist
loclist
     2     1
namlist
namlist
    "paramonte"    "library"

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