Module ojalgo

Package org.ojalgo.matrix.decomposition

Class RawEigenvalue.Symmetric

java.lang.Object

org.ojalgo.matrix.decomposition.AbstractDecomposition<java.lang.Double,R064Store>

org.ojalgo.matrix.decomposition.RawDecomposition

org.ojalgo.matrix.decomposition.RawEigenvalue

org.ojalgo.matrix.decomposition.RawEigenvalue.Symmetric

All Implemented Interfaces:

Eigenvalue<java.lang.Double>, Eigenvalue.Spectral<java.lang.Double>, MatrixDecomposition<java.lang.Double>, MatrixDecomposition.Determinant<java.lang.Double>, MatrixDecomposition.EconomySize<java.lang.Double>, MatrixDecomposition.Hermitian<java.lang.Double>, MatrixDecomposition.Ordered<java.lang.Double>, MatrixDecomposition.RankRevealing<java.lang.Double>, MatrixDecomposition.Solver<java.lang.Double>, MatrixDecomposition.Values<java.lang.Double>, SingularValue<java.lang.Double>, Provider2D, Provider2D.Condition, Provider2D.Determinant<java.lang.Double>, Provider2D.Eigenpairs, Provider2D.Inverse<java.util.Optional<MatrixStore<java.lang.Double>>>, Provider2D.Rank, Provider2D.Solution<java.util.Optional<MatrixStore<java.lang.Double>>>, DeterminantTask<java.lang.Double>, InverterTask<java.lang.Double>, MatrixTask<java.lang.Double>, SolverTask<java.lang.Double>, InvertibleFactor<java.lang.Double>, Structure1D, Structure2D

Enclosing class:

RawEigenvalue

static final class RawEigenvalue.Symmetric
extends RawEigenvalue
implements Eigenvalue.Spectral<java.lang.Double>

Nested Class Summary

Nested classes/interfaces inherited from class org.ojalgo.matrix.decomposition.RawEigenvalue

RawEigenvalue.Dynamic, RawEigenvalue.General, RawEigenvalue.Symmetric

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

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

Nested classes/interfaces inherited from interface org.ojalgo.matrix.transformation.InvertibleFactor

InvertibleFactor.IdentityFactor<N extends java.lang.Comparable<N>>

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

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

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

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

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

SingularValue.Factory<N extends java.lang.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

Modifier and Type	Field	Description
private MatrixStore<java.lang.Double>	myInverse
private MatrixStore<java.lang.Double>	myS
private MatrixStore<java.lang.Double>	myU

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

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

C128, H256, Q128, R064, R128

Constructor Summary

Constructors

Constructor	Description
Symmetric()

Method Summary

Modifier and Type	Method	Description
void	btran(double[] arg)
void	btran(PhysicalStore<java.lang.Double> arg)	Backwards-transformation
int	countSignificant(double threshold)
protected boolean	doDecompose(double[][] data, boolean valuesOnly)
void	ftran(double[] arg)
void	ftran(PhysicalStore<java.lang.Double> arg)	Forward-transformation
double	getCondition()	The condition number.
MatrixStore<java.lang.Double>	getCovariance()
double	getFrobeniusNorm()	Sometimes also called the Schatten 2-norm or Hilbert-Schmidt norm.
MatrixStore<java.lang.Double>	getInverse()	The output must be a "right inverse" and a "generalised inverse".
MatrixStore<java.lang.Double>	getInverse(PhysicalStore<java.lang.Double> preallocated)	Implementing this method is optional.
double	getKyFanNorm(int k)	Ky Fan k-norm.
double	getOperatorNorm()
double	getRankThreshold()
MatrixStore<java.lang.Double>	getS()
Array1D<java.lang.Double>	getSingularValues()
MatrixStore<java.lang.Double>	getSolution(Access2D.Collectable<java.lang.Double,? super PhysicalStore<java.lang.Double>> rhs, PhysicalStore<java.lang.Double> preallocated)	Implementing this method is optional.
double	getTraceNorm()
MatrixStore<java.lang.Double>	getU()	If [A] is m-by-n and its rank is r, then: The first r columns of [U] span the column space, range or image of [A]. The last m-r columns of [U] span the left nullspace or cokernel of [A]. Calculating the QR decomposition of [A] is a faster alternative.
MatrixStore<java.lang.Double>	invert(Access2D<?> original, PhysicalStore<java.lang.Double> preallocated)	Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface.
boolean	isFullSize()
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.
boolean	isSolvable()	Please note that producing a pseudoinverse and/or a least squares solution is ok! The return value, of this method, is not an indication of if the decomposed matrix is square, has full rank, is postive definite or whatever.
boolean	isSPD()	A symmetric (Hermitian) matrix is positive definite if all its eigenvalues are positive.
protected MatrixStore<java.lang.Double>	makeD(double[] d, double[] e)
PhysicalStore<java.lang.Double>	preallocate(int nbEquations, int nbVariables, int nbSolutions)
MatrixStore<java.lang.Double>	reconstruct()
void	reset()	Delete computed results, and resets attributes to default values
MatrixStore<java.lang.Double>	solve(Access2D<?> body, Access2D<?> rhs, PhysicalStore<java.lang.Double> preallocated)	Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface.

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

calculateDeterminant, checkSolvability, computeValuesOnly, decompose, doGeneral, doSymmetric, getD, getDeterminant, getEigenvalues, getEigenvalues, getImaginaryParts, getRealParts, getTrace, getV, isValuesOnly

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

checkSymmetry, getColDim, getInternalData, getInternalStore, getRowDim, make, newRawStore, reset, wrap

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

aggregator, applyPivotOrder, applyReverseOrder, collect, computed, copyColumn, copyRow, function, getDimensionalEpsilon, isAspectRatioNormal, isComputed, 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.task.DeterminantTask

calculateDeterminant

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

getD, getEigenpair, getEigenpairs, getEigenvalues, getEigenvalues, getEigenvectors, getTrace, getV

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

invert, preallocate

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

decompose, isComputed

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

getDeterminant, toDeterminantProvider

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

checkAndDecompose

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

getRank, isFullRank

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

compute, getSolution, invert, preallocate, solve, toInverseProvider, toSolutionProvider

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

computeValuesOnly

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

getD, getSingularValues, getV, reconstruct

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

preallocate, solve

Methods inherited from interface org.ojalgo.structure.Structure2D

count, countColumns, countRows, firstInColumn, firstInRow, getColDim, getMaxDim, getMinDim, getRowDim, isEmpty, isFat, isScalar, isSquare, isTall, isVector, limitOfColumn, limitOfRow, size

Field Detail

myInverse

private transient MatrixStore<java.lang.Double> myInverse

myS

private transient MatrixStore<java.lang.Double> myS

myU

private transient MatrixStore<java.lang.Double> myU

Constructor Detail

Symmetric

Symmetric()

Method Detail

btran

public void btran(double[] arg)

Specified by:

btran in interface InvertibleFactor<java.lang.Double>

See Also:

InvertibleFactor.IdentityFactor.btran(PhysicalStore)

btran

public void btran(PhysicalStore<java.lang.Double> arg)

Description copied from interface: InvertibleFactor

Backwards-transformation

Solve [x]^T[A] = [b]^T (equivalent to [A]^T[x] = [b]) by transforming [b] into [x] in-place.

Specified by:

btran in interface InvertibleFactor<java.lang.Double>

Parameters:

arg - [b] transformed into [x]

countSignificant

public int countSignificant(double threshold)

Specified by:

countSignificant in interface MatrixDecomposition.RankRevealing<java.lang.Double>

Parameters:

threshold - Significance limit

Returns:

The number of elements in the diagonal matrix that are greater than the threshold

ftran

public void ftran(double[] arg)

Specified by:

ftran in interface InvertibleFactor<java.lang.Double>

See Also:

InvertibleFactor.IdentityFactor.ftran(PhysicalStore)

ftran

public void ftran(PhysicalStore<java.lang.Double> arg)

Description copied from interface: InvertibleFactor

Forward-transformation

Solve [A][x] = [b] by transforming [b] into [x] in-place.

Specified by:

ftran in interface InvertibleFactor<java.lang.Double>

Specified by:

ftran in interface SingularValue<java.lang.Double>

Parameters:

arg - [b] transformed into [x]

getCondition

public double getCondition()

Description copied from interface: SingularValue

The condition number.

Specified by:

getCondition in interface Provider2D.Condition

Specified by:

getCondition in interface SingularValue<java.lang.Double>

Returns:

The largest singular value divided by the smallest singular value.

getCovariance

public MatrixStore<java.lang.Double> getCovariance()

Specified by:

getCovariance in interface SingularValue<java.lang.Double>

Returns:

[[A]^T[A]]^-1 Where [A] is the original matrix.

getFrobeniusNorm

public double getFrobeniusNorm()

Description copied from interface: SingularValue

Sometimes also called the Schatten 2-norm or Hilbert-Schmidt norm.

Specified by:

getFrobeniusNorm in interface SingularValue<java.lang.Double>

Returns:

The square root of the sum of squares of the singular values.

getInverse

public MatrixStore<java.lang.Double> getInverse()

Description copied from interface: MatrixDecomposition.Solver

The output must be a "right inverse" and a "generalised inverse".

Specified by:

getInverse in interface MatrixDecomposition.Solver<java.lang.Double>

getInverse

public MatrixStore<java.lang.Double> getInverse(PhysicalStore<java.lang.Double> preallocated)

Description copied from interface: MatrixDecomposition.Solver

Implementing this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling MatrixDecomposition.Solver.getInverse().

Specified by:

getInverse in interface MatrixDecomposition.Solver<java.lang.Double>

Parameters:

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution. Use MatrixDecomposition.Solver.preallocate(int, int) or InverterTask.preallocate(Structure2D) to get a suitable instance.

Returns:

The inverse, this is where you get the solution

getKyFanNorm

public double getKyFanNorm(int k)

Description copied from interface: SingularValue

Ky Fan k-norm.

The first Ky Fan k-norm is the operator norm (the largest singular value), and the last is called the trace norm (the sum of all singular values).

Specified by:

getKyFanNorm in interface SingularValue<java.lang.Double>

Parameters:

k - The number of singular values to add up.

Returns:

The sum of the k largest singular values.

getOperatorNorm

public double getOperatorNorm()

Specified by:

getOperatorNorm in interface SingularValue<java.lang.Double>

Returns:

2-norm

getRankThreshold

public double getRankThreshold()

Specified by:

getRankThreshold in interface MatrixDecomposition.RankRevealing<java.lang.Double>

getS

public MatrixStore<java.lang.Double> getS()

Specified by:

getS in interface SingularValue<java.lang.Double>

Returns:

The diagonal matrix of singular values.

getSingularValues

public Array1D<java.lang.Double> getSingularValues()

Specified by:

getSingularValues in interface SingularValue<java.lang.Double>

Returns:

The singular values ordered in descending order.

getSolution

public MatrixStore<java.lang.Double> getSolution(Access2D.Collectable<java.lang.Double,? super PhysicalStore<java.lang.Double>> rhs,
                                                 PhysicalStore<java.lang.Double> preallocated)

Description copied from interface: MatrixDecomposition.Solver

Implementing this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling MatrixDecomposition.Solver.getSolution(Collectable).

Specified by:

getSolution in interface MatrixDecomposition.Solver<java.lang.Double>

Parameters:

rhs - The Right Hand Side, wont be modfied

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution. Use SolverTask.preallocate(int, int, int) or SolverTask.preallocate(Structure2D, Structure2D) to get a suitable instance.

Returns:

The solution

getTraceNorm

public double getTraceNorm()

Specified by:

getTraceNorm in interface SingularValue<java.lang.Double>

getU

public MatrixStore<java.lang.Double> getU()

Description copied from interface: SingularValue

If [A] is m-by-n and its rank is r, then:

• The first r columns of [U] span the column space, range or image of [A].
• The last m-r columns of [U] span the left nullspace or cokernel of [A].

Calculating the QR decomposition of [A] is a faster alternative.

Specified by:

getU in interface SingularValue<java.lang.Double>

invert

public MatrixStore<java.lang.Double> invert(Access2D<?> original,
                                            PhysicalStore<java.lang.Double> preallocated)
                                     throws RecoverableCondition

Description copied from interface: InverterTask

Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling InverterTask.invert(Access2D).

Use InverterTask.preallocate(Structure2D) to obtain a suitbale preallocated.

Specified by:

invert in interface InverterTask<java.lang.Double>

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The inverse

Throws:

RecoverableCondition - TODO

isFullSize

public boolean isFullSize()

Specified by:

isFullSize in interface MatrixDecomposition.EconomySize<java.lang.Double>

Returns:

True if it will generate a full sized decomposition.

isHermitian

public boolean isHermitian()

Description copied from interface: Eigenvalue

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

Specified by:

isHermitian in interface Eigenvalue<java.lang.Double>

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.

Specified by:

isOrdered in interface Eigenvalue<java.lang.Double>

Specified by:

isOrdered in interface MatrixDecomposition.Ordered<java.lang.Double>

Returns:

true if they are ordered

isSolvable

public boolean isSolvable()

Description copied from interface: MatrixDecomposition.Solver

Please note that producing a pseudoinverse and/or a least squares solution is ok! The return value, of this method, is not an indication of if the decomposed matrix is square, has full rank, is postive definite or whatever. It's that in combination with the specific decomposition algorithm's capabilities.

Specified by:

isSolvable in interface MatrixDecomposition.Solver<java.lang.Double>

Overrides:

isSolvable in class AbstractDecomposition<java.lang.Double,R064Store>

Returns:

true if this matrix decomposition is in a state to be able to deliver an inverse or an equation system solution (with some degree of numerical stability).

isSPD

public boolean isSPD()

Description copied from interface: Eigenvalue.Spectral

A symmetric (Hermitian) matrix is positive definite if all its eigenvalues are positive.

Specified by:

isSPD in interface Eigenvalue.Spectral<java.lang.Double>

preallocate

public PhysicalStore<java.lang.Double> preallocate(int nbEquations,
                                                   int nbVariables,
                                                   int nbSolutions)

Specified by:

preallocate in interface SolverTask<java.lang.Double>

reconstruct

public MatrixStore<java.lang.Double> reconstruct()

Specified by:

reconstruct in interface Eigenvalue<java.lang.Double>

Specified by:

reconstruct in interface Eigenvalue.Spectral<java.lang.Double>

Specified by:

reconstruct in interface MatrixDecomposition<java.lang.Double>

Specified by:

reconstruct in interface SingularValue<java.lang.Double>

reset

public void reset()

Description copied from interface: MatrixDecomposition

Delete computed results, and resets attributes to default values

Specified by:

reset in interface MatrixDecomposition<java.lang.Double>

Overrides:

reset in class RawEigenvalue

solve

public MatrixStore<java.lang.Double> solve(Access2D<?> body,
                                           Access2D<?> rhs,
                                           PhysicalStore<java.lang.Double> preallocated)
                                    throws RecoverableCondition

Description copied from interface: SolverTask

Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling SolverTask.solve(Access2D, Access2D).

Use SolverTask.preallocate(Structure2D, Structure2D) to obtain a suitbale preallocated.

Specified by:

solve in interface SolverTask<java.lang.Double>

rhs - The Right Hand Side, wont be modfied

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/ /correct solution.

Returns:

The solution

Throws:

RecoverableCondition

doDecompose

protected boolean doDecompose(double[][] data,
                              boolean valuesOnly)

Specified by:

doDecompose in class RawEigenvalue

makeD

protected MatrixStore<java.lang.Double> makeD(double[] d,
                                              double[] e)

Overrides:

makeD in class RawEigenvalue