org.ojalgo.matrix.decomposition

Interface LU<N extends Number>

All Superinterfaces:

DeterminantTask<N>, InverterTask<N>, LDU<N>, MatrixDecomposition<N>, MatrixDecomposition.Determinant<N>, MatrixDecomposition.Ordered<N>, MatrixDecomposition.Pivoting<N>, MatrixDecomposition.RankRevealing<N>, MatrixDecomposition.Solver<N>, MatrixTask<N>, SolverTask<N>, Structure1D, Structure2D

public interface LU<N extends Number>
extends LDU<N>, MatrixDecomposition.Pivoting<N>

LU: [A] = [L][U]

Decomposes [this] into [L] and [U] (with pivot order information in an int[]) where:

• [L] is a unit lower (left) triangular matrix. It has the same number of rows as [this], and ones on the diagonal.
• [U] is an upper (right) triangular matrix. It has the same number of columns as [this].
• [this] = [L][U] (with reordered rows according to the pivot order)

Note: The number of columns in [L] and the number of rows in [U] is not specified by this interface.

The LU decomposition always exists - the compute method should always succeed - even for non-square and/or singular matrices. The primary use of the LU decomposition is in the solution of systems of simultaneous linear equations. That will, however, only work for square non-singular matrices.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LU.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

MatrixDecomposition.Determinant<N extends Number>, MatrixDecomposition.EconomySize<N extends Number>, MatrixDecomposition.Hermitian<N extends Number>, MatrixDecomposition.Ordered<N extends Number>, MatrixDecomposition.Pivoting<N extends Number>, MatrixDecomposition.RankRevealing<N extends Number>, MatrixDecomposition.Solver<N extends Number>, MatrixDecomposition.Values<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure2D

Structure2D.IntRowColumn, Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,?>>, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.RowColumnCallback, Structure2D.RowColumnKey<R,C>, Structure2D.RowColumnMapper<R,C>

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Field Summary

Fields

Modifier and Type	Field and Description
static LU.Factory<ComplexNumber>	COMPLEX
static LU.Factory<Double>	PRIMITIVE
static LU.Factory<Quaternion>	QUATERNION
static LU.Factory<RationalNumber>	RATIONAL

Fields inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

TYPICAL

Method Summary

Modifier and Type	Method and Description
default boolean	computeWithoutPivoting(ElementsSupplier<N> matrix) Deprecated. v48 Use MatrixDecomposition.Pivoting.decomposeWithoutPivoting(Access2D.Collectable) instead.
static <N extends Number> boolean	equals(MatrixStore<N> matrix, LU<N> decomposition, NumberContext context)
MatrixStore<N>	getL()
MatrixStore<N>	getU() http://en.wikipedia.org/wiki/Row_echelon_form This is the same as [D][U].
static <N extends Number> LU<N>	make(Access2D<N> typical)
default MatrixStore<N>	reconstruct()
static <N extends Number> MatrixStore<N>	reconstruct(LU<N> decomposition) Deprecated. v48 Use reconstruct() instead

Methods inherited from interface org.ojalgo.matrix.decomposition.LDU

isOrdered

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition.Solver

compute, getInverse, getInverse, getSolution, getSolution, isSolvable

Methods inherited from interface org.ojalgo.matrix.task.SolverTask

preallocate, preallocate, solve, solve

Methods inherited from interface org.ojalgo.matrix.task.InverterTask

invert, invert, preallocate, preallocate

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition.Determinant

getDeterminant

Methods inherited from interface org.ojalgo.matrix.task.DeterminantTask

calculateDeterminant

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition.RankRevealing

countSignificant, getRank, getRankThreshold, isFullRank

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

decompose, isComputed, reset

Methods inherited from interface org.ojalgo.structure.Structure2D

column, column, column, column, column, count, count, countColumns, countRows, index, index, isEmpty, isFat, isScalar, isSquare, isTall, isVector, loopAll, loopColumn, loopColumn, loopDiagonal, loopMatching, loopRow, loopRow, mapperOf, row, row, row, row, row

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition.Pivoting

decomposeWithoutPivoting, getPivotOrder, isPivoted

Field Detail

COMPLEX

static final LU.Factory<ComplexNumber> COMPLEX

PRIMITIVE

static final LU.Factory<Double> PRIMITIVE

QUATERNION

static final LU.Factory<Quaternion> QUATERNION

RATIONAL

static final LU.Factory<RationalNumber> RATIONAL

Method Detail

equals

static <N extends Number> boolean equals(MatrixStore<N> matrix,
                                         LU<N> decomposition,
                                         NumberContext context)

make

static <N extends Number> LU<N> make(Access2D<N> typical)

reconstruct

@Deprecated
static <N extends Number> MatrixStore<N> reconstruct(LU<N> decomposition)

Deprecated. v48 Use reconstruct() instead

computeWithoutPivoting

@Deprecated
default boolean computeWithoutPivoting(ElementsSupplier<N> matrix)

Deprecated. v48 Use MatrixDecomposition.Pivoting.decomposeWithoutPivoting(Access2D.Collectable) instead.

getL

MatrixStore<N> getL()

getU

MatrixStore<N> getU()

http://en.wikipedia.org/wiki/Row_echelon_form

This is the same as [D][U]. Together with the pivotOrder and [L] this constitutes an alternative, more compact, way to express the decomposition.

See Also:

MatrixDecomposition.Pivoting.getPivotOrder(), getL()

reconstruct

default MatrixStore<N> reconstruct()

Specified by:

reconstruct in interface MatrixDecomposition<N extends Number>