functionsortComplex

Sort elements of complex vector

Information

Syntax

             sorted_v = Vectors.sort(v);
  (sorted_v, indices) = Vectors.sort(v, ascending=true);
  

Description

Function sort(..) sorts a Real vector v in ascending order and returns the result in sorted_v. If the optional argument "ascending" is false, the vector is sorted in descending order. In the optional second output argument the indices of the sorted vector with respect to the original vector are given, such that sorted_v = v[indices].

Example

    (v2, i2) := Vectors.sort({-1, 8, 3, 6, 2});
         -> v2 = {-1, 2, 3, 6, 8}
            i2 = {1, 5, 3, 4, 2}
  

Inputs

TypeNameDefaultDescription
Complex[:]vVector to be sorted
Booleanascendingtrue= true if ascending order, otherwise descending order
BooleansortFrequencytrueTrue, if sorting is first for imaginary then for real value, otherwise sorting is for absolute value

Outputs

TypeNameDefaultDescription
Complex[size(v, 1)]sorted_vvSorted vector
Integer[size(v, 1)]indices1:size(v, 1)sorted_v = v[indices]