org.ojalgo.matrix.decomposition

Class SingularValueDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

java.lang.Object

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

All Implemented Interfaces:

MatrixDecomposition<N>, SingularValue<N>, InverterTask<N>, MatrixTask<N>, SolverTask<N>

Deprecated.

v38 This class will be made package private. Use the inteface instead.

@Deprecated
public abstract class SingularValueDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>
extends java.lang.Object
implements SingularValue<N>

Author:

apete

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.InverterTask

InverterTask.Factory<N extends java.lang.Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.SolverTask

SolverTask.Factory<N extends java.lang.Number>

Field Summary

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

BIG, COMPLEX, PRIMITIVE

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

BIG, COMPLEX, PRIMITIVE

Method Summary

Modifier and Type	Method and Description
boolean	compute(Access2D<?> matrix) Deprecated.
boolean	compute(Access2D<?> matrix, boolean singularValuesOnly, boolean fullSize) Deprecated.
boolean	equals(java.lang.Object someObj)
double	getCondition() Deprecated. The condition number.
MatrixStore<N>	getD() Deprecated.
double	getFrobeniusNorm() Deprecated. Sometimes also called the Schatten 2-norm or Hilbert-Schmidt norm.
MatrixStore<N>	getInverse() Deprecated. The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	getInverse(DecompositionStore<N> preallocated) Deprecated. Implementiong this method is optional.
double	getKyFanNorm(int k) Deprecated. Ky Fan k-norm.
double	getOperatorNorm() Deprecated.
MatrixStore<N>	getQ1() Deprecated. If [A] is m-by-n and its rank is r, then: The first r columns of [Q1] span the column space, range or image of [A]. The last m-r columns of [Q1] span the left nullspace or cokernel of [A]. Calculating the QR decomposition of [A] is a faster alternative.
MatrixStore<N>	getQ2() Deprecated. If [A] is m-by-n and its rank is r, then: The first r columns of [Q2] span the row space or coimage of [A]. The last n-r columns of [Q2] span the nullspace or kernel of [A]. Calculating the QR decomposition of [A]T is a faster alternative.
int	getRank() Deprecated. Effective numerical matrix rank.
Array1D<java.lang.Double>	getSingularValues() Deprecated.
double	getTraceNorm() Deprecated.
MatrixStore<N>	invert(MatrixStore<N> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	invert(MatrixStore<N> original, DecompositionStore<N> preallocated) Implementiong this method is optional.
boolean	isComputed()
boolean	isFullSize() Deprecated.
static <N extends java.lang.Number> SingularValue<N>	make(Access2D<N> aTypical) Deprecated. v38 Use SingularValue.make(Access2D) instead
static SingularValue<java.lang.Double>	makeAlternative() Deprecated. v38 Use SingularValue.make(Access2D) instead
static SingularValue<java.math.BigDecimal>	makeBig() Deprecated. v38 Use SingularValue.makeBig() instead
static SingularValue<ComplexNumber>	makeComplex() Deprecated. v38 Use SingularValue.makeComplex() instead
static SingularValue<java.lang.Double>	makeJama() Deprecated. v38 Use SingularValue.makePrimitive() instead
static SingularValue<java.lang.Double>	makePrimitive() Deprecated. v38 Use SingularValue.makePrimitive() instead
DecompositionStore<N>	preallocate(Access2D<N> template) Implementiong this method is optional.
DecompositionStore<N>	preallocate(Access2D<N> templateBody, Access2D<N> templateRHS) Implementiong this method is optional.
void	reset() Deprecated. Delete computed results, and resets attributes to default values
MatrixStore<N>	solve(Access2D<N> rhs) Deprecated. [A][X]=[B] or [this][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs) [A][X]=[B] or [body][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs, DecompositionStore<N> preallocated) Implementiong this method is optional.
MatrixStore<N>	solve(Access2D<N> rhs, DecompositionStore<N> preallocated) Deprecated. Implementiong this method is optional.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isOrdered, reconstruct

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

equals, equals, isComputed, isSolvable

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

invert, invert, preallocate

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

preallocate, solve, solve

Method Detail

make

@Deprecated
public static final <N extends java.lang.Number> SingularValue<N> make(Access2D<N> aTypical)

Deprecated. v38 Use SingularValue.make(Access2D) instead

Specified by:

make in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

makeAlternative

@Deprecated
public static final SingularValue<java.lang.Double> makeAlternative()

Deprecated. v38 Use SingularValue.make(Access2D) instead

makeBig

@Deprecated
public static final SingularValue<java.math.BigDecimal> makeBig()

Deprecated. v38 Use SingularValue.makeBig() instead

Specified by:

makeBig in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

makeComplex

@Deprecated
public static final SingularValue<ComplexNumber> makeComplex()

Deprecated. v38 Use SingularValue.makeComplex() instead

Specified by:

makeComplex in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

makeJama

@Deprecated
public static final SingularValue<java.lang.Double> makeJama()

Deprecated. v38 Use SingularValue.makePrimitive() instead

makePrimitive

@Deprecated
public static final SingularValue<java.lang.Double> makePrimitive()

Deprecated. v38 Use SingularValue.makePrimitive() instead

Specified by:

makePrimitive in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

compute

public final boolean compute(Access2D<?> matrix)

Deprecated.

Specified by:

compute in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

compute

public boolean compute(Access2D<?> matrix,
                       boolean singularValuesOnly,
                       boolean fullSize)

Deprecated.

Specified by:

compute in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Parameters:

matrix - A matrix to decompose

singularValuesOnly - No need to calculate eigenvectors

fullSize - TODO

Returns:

true/false if the computation succeeded or not

getCondition

public final double getCondition()

Deprecated.

Description copied from interface: SingularValue

The condition number.

Specified by:

getCondition in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

The largest singular value divided by the smallest singular value.

getD

public final MatrixStore<N> getD()

Deprecated.

Specified by:

getD in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

The diagonal matrix of singular values.

getFrobeniusNorm

public final double getFrobeniusNorm()

Deprecated.

Description copied from interface: SingularValue

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

Specified by:

getFrobeniusNorm in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

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

getInverse

public final MatrixStore<N> getInverse()

Deprecated.

Description copied from interface: MatrixDecomposition

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

Specified by:

getInverse in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

See Also:

BasicMatrix.invert()

getInverse

public final MatrixStore<N> getInverse(DecompositionStore<N> preallocated)

Deprecated.

Description copied from interface: MatrixDecomposition

Implementiong 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.getInverse().

Specified by:

getInverse in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

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.

Returns:

The inverse, this is where you get the solution

getKyFanNorm

public final double getKyFanNorm(int k)

Deprecated.

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<N extends java.lang.Number & java.lang.Comparable<N>>

Parameters:

k - The number of singular values to add up.

Returns:

The sum of the k largest singular values.

getOperatorNorm

public final double getOperatorNorm()

Deprecated.

Specified by:

getOperatorNorm in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

2-norm

getQ1

public final MatrixStore<N> getQ1()

Deprecated.

Description copied from interface: SingularValue

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

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

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

Specified by:

getQ1 in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

getQ2

public final MatrixStore<N> getQ2()

Deprecated.

Description copied from interface: SingularValue

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

• The first r columns of [Q2] span the row space or coimage of [A].
• The last n-r columns of [Q2] span the nullspace or kernel of [A].

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

Specified by:

getQ2 in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

getRank

public final int getRank()

Deprecated.

Description copied from interface: SingularValue

Effective numerical matrix rank.

Specified by:

getRank in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

The number of nonnegligible singular values.

getSingularValues

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

Deprecated.

Specified by:

getSingularValues in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

The singular values ordered in descending order.

getTraceNorm

public final double getTraceNorm()

Deprecated.

Specified by:

getTraceNorm in interface SingularValue<N extends java.lang.Number & java.lang.Comparable<N>>

isFullSize

public final boolean isFullSize()

Deprecated.

Specified by:

isFullSize in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

Returns:

True if the implementation generates a full sized decomposition.

reset

public void reset()

Deprecated.

Description copied from interface: MatrixDecomposition

Delete computed results, and resets attributes to default values

Specified by:

reset in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

solve

public MatrixStore<N> solve(Access2D<N> rhs)

Deprecated.

Description copied from interface: MatrixDecomposition

[A][X]=[B] or [this][return]=[rhs]

Specified by:

solve in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

solve

public MatrixStore<N> solve(Access2D<N> rhs,
                            DecompositionStore<N> preallocated)

Deprecated.

Description copied from interface: MatrixDecomposition

Implementiong 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.solve(Access2D).

Specified by:

solve in interface MatrixDecomposition<N extends java.lang.Number & java.lang.Comparable<N>>

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.

Returns:

The solution

equals

public boolean equals(java.lang.Object someObj)

Overrides:

equals in class java.lang.Object

invert

public final MatrixStore<N> invert(MatrixStore<N> original)

Description copied from interface: InverterTask

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

See Also:

BasicMatrix.invert()

invert

public final MatrixStore<N> invert(MatrixStore<N> original,
                                   DecompositionStore<N> preallocated)

Description copied from interface: InverterTask

Implementiong 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 InverterTask.invert(MatrixStore).

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

solve

public final MatrixStore<N> solve(Access2D<N> body,
                                  Access2D<N> rhs)

Description copied from interface: SolverTask

[A][X]=[B] or [body][return]=[rhs]

solve

public final MatrixStore<N> solve(Access2D<N> body,
                                  Access2D<N> rhs,
                                  DecompositionStore<N> preallocated)

Description copied from interface: SolverTask

Implementiong 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 SolverTask.solve(Access2D, Access2D).

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.

Returns:

The solution

preallocate

public final DecompositionStore<N> preallocate(Access2D<N> template)

Description copied from interface: InverterTask

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with InverterTask.invert(MatrixStore, DecompositionStore). When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb (if A is square then there is no doubt).

Specified by:

preallocate in interface InverterTask<N extends java.lang.Number>

preallocate

public final DecompositionStore<N> preallocate(Access2D<N> templateBody,
                                               Access2D<N> templateRHS)

Description copied from interface: SolverTask

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with SolverTask.solve(Access2D, Access2D, DecompositionStore). When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb (if A is square then there is no doubt).

Specified by:

preallocate in interface SolverTask<N extends java.lang.Number>

Returns:

isComputed

public final boolean isComputed()

Specified by:

isComputed in interface MatrixDecomposition<N extends java.lang.Number>

Returns:

true if computation has been attemped; false if not.

See Also:

MatrixDecomposition.compute(Access2D), MatrixDecomposition.isSolvable()