Enum NaNStrategy

java.lang.Object
java.lang.Enum<NaNStrategy>
org.hipparchus.stat.ranking.NaNStrategy
All Implemented Interfaces:
Serializable, Comparable<NaNStrategy>, java.lang.constant.Constable

public enum NaNStrategy extends Enum<NaNStrategy>
Strategies for handling NaN values in rank transformations.
  • MINIMAL - NaNs are treated as minimal in the ordering, equivalent to (that is, tied with) Double.NEGATIVE_INFINITY.
  • MAXIMAL - NaNs are treated as maximal in the ordering, equivalent to Double.POSITIVE_INFINITY
  • REMOVED - NaNs are removed before the rank transform is applied
  • FIXED - NaNs are left "in place," that is the rank transformation is applied to the other elements in the input array, but the NaN elements are returned unchanged.
  • FAILED - If any NaN is encountered in the input array, an appropriate exception is thrown
  • Enum Constant Details

    • MINIMAL

      public static final NaNStrategy MINIMAL
      NaNs are considered minimal in the ordering
    • MAXIMAL

      public static final NaNStrategy MAXIMAL
      NaNs are considered maximal in the ordering
    • REMOVED

      public static final NaNStrategy REMOVED
      NaNs are removed before computing ranks
    • FIXED

      public static final NaNStrategy FIXED
      NaNs are left in place
    • FAILED

      public static final NaNStrategy FAILED
      NaNs result in an exception
  • Method Details

    • values

      public static NaNStrategy[] 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 NaNStrategy 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