Enum TiesStrategy

java.lang.Object
java.lang.Enum<TiesStrategy>
org.apache.commons.statistics.ranking.TiesStrategy
All Implemented Interfaces:
Serializable, Comparable<TiesStrategy>

public enum TiesStrategy extends Enum<TiesStrategy>
Strategies for handling tied values in rank transformations.
Since:
1.1
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Tied values are assigned the average of the applicable ranks.
    Tied values are assigned the maximum applicable rank, or the rank of the last occurrence.
    Tied values are assigned the minimum applicable rank, or the rank of the first occurrence.
    Tied values are assigned a unique random integral rank from among the applicable values.
    Ties are assigned ranks in order of occurrence in the original array.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    static TiesStrategy[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • SEQUENTIAL

      public static final TiesStrategy SEQUENTIAL
      Ties are assigned ranks in order of occurrence in the original array.

      For example, [1, 3, 4, 3] is ranked as [1, 2, 4, 3].

    • MINIMUM

      public static final TiesStrategy MINIMUM
      Tied values are assigned the minimum applicable rank, or the rank of the first occurrence.

      For example, [1, 3, 4, 3] is ranked as [1, 2, 4, 2].

    • MAXIMUM

      public static final TiesStrategy MAXIMUM
      Tied values are assigned the maximum applicable rank, or the rank of the last occurrence.

      For example, [1, 3, 4, 3] is ranked as [1, 3, 4, 3].

    • AVERAGE

      public static final TiesStrategy AVERAGE
      Tied values are assigned the average of the applicable ranks.

      For example, [1, 3, 4, 3] is ranked as [1, 2.5, 4, 2.5].

    • RANDOM

      public static final TiesStrategy RANDOM
      Tied values are assigned a unique random integral rank from among the applicable values.

      For example, [1, 3, 4, 3] is ranked as either [1, 2, 4, 3] or [1, 3, 4, 2] where the choice is random.

      The assigned rank will always be an integer, (inclusively) between the values returned by the MINIMUM and MAXIMUM strategies.

      Use of a unique rank ensures that ties are resolved so that the rank order is stable.

  • Constructor Details

    • TiesStrategy

      private TiesStrategy()
  • Method Details

    • values

      public static TiesStrategy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static TiesStrategy 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