Package de.labathome.trustconstr.enums

Enum Class ProjectionMethod

java.lang.Object

java.lang.Enum<ProjectionMethod>

de.labathome.trustconstr.enums.ProjectionMethod

All Implemented Interfaces:

Serializable, Comparable<ProjectionMethod>, Constable

public enum ProjectionMethod
extends Enum<ProjectionMethod>

How Projections.projections(de.labathome.trustconstr.matrix.Matrix) should factor the constraint Jacobian to build the null-space / least-squares / row-space projectors.

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
AUGMENTED_SYSTEM	The operators will be computed using the so-called augmented system approach explained in [1]_.
NORMAL_EQUATION	The operators will be computed using the so-called normal equation approach explained in [1]_.
QR_FACTORIZATION	Compute projections using QR factorization.
SVD_FACTORIZATION	Compute projections using SVD factorization.

Method Summary

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

NORMAL_EQUATION

public static final ProjectionMethod NORMAL_EQUATION

The operators will be computed using the so-called normal equation approach explained in [1]_. In order to do so the Cholesky factorization of (A A.T) is computed. Exclusive for sparse matrices.

AUGMENTED_SYSTEM

public static final ProjectionMethod AUGMENTED_SYSTEM

The operators will be computed using the so-called augmented system approach explained in [1]_. Exclusive for sparse matrices.

QR_FACTORIZATION

public static final ProjectionMethod QR_FACTORIZATION

Compute projections using QR factorization. Exclusive for dense matrices.

SVD_FACTORIZATION

public static final ProjectionMethod SVD_FACTORIZATION

Compute projections using SVD factorization. Exclusive for dense matrices.

Method Details

values

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