Functions
function	index (in array)
	Given `array(1 : n)`, return the array index `indx(1 : n)` such that `array(indx)` is in ascending order. More...

Function Documentation

◆ index()

function index ( in array )

Given array(1 : n), return the array index indx(1 : n) such that array(indx) is in ascending order.

This is a simple convenience wrapper around the MATLAB intrinsic function sort().

Note: Beware the output indx is not the rank of the elements of the input array.

Parameters

[in] array : The input MATLAB vector of sortable values (that can be passed to the MATLAB intrinsic function sort()).

Returns: indx : The output MATLAB integer vector of the same size as the input array such that array(indx) is in ascending order.

Possible calling interfaces ⛓

: indx = pm.sort.index(array)

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('array = [2.5, 4, 1.5, -3];')

6 array = [2.5, 4, 1.5, -3];

7pm.matlab.show('pm.sort.index(array)')

8pm.matlab.show( pm.sort.index(array) )

9pm.matlab.show('array(pm.sort.index(array))')

10pm.matlab.show( array(pm.sort.index(array)) )

11

12[~, indx] = sort(array);

13assert(all(pm.sort.index(array) == indx));

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

Example output ⛓
1

2array = [2.5, 4, 1.5, -3];

3pm.sort.index(array)

4 4 3 1 2

5array(pm.sort.index(array))

6 Columns 1 through 3

7 -3.000000000000000 1.500000000000000 2.500000000000000

8 Column 4

9 4.000000000000000

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, 3:55 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

◆ index()