Package smile.math.blas

Enum Class SVDJob

java.lang.Object

java.lang.Enum<SVDJob>

smile.math.blas.SVDJob

All Implemented Interfaces:

Serializable, Comparable<SVDJob>, Constable

public enum SVDJob
extends Enum<SVDJob>

The option if computing singular vectors.

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
ALL	All left (or right) singular vectors are returned in supplied matrix U (or Vt).
COMPACT	The first min(m, n) singular vectors are returned in supplied matrix U (or Vt).
NO_VECTORS	No singular vectors are computed.
OVERWRITE	The first min(m, n) singular vectors are overwritten on the matrix A.

Method Summary

Modifier and Type	Method	Description
byte	lapack()	Returns the byte value for LAPACK.
static SVDJob	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SVDJob[]	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

ALL

public static final SVDJob ALL

All left (or right) singular vectors are returned in supplied matrix U (or Vt).

COMPACT

public static final SVDJob COMPACT

The first min(m, n) singular vectors are returned in supplied matrix U (or Vt).

OVERWRITE

public static final SVDJob OVERWRITE

The first min(m, n) singular vectors are overwritten on the matrix A.

NO_VECTORS

public static final SVDJob NO_VECTORS

No singular vectors are computed.

Method Details

values

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