cern.colt.matrix.tfloat.algo.solver

Class FloatCG

java.lang.Object

cern.colt.matrix.tfloat.algo.solver.AbstractFloatIterativeSolver

cern.colt.matrix.tfloat.algo.solver.FloatCG

All Implemented Interfaces:

FloatIterativeSolver

public class FloatCG
extends AbstractFloatIterativeSolver

Conjugate Gradients solver. CG solves the symmetric positive definite linear system Ax=b using the Conjugate Gradient method.

Constructor Summary

Constructors

Constructor and Description
FloatCG(FloatMatrix1D template) Constructor for CG.

Method Summary

Modifier and Type	Method and Description
FloatMatrix1D	solve(FloatMatrix2D A, FloatMatrix1D b, FloatMatrix1D x) Solves the given problem, writing result into the vector.

Methods inherited from class cern.colt.matrix.tfloat.algo.solver.AbstractFloatIterativeSolver

getIterationMonitor, getPreconditioner, setIterationMonitor, setPreconditioner

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatCG

public FloatCG(FloatMatrix1D template)

Constructor for CG. Uses the given vector as template for creating scratch vectors. Typically, the solution or the right hand side vector can be passed, and the template is not modified

Parameters:

template - Vector to use as template for the work vectors needed in the solution process

Method Detail

solve

public FloatMatrix1D solve(FloatMatrix2D A,
                           FloatMatrix1D b,
                           FloatMatrix1D x)
                    throws IterativeSolverFloatNotConvergedException

Description copied from interface: FloatIterativeSolver

Solves the given problem, writing result into the vector.

Parameters:

A - Matrix of the problem

b - Right hand side

x - Solution is stored here. Also used as initial guess

Returns:

The solution vector x

Throws:

IterativeSolverFloatNotConvergedException