Package org.flag4j.linalg.decompositions.lu

Enum Class LU.Pivoting

java.lang.Object

java.lang.Enum<LU.Pivoting>

org.flag4j.linalg.decompositions.lu.LU.Pivoting

All Implemented Interfaces:

Serializable, Comparable<LU.Pivoting>, Constable

Enclosing class:

LU<T extends MatrixMixin<T,?,?,?,?,?,?,?>>

public static enum LU.Pivoting
extends Enum<LU.Pivoting>

Simple enum containing pivoting options for pivoting in LU decomposition.

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
FULL
NONE
PARTIAL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Pivoting()

Method Summary

Modifier and Type	Method	Description
private static LU.Pivoting	get(int ordinal)	Converts an ordinal to the corresponding pivot flag.
static LU.Pivoting	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LU.Pivoting[]	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

NONE

public static final LU.Pivoting NONE

PARTIAL

public static final LU.Pivoting PARTIAL

FULL

public static final LU.Pivoting FULL

Constructor Details

Pivoting

private Pivoting()

Method Details

values

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

get

private static LU.Pivoting get(int ordinal)

Converts an ordinal to the corresponding pivot flag.

Parameters:

ordinal - Ordinal to convert.

Returns:

The pivot flag with the corresponding ordinal. If the no pivot exists with the specified ordinal, PARTIAL is returned.