IndexNot (FPScript)
Forms the complement of an index data set.
Syntax
IndexNot(Index, Shape)
The syntax of the IndexNot function consists of the following parts:
Part |
Description |
|---|---|
Index |
A data series with ascending indices or a data matrix with ascending 2D indices. Permitted data structures are data series und data matrix. All real data types are permitted. |
Shape |
A data series with the dimension lengths of the data set on which the index is based. If Index is a data series, an alternative is also to specify a scalar value with the data set length related to which the complement is to be formed. Permitted data structures are scalar value und data series. All real data types are permitted. |
Remarks
As the result the function returns a data series of data type 64-bit integer.
Before forming the complement, the data are converted into 64-bit integers, if applicable. Index must contain values greater than or equal to zero and sorted in ascending order. A 2D index is sorted in ascending order when the indices are counted off row by row; for example: { {0, 0}, {0, 1}, {0, 2}, {1, 0}, {1, 1}, {1, 2} }. The result is a data series or data matrix that contains all indices not present in Index. The Shape argument determines the data set size with respect to which the complement is formed.
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
IndexNot({1, 3, 4}, 7) |
Results in {0L, 2L, 5L, 6L}. |
IndexNot({ {0, 0}, {1, 1} }, {2, 2}) |
Results in { {0L, 1L}, {1L, 0L} }. |
IndexNot(Index2D, Shape(Matrix)) |
Forms the complement of a 2D index data set respective to a data matrix. |