cern.colt.matrix.tdouble.algo.solver.preconditioner

Interface DoublePreconditioner

All Known Implementing Classes:

DoubleAMG, DoubleDiagonal, DoubleICC, DoubleIdentity, DoubleILU, DoubleILUT, DoubleSSOR

public interface DoublePreconditioner

Preconditioner interface. Before a preconditioner is used, setMatrix must be called

Method Summary

Modifier and Type	Method and Description
DoubleMatrix1D	apply(DoubleMatrix1D b, DoubleMatrix1D x) Solves the approximate problem with the given right hand side.
void	setMatrix(DoubleMatrix2D A) Sets the operator matrix for the preconditioner.
DoubleMatrix1D	transApply(DoubleMatrix1D b, DoubleMatrix1D x) Solves the approximate transpose problem with the given right hand side.

Method Detail

apply

DoubleMatrix1D apply(DoubleMatrix1D b,
                     DoubleMatrix1D x)

Solves the approximate problem with the given right hand side. Result is stored in given solution vector

Parameters:

b - Right hand side of problem

x - Result is stored here

Returns:

x

transApply

DoubleMatrix1D transApply(DoubleMatrix1D b,
                          DoubleMatrix1D x)

Solves the approximate transpose problem with the given right hand side. Result is stored in given solution vector

Parameters:

b - Right hand side of problem

x - Result is stored here

Returns:

x

setMatrix

void setMatrix(DoubleMatrix2D A)

Sets the operator matrix for the preconditioner. This method must be called before a preconditioner is used by an iterative solver

Parameters:

A - Matrix to setup the preconditioner for. Not modified