org.ojalgo.matrix.decomposition

Class RawEigenvalue.General

java.lang.Object

org.ojalgo.matrix.decomposition.RawEigenvalue

org.ojalgo.matrix.decomposition.RawEigenvalue.General

All Implemented Interfaces:

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

Enclosing class:

RawEigenvalue

public static final class RawEigenvalue.General
extends RawEigenvalue

Nested Class Summary

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

RawEigenvalue.General, RawEigenvalue.Nonsymmetric, RawEigenvalue.Symmetric

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

BIG, COMPLEX, PRIMITIVE

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

BIG, COMPLEX, PRIMITIVE

Constructor Summary

Constructors

Constructor and Description
General()

Method Summary

Modifier and Type	Method and Description
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()
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.
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.

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

calculateDeterminant, compute, compute, equals, getD, getDeterminant, getEigenvalues, getInverse, getInverse, getTrace, getV, isFullSize, isHermitian, isOrdered, isSolvable, reconstruct, reset, solve, toString

Methods inherited from class java.lang.Object

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

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

make, makeBig, makeBig, makeComplex, makeComplex, makePrimitive, makePrimitive

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

checkAndCompute

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

General

public General()

Method Detail

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