Package org.apache.commons.numbers.arrays

Enum SortInPlace

  • All Implemented Interfaces:
    Serializable, Comparable<SortInPlace>
    public enum SortInPlace
extends Enum<SortInPlace>
    Sort an array and perform the same reordering of entries on other arrays. For example, if
    • x = [3, 1, 2]
    • y = [1, 2, 3]
    • z = [0, 5, 7]
    then Sort.ASCENDING.apply(x, y, z) will update those arrays:
    • x = [1, 2, 3]
    • y = [2, 3, 1]
    • z = [5, 7, 0]

    • Method Detail

      • values

        public static SortInPlace[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SortInPlace c : SortInPlace.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SortInPlace valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • apply

        public void apply​(double[] x,
                  double[]... yList)
        Sorts in place.
        Parameters:
        x - Array to be sorted and used as a pattern for permutation of the other arrays.
        yList - Set of arrays whose permutations of entries will follow those performed on x.
        Throws:
        IllegalArgumentException - if not all arrays have the same size.