smile.math.blas

Enum UPLO

java.lang.Object

java.lang.Enum<UPLO>

smile.math.blas.UPLO

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UPLO>

public enum UPLO
extends java.lang.Enum<UPLO>

The format of packed matrix storage. The packed storage format compactly stores matrix elements when only one part of the matrix, the upper or lower triangle, is necessary to determine all of the elements of the matrix. This is the case when the matrix is upper triangular, lower triangular, symmetric, or Hermitian.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOWER Lower triangle is stored.
UPPER Upper triangle is stored.

Method Summary

Modifier and Type	Method and Description
int	blas() Returns the byte value for BLAS.
byte	lapack() Returns the byte value for LAPACK.
static UPLO	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UPLO[]	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

UPPER

public static final UPLO UPPER

Upper triangle is stored. The packed storage format compactly stores matrix elements when only one part of the matrix, the upper or lower triangle, is necessary to determine all of the elements of the matrix. This is the case when the matrix is upper triangular, lower triangular, symmetric, or Hermitian.

LOWER

public static final UPLO LOWER

Lower triangle is stored. The packed storage format compactly stores matrix elements when only one part of the matrix, the upper or lower triangle, is necessary to determine all of the elements of the matrix. This is the case when the matrix is upper triangular, lower triangular, symmetric, or Hermitian.

Method Detail

values

public static UPLO[] 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 (UPLO c : UPLO.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

blas

public int blas()

Returns the byte value for BLAS.

lapack

public byte lapack()

Returns the byte value for LAPACK.