Enum Class EigenRange

java.lang.Object
java.lang.Enum<EigenRange>
smile.linalg.EigenRange
All Implemented Interfaces:
Serializable, Comparable<EigenRange>, Constable
public enum EigenRange extends Enum<EigenRange>
The option of eigenvalue range for LAPACK symmetric eigensolver routines (e.g., dsyevr, ssyevr).
  • ALL — compute all eigenvalues.
  • VALUE — compute eigenvalues in the half-open interval (VL, VU].
  • INDEX — compute the IL-th through IU-th eigenvalues.

  • Enum Constant Details

    • ALL

      public static final EigenRange ALL
      All eigenvalues will be found.

    • VALUE

      public static final EigenRange VALUE
      All eigenvalues in the half-open interval (VL, VU] will be found.

    • INDEX

      public static final EigenRange INDEX
      The IL-th through IU-th eigenvalues will be found.

  • Method Details

    • values

      public static EigenRange[] 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 EigenRange 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 range type.
      Returns:
      a human-readable description.

    • fromLapack

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