Rank (FPScript)
Determines the number of dimensions of a data set.
Syntax
Rank(DataSet)
The syntax of the Rank function consists of the following parts:
Part |
Description |
|---|---|
DataSet |
The data set for which the number of dimensions is to be determined. All data structures are allowed. All data types are permitted. |
Remarks
As the result the function returns a scalar value of data type 64-bit integer.
For aggregate data structures, only the Y component is considered. The result is a scalar value that only depends on the data structure of the data set:
Data Structure |
Result of rank |
|---|---|
Scalar Value |
0 |
Data Series |
1 |
Data Matrix |
2 |
Signal |
1 |
Signal Series |
2 |
Space Curve |
1 |
List |
0 |
If the argument is a list, then the function is executed for each element of the list and the result is also a list.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
Rank({1, 3, 4}) |
Results in 1L. |
Rank({1, 3, 4} # 2) |
Results in 2L. |
Rank(2) |
Results in 0L. |