org.ojalgo.matrix.decomposition

Class RawQR

java.lang.Object

org.ojalgo.matrix.decomposition.RawQR

All Implemented Interfaces:

MatrixDecomposition<java.lang.Double>, QR<java.lang.Double>, DeterminantTask<java.lang.Double>, InverterTask<java.lang.Double>, MatrixTask<java.lang.Double>, SolverTask<java.lang.Double>

Deprecated.

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

@Deprecated
public final class RawQR
extends java.lang.Object
implements QR<java.lang.Double>

This class adapts JAMA's QRDecomposition to ojAlgo's QR interface.

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>

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

DeterminantTask.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

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

BIG, COMPLEX, PRIMITIVE

Constructor Summary

Constructors

Constructor and Description
RawQR() Deprecated. Not recommended to use this constructor directly.

Method Summary

Modifier and Type	Method and Description
java.lang.Double	calculateDeterminant(Access2D<java.lang.Double> matrix) Deprecated.
boolean	compute(Access2D<?> matrix) Deprecated.
boolean	compute(Access2D<?> matrix, boolean fullSize) Deprecated.
boolean	equals(MatrixStore<java.lang.Double> aStore, NumberContext context) Deprecated.
java.lang.Double	getDeterminant() Deprecated.
RawStore	getInverse() Deprecated. The output must be a "right inverse" and a "generalised inverse".
MatrixStore<java.lang.Double>	getInverse(DecompositionStore<java.lang.Double> preallocated) Deprecated. Makes no use of preallocated at all.
RawStore	getQ() Deprecated.
RawStore	getR() Deprecated.
int	getRank() Deprecated.
MatrixStore<java.lang.Double>	invert(MatrixStore<java.lang.Double> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<java.lang.Double>	invert(MatrixStore<java.lang.Double> original, DecompositionStore<java.lang.Double> preallocated) Implementiong this method is optional.
boolean	isComputed()
boolean	isFullColumnRank() Deprecated. The QR decompostion always exists, even if the matrix does not have full column rank, so the compute method will never fail.
boolean	isFullSize() Deprecated.
boolean	isSolvable() Deprecated.
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
RawStore	solve(Access2D<java.lang.Double> rhs) Deprecated. [A][X]=[B] or [this][return]=[rhs]
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> body, Access2D<java.lang.Double> rhs) [A][X]=[B] or [body][return]=[rhs]
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> body, Access2D<java.lang.Double> rhs, DecompositionStore<java.lang.Double> preallocated) Implementiong this method is optional.
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> rhs, DecompositionStore<java.lang.Double> preallocated) Makes no use of preallocated at all.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

make, makeBig, makeComplex, makePrimitive, reconstruct

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

equals, isComputed, solve

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

invert, invert, preallocate

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

preallocate, solve, solve

Constructor Detail

RawQR

public RawQR()

Deprecated.

Not recommended to use this constructor directly. Consider using the static factory method QR.make(Access2D) instead.

Method Detail

calculateDeterminant

public java.lang.Double calculateDeterminant(Access2D<java.lang.Double> matrix)

Deprecated.

Specified by:

calculateDeterminant in interface DeterminantTask<java.lang.Double>

compute

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

Deprecated.

Specified by:

compute in interface QR<java.lang.Double>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

equals

public boolean equals(MatrixStore<java.lang.Double> aStore,
                      NumberContext context)

Deprecated.

Specified by:

equals in interface MatrixDecomposition<java.lang.Double>

getDeterminant

public java.lang.Double getDeterminant()

Deprecated.

Specified by:

getDeterminant in interface QR<java.lang.Double>

solve

public RawStore solve(Access2D<java.lang.Double> rhs)

Deprecated.

Description copied from interface: MatrixDecomposition

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

Specified by:

solve in interface MatrixDecomposition<java.lang.Double>

getInverse

public RawStore getInverse()

Deprecated.

Description copied from interface: MatrixDecomposition

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

Specified by:

getInverse in interface MatrixDecomposition<java.lang.Double>

See Also:

BasicMatrix.invert()

getQ

public RawStore getQ()

Deprecated.

Specified by:

getQ in interface QR<java.lang.Double>

getR

public RawStore getR()

Deprecated.

Specified by:

getR in interface QR<java.lang.Double>

getRank

public int getRank()

Deprecated.

Specified by:

getRank in interface QR<java.lang.Double>

isFullColumnRank

public boolean isFullColumnRank()

Deprecated.

Description copied from interface: QR

The QR decompostion always exists, even if the matrix does not have full column rank, so the compute method will never fail. The primary use of the QR decomposition is in the least squares solution of overdetermined systems of simultaneous linear equations. This will fail if the matrix does not have full column rank. The rank must be equal to the number of columns.

Specified by:

isFullColumnRank in interface QR<java.lang.Double>

isFullSize

public boolean isFullSize()

Deprecated.

Specified by:

isFullSize in interface MatrixDecomposition<java.lang.Double>

Returns:

True if the implementation generates a full sized decomposition.

isSolvable

public boolean isSolvable()

Deprecated.

Specified by:

isSolvable in interface MatrixDecomposition<java.lang.Double>

Returns:

true if it is ok to call MatrixDecomposition.solve(Access2D) (computation was successful); false if not

See Also:

MatrixDecomposition.solve(Access2D), MatrixDecomposition.isComputed()

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<java.lang.Double>

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object

compute

public final boolean compute(Access2D<?> matrix)

Deprecated.

Specified by:

compute in interface MatrixDecomposition<java.lang.Double>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

getInverse

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

Deprecated.

Makes no use of preallocated at all. Simply delegates to getInverse().

Specified by:

getInverse in interface MatrixDecomposition<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.

Returns:

The inverse, this is where you get the solution

See Also:

MatrixDecomposition.getInverse(org.ojalgo.matrix.decomposition.DecompositionStore)

invert

public final MatrixStore<java.lang.Double> invert(MatrixStore<java.lang.Double> 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<java.lang.Double> invert(MatrixStore<java.lang.Double> original,
                                                  DecompositionStore<java.lang.Double> 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<java.lang.Double> solve(Access2D<java.lang.Double> body,
                                                 Access2D<java.lang.Double> rhs)

Description copied from interface: SolverTask

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

solve

public final MatrixStore<java.lang.Double> solve(Access2D<java.lang.Double> body,
                                                 Access2D<java.lang.Double> rhs,
                                                 DecompositionStore<java.lang.Double> 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

solve

public MatrixStore<java.lang.Double> solve(Access2D<java.lang.Double> rhs,
                                           DecompositionStore<java.lang.Double> preallocated)

Makes no use of preallocated at all. Simply delegates to MatrixDecomposition.solve(Access2D).

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

See Also:

MatrixDecomposition.solve(Access2D, org.ojalgo.matrix.decomposition.DecompositionStore)

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()