Enum Class Side

java.lang.Object
java.lang.Enum<Side>
smile.linalg.Side
All Implemented Interfaces:
Serializable, Comparable<Side>, Constable
public enum Side extends Enum<Side>
The side on which a symmetric matrix appears in a matrix-matrix operation.

Used by BLAS routines such as dsymm / ssymm:

  • LEFT — the symmetric matrix multiplies on the left: C := alpha*A*B + beta*C
  • RIGHT — the symmetric matrix multiplies on the right: C := alpha*B*A + beta*C

  • Enum Constant Details

    • LEFT

      public static final Side LEFT
      Symmetric matrix A appears on the left: C = A * B.

  • Method Details

    • values

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

    • blas

      public int blas()
      Returns the integer value for CBLAS.
      Returns:
      the CBLAS integer value.

    • lapack

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

    • description

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

    • fromBlas

      public static Side fromBlas(int value)
      Returns the Side constant corresponding to the given CBLAS integer value.
      Parameters:
      value - the CBLAS integer value (141 or 142).
      Returns:
      the matching Side constant.
      Throws:
      IllegalArgumentException - if the value does not match any constant.

    • fromLapack

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