smile.math.blas

Enum SVDJob

java.lang.Object

java.lang.Enum<SVDJob>

smile.math.blas.SVDJob

All Implemented Interfaces:

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

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

The option if computing singular vectors.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
byte	lapack() Returns the byte value for LAPACK.
static SVDJob	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SVDJob[]	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

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 Detail

values

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

Returns:

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

valueOf

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

lapack

public byte lapack()

Returns the byte value for LAPACK.