Array.RankSort(Object) Method

 Top 

Description

Sorts all input StringArray and Array arguments in the order specified by the calling Array. Elements of the calling array should be integers where a positive value indicates an ascending sort and negative indicates a descending sort. For example, for a calling Array of {3, -1, 2}, the objects passed in as arguments will first be sorted based on ascending order of the third argument, then descending order of the first argument, and finally ascending order of the second argument. A value of zero in the calling Array stops the sorting, unless the zero is the first element of the calling Array, in which case it is treated as a 1.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

Array.RankSort(

Object synchronizedCollection)

 

 

Arguments

synchronizedCollection

Description:

An Array or StringArray which will be sorted in the order specified by the calling Array

Repeatable:

0 to Unlimited times

 

 

 

Return Value

Type:

number

 

 

Returns the number of rows in the input arrays.

 

Syntax

myVariable1 = myArray1.RankSort(myObject1);

 

 

Example 1

This example demonstrates how to use the Array.RankSort method to sort a numerical Array and StringArrays.

 

// Create Objects

StringArray letters;

StringArray letters2;

Array numbers;

Array sortArray;

Variable i;

 

 

// Initialize the Array/StringArrays

letters  = {"b", "a", "a", "a", "c", "d", "c", "b", "e"};

numbers  = { 1,   3,   5,   2,   5,   2,   4,   2,  3};

letters2 = {"j", "f", "h", "f", "i", "g", "h", "i", "g" };

 

 

// Initialize sortArray

sortArray = {3, -1, 2}; // Sort by the third argument, first argument in reverse order, and then the second argument

 

// Sort the Array/StringArrays and report the results

sortArray.RankSort(letters, numbers, letters2);

For i = 0 to letters.Dimension - 1;

 Report letters[i], numbers[i]<3,0>, letters2[i];

End;

 

 

Output Report:

 

letters

numbers

letters2

a

2

f

a

3

f

e

3

g

d

2

g

c

4

h

a

5

h

c

5

i

b

2

i

b

1

j

 

 

 

 

 

See also

Array Object

Matrix, Array, and Variable Math Guide