Package smile.math.blas

Enum Class UPLO

java.lang.Object

java.lang.Enum<UPLO>

smile.math.blas.UPLO

All Implemented Interfaces:

Serializable, Comparable<UPLO>, Constable

public enum UPLO
extends 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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
int	blas()	Returns the int value for BLAS.
byte	lapack()	Returns the byte value for LAPACK.
static UPLO	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UPLO[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static UPLO[] 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 UPLO 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 int value for BLAS.

Returns:

the int value for BLAS.

lapack

public byte lapack()

Returns the byte value for LAPACK.

Returns:

the byte value for LAPACK.