org.ojalgo.matrix.task.iterative

Class ConjugateGradientSolver

java.lang.Object

org.ojalgo.matrix.task.iterative.ConjugateGradientSolver

All Implemented Interfaces:

MatrixTask<Double>, SolverTask<Double>

public final class ConjugateGradientSolver
extends Object

A (Jacobi) preconditioned conjugate gradient solver.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IterativeSolverTask.Configurator

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

SolverTask.Factory<N extends Number>

Field Summary

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

BIG, COMPLEX, PRIMITIVE, QUATERNION, RATIONAL

Constructor Summary

Constructors

Constructor and Description
ConjugateGradientSolver()

Method Summary

Modifier and Type	Method and Description
IterativeSolverTask.Configurator	configurator()
protected void	debug(int iteration, Access1D<?> current)
protected NumberContext	getAccuracyContext()
protected int	getIterationsLimit()
protected boolean	isDebugPrinterSet()
PhysicalStore<Double>	preallocate(Structure2D templateBody, Structure2D templateRHS) Will create a PhysicalStore instance suitable for use with SolverTask.solve(Access2D, Access2D, PhysicalStore).
double	resolve(List<Equation> equations, PhysicalStore<Double> solution)
protected void	setAccuracyContext(NumberContext accuracyContext)
protected void	setDebugPrinter(BasicLogger.Printer debugPrinter)
protected void	setIterationsLimit(int iterationsLimit)
MatrixStore<Double>	solve(Access2D<?> body, Access2D<?> rhs, PhysicalStore<Double> preallocated) Exactly how (if at all) a specific implementation makes use of preallocated is not specified by this interface.
Optional<MatrixStore<Double>>	solve(MatrixStore<Double> body, MatrixStore<Double> rhs)

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

preallocate, solve

Constructor Detail

ConjugateGradientSolver

public ConjugateGradientSolver()

Method Detail

resolve

public double resolve(List<Equation> equations,
                      PhysicalStore<Double> solution)

solve

public MatrixStore<Double> solve(Access2D<?> body,
                                 Access2D<?> rhs,
                                 PhysicalStore<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<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/final/correct solution.

Returns:

The solution

Throws:

RecoverableCondition

configurator

public final IterativeSolverTask.Configurator configurator()

preallocate

public final PhysicalStore<Double> preallocate(Structure2D templateBody,
                                               Structure2D templateRHS)

Description copied from interface: SolverTask

Will create a PhysicalStore instance suitable for use with SolverTask.solve(Access2D, Access2D, PhysicalStore). The dimensions of the returned instance is not specified by this interface - it is specified by the behaviour/requirements of each implementation.

When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb.

Specified by:

preallocate in interface SolverTask<Double>

solve

public final Optional<MatrixStore<Double>> solve(MatrixStore<Double> body,
                                                 MatrixStore<Double> rhs)

debug

protected final void debug(int iteration,
                           Access1D<?> current)

getAccuracyContext

protected final NumberContext getAccuracyContext()

getIterationsLimit

protected final int getIterationsLimit()

isDebugPrinterSet

protected final boolean isDebugPrinterSet()

setAccuracyContext

protected void setAccuracyContext(NumberContext accuracyContext)

setDebugPrinter

protected void setDebugPrinter(BasicLogger.Printer debugPrinter)

setIterationsLimit

protected void setIterationsLimit(int iterationsLimit)