pymatsolver.BiCGJacobi#

class pymatsolver.BiCGJacobi(A, symmetric=None, maxiter=1000, rtol=1e-06, atol=0.0, check_accuracy=False, check_rtol=1e-06, check_atol=0, accuracy_tol=None, **kwargs)[source]#

Diagonal pre-conditioned BiCG solver.

Parameters:

Amatrix: The matrix to solve, must have a diagonal() method.
symmetric: boolean, optional: Deprecated since version 0.3.0: symmetric is deprecated. It is unused, and will be removed in pymatsolver 0.4.0.
maxiterint, optional: The maximum number of BiCG iterations to perform.
rtolfloat, optional: The relative tolerance for the BiCG solver to terminate.
atolfloat, optional: The absolute tolerance for the BiCG solver to terminate.
check_accuracybool, optional: Whether to check the accuracy of the solution.
check_rtolfloat, optional: The relative tolerance to check against for accuracy.
check_atolfloat, optional: The absolute tolerance to check against for accuracy.
accuracy_tolfloat, optional: Relative accuracy tolerance. .. deprecated:: 0.3.0

accuracy_tol will be removed in pymatsolver 0.4.0. Use check_rtol and check_atol instead.
**kwargs: Extra keyword arguments passed to the base class.

Attributes:

A: The matrix to solve with.
T: The transposed solve operator
atol
check_accuracy: Whether the check the accuracy after a solve.
check_atol: The absolute tolerance used to check the solve operation.
check_rtol: The relative tolerance used to check the solve operation.
dtype: The data type of the matrix.
is_hermitian: Whether the matrix is hermitian.
is_positive_definite: Whether the matrix is positive definite.
is_real: Whether the matrix is real.
is_symmetric: Whether the matrix is symmetric.
maxiter
rtol
shape: The input matrix dimensions.

Methods

`conj`()	Return the complex conjugate version of this solver.
`conjugate`()	Return the complex conjugate version of this solver.
`solve`(rhs)	Solves the system of equations for the given right hand side.
`transpose`()	Return the transposed solve operator.

clean
factor
get_attributes