Module ojalgo

Package org.ojalgo.matrix.decomposition

Class GeneralEvD<N extends Comparable<N>>

java.lang.Object

org.ojalgo.matrix.decomposition.AbstractDecomposition<N,DecompositionStore<N>>

org.ojalgo.matrix.decomposition.DenseEigenvalue<N>

org.ojalgo.matrix.decomposition.GeneralEvD<N>

All Implemented Interfaces:

Eigenvalue<N>, MatrixDecomposition<N>, MatrixDecomposition.Determinant<N>, MatrixDecomposition.Hermitian<N>, MatrixDecomposition.Ordered<N>, MatrixDecomposition.Values<N>, Provider2D, Provider2D.Determinant<N>, Provider2D.Eigenpairs, DeterminantTask<N>, MatrixTask<N>, Structure1D, Structure2D

Direct Known Subclasses:

GeneralEvD.R064

abstract class GeneralEvD<N extends Comparable<N>>
extends DenseEigenvalue<N>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	GeneralEvD.R064	Eigenvalues and eigenvectors of a real matrix.

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

Eigenvalue.Eigenpair, Eigenvalue.Factory<N extends Comparable<N>>, Eigenvalue.Generalisation, Eigenvalue.Generalised<N extends Comparable<N>>, Eigenvalue.Spectral<N extends Comparable<N>>

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

MatrixDecomposition.Determinant<N extends Comparable<N>>, MatrixDecomposition.EconomySize<N extends Comparable<N>>, MatrixDecomposition.Factory<D extends MatrixDecomposition<?>>, MatrixDecomposition.Hermitian<N extends Comparable<N>>, MatrixDecomposition.Ordered<N extends Comparable<N>>, MatrixDecomposition.Pivoting<N extends Comparable<N>>, MatrixDecomposition.RankRevealing<N extends Comparable<N>>, MatrixDecomposition.Solver<N extends Comparable<N>>, MatrixDecomposition.Updatable<N extends Comparable<N>>, MatrixDecomposition.Values<N extends Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.Provider2D

Provider2D.Condition, Provider2D.Determinant<N extends Comparable<N>>, Provider2D.Eigenpairs, Provider2D.Hermitian, Provider2D.Inverse<M>, Provider2D.Rank, Provider2D.Solution<M>, Provider2D.Symmetric, Provider2D.Trace<N extends Comparable<N>>

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

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

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

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

Field Summary

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

C128, DESCENDING_NORM, H256, Q128, R064, R128

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

TYPICAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeneralEvD(PhysicalStore.Factory<N,? extends DecompositionStore<N>> factory)

Method Summary

Modifier and Type	Method	Description
boolean	checkAndDecompose(MatrixStore<N> matrix)	Absolutely must check if the matrix is hermitian or not.
protected boolean	checkSolvability()
protected boolean	doDecompose(Access2D.Collectable<N,? super TransformableRegion<N>> matrix, boolean valuesOnly)
final N	getDeterminant()	A matrix' determinant is the product of its eigenvalues.
MatrixStore<N>	getInverse()
MatrixStore<N>	getInverse(DecompositionStore<N> newPreallocated)
final ComplexNumber	getTrace()	A matrix' trace is the sum of the diagonal elements.
final boolean	isHermitian()	If [A] is hermitian then [V][D][V]-1 becomes [Q][D][Q]H...
boolean	isOrdered()	The eigenvalues in D (and the eigenvectors in V) are not necessarily ordered.
protected final MatrixStore<N>	makeD()
protected Array1D<ComplexNumber>	makeEigenvalues()
protected final MatrixStore<N>	makeInverse()
protected MatrixStore<N>	makeV()

Methods inherited from class org.ojalgo.matrix.decomposition.DenseEigenvalue

calculateDeterminant, computeValuesOnly, decompose, getColDim, getD, getEigenvalues, getMaxDim, getMinDim, getRowDim, getV, isValuesOnly, reset, setD, setEigenvalues, setV

Methods inherited from class org.ojalgo.matrix.decomposition.AbstractDecomposition

aggregator, applyPivotOrder, applyReverseOrder, collect, computed, copyColumn, copyRow, function, getDimensionalEpsilon, isAspectRatioNormal, isComputed, isSolvable, makeArray, makeDiagonal, makeEye, makeHouseholder, makeIdentity, makeRotation, makeRotation, makeZero, makeZero, scalar, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getEigenpair, getEigenpairs, getEigenvalues, getEigenvectors, reconstruct

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

isComputed

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

toDeterminantProvider

Methods inherited from interface org.ojalgo.structure.Structure2D

count, countColumns, countRows, firstInColumn, firstInRow, isEmpty, isFat, isScalar, isSquare, isTall, isVector, limitOfColumn, limitOfRow, size

Constructor Details

GeneralEvD

protected GeneralEvD(PhysicalStore.Factory<N,? extends DecompositionStore<N>> factory)

Method Details

checkAndDecompose

public boolean checkAndDecompose(MatrixStore<N> matrix)

Description copied from interface: MatrixDecomposition.Hermitian

Absolutely must check if the matrix is hermitian or not. Then, depending on the result different paths can be chosen - compute or not / choose different algorithms...

Parameters:

matrix - A matrix to check and then (maybe) decompose

Returns:

true if the hermitian check passed and decomposition succeeded; false if not

getDeterminant

public final N getDeterminant()

Description copied from interface: MatrixDecomposition.Determinant

A matrix' determinant is the product of its eigenvalues.

Returns:

The matrix' determinant

getInverse

public MatrixStore<N> getInverse()

getInverse

public MatrixStore<N> getInverse(DecompositionStore<N> newPreallocated)

getTrace

public final ComplexNumber getTrace()

Description copied from interface: Eigenvalue

A matrix' trace is the sum of the diagonal elements. It is also the sum of the eigenvalues. This method should return the sum of the eigenvalues.

Returns:

The matrix' trace

isHermitian

public final boolean isHermitian()

Description copied from interface: Eigenvalue

If [A] is hermitian then [V][D][V]^-1 becomes [Q][D][Q]^H...

isOrdered

public boolean isOrdered()

Description copied from interface: Eigenvalue

The eigenvalues in D (and the eigenvectors in V) are not necessarily ordered. This is a property of the algorithm/implementation, not the data.

Returns:

true if they are ordered

checkSolvability

protected boolean checkSolvability()

Overrides:

checkSolvability in class AbstractDecomposition<N extends Comparable<N>,DecompositionStore<N extends Comparable<N>>>

doDecompose

protected boolean doDecompose(Access2D.Collectable<N,? super TransformableRegion<N>> matrix,
 boolean valuesOnly)

Specified by:

doDecompose in class DenseEigenvalue<N extends Comparable<N>>

makeD

protected final MatrixStore<N> makeD()

Specified by:

makeD in class DenseEigenvalue<N extends Comparable<N>>

makeEigenvalues

protected Array1D<ComplexNumber> makeEigenvalues()

Specified by:

makeEigenvalues in class DenseEigenvalue<N extends Comparable<N>>

makeInverse

protected final MatrixStore<N> makeInverse()

makeV

protected MatrixStore<N> makeV()

Specified by:

makeV in class DenseEigenvalue<N extends Comparable<N>>