Enum SVDFlagsEnum

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

    public enum SVDFlagsEnum
    extends java.lang.Enum<SVDFlagsEnum>
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FULL_UV
      when the matrix is not square, by default the algorithm produces u and vt matrices of sufficiently large size for the further A reconstruction; if, however, FULL_UV flag is specified, u and vt will be full-size square orthogonal matrices.
      MODIFY_A
      allow the algorithm to modify the decomposed matrix; it can save space and speed up processing.
      NO_UV
      indicates that only a vector of singular values `w` is to be processed, while u and vt will be set to empty matrices
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int value  
    • Method Summary

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

      • MODIFY_A

        public static final SVDFlagsEnum MODIFY_A
        allow the algorithm to modify the decomposed matrix; it can save space and speed up processing. currently ignored.
      • NO_UV

        public static final SVDFlagsEnum NO_UV
        indicates that only a vector of singular values `w` is to be processed, while u and vt will be set to empty matrices
      • FULL_UV

        public static final SVDFlagsEnum FULL_UV
        when the matrix is not square, by default the algorithm produces u and vt matrices of sufficiently large size for the further A reconstruction; if, however, FULL_UV flag is specified, u and vt will be full-size square orthogonal matrices.
    • Field Detail

      • value

        public final int value
    • Method Detail

      • values

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

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