Enum NaNStrategy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<NaNStrategy>

    public enum NaNStrategy
    extends java.lang.Enum<NaNStrategy>
    Strategies for handling NaN values in rank transformations.
    Since:
    1.1
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILED
      NaNs result in an exception.
      FIXED
      NaNs are left fixed "in place", that is the rank transformation is applied to the other elements in the input array, but the NaN elements are returned unchanged.
      MAXIMAL
      NaNs are considered maximal in the ordering, equivalent to (that is, tied with) positive infinity.
      MINIMAL
      NaNs are considered minimal in the ordering, equivalent to (that is, tied with) negative infinity.
      REMOVED
      NaNs are removed before rank transform is applied.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private NaNStrategy()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static NaNStrategy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NaNStrategy[] values()
      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 Detail

      • MINIMAL

        public static final NaNStrategy MINIMAL
        NaNs are considered minimal in the ordering, equivalent to (that is, tied with) negative infinity.
      • MAXIMAL

        public static final NaNStrategy MAXIMAL
        NaNs are considered maximal in the ordering, equivalent to (that is, tied with) positive infinity.
      • REMOVED

        public static final NaNStrategy REMOVED
        NaNs are removed before rank transform is applied.
      • FIXED

        public static final NaNStrategy FIXED
        NaNs are left fixed "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

        public static final NaNStrategy FAILED
        NaNs result in an exception.
    • Constructor Detail

      • NaNStrategy

        private NaNStrategy()
    • Method Detail

      • values

        public static NaNStrategy[] 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 (NaNStrategy c : NaNStrategy.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static NaNStrategy valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null