Enum Class EVDJob

java.lang.Object
java.lang.Enum<EVDJob>
smile.linalg.EVDJob
All Implemented Interfaces:
Serializable, Comparable<EVDJob>, Constable
public enum EVDJob extends Enum<EVDJob>
The option controlling whether eigenvectors are computed by LAPACK eigenvalue routines (e.g., dgeev, dsyevd).
  • NO_VECTORS — only eigenvalues are computed (faster, less memory).
  • VECTORS — both eigenvalues and eigenvectors are computed.

  • Enum Constant Details

    • NO_VECTORS

      public static final EVDJob NO_VECTORS
      Eigenvalues only are computed.

    • VECTORS

      public static final EVDJob VECTORS
      Both eigenvalues and eigenvectors are computed.

  • Method Details

    • values

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

    • valueOf

      public static EVDJob valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • lapack

      public byte lapack()
      Returns the byte value for LAPACK.
      Returns:
      the byte value for LAPACK.

    • description

      public String description()
      Returns a human-readable description of this job option.
      Returns:
      a human-readable description.

    • fromLapack

      public static EVDJob fromLapack(byte value)
      Returns the EVDJob constant corresponding to the given LAPACK byte value.
      Parameters:
      value - the LAPACK byte value ('N' or 'V').
      Returns:
      the matching EVDJob constant.
      Throws:
      IllegalArgumentException - if the value does not match any constant.

    • of

      public static EVDJob of(boolean vectors)
      Returns the appropriate EVDJob for a boolean flag.
      Parameters:
      vectors - true to compute eigenvectors, false for eigenvalues only.
      Returns:
      VECTORS or NO_VECTORS.