warp.optim.linear.BiCGSTAB#

class warp.optim.linear.BiCGSTAB( A, b, x, tol=None, atol=None, maxiter=0, M=None, callback=None, check_every=10, use_cuda_graph=True, is_left_preconditioner=False, )[source]#

Pre-allocated state for the BiConjugate Gradient Stabilized solver.

See LinearSolverState for the shared constructor parameters, plus:

Parameters:

is_left_preconditioner (bool) – whether M should be used as a left- or right- preconditioner.
A (array | BsrMatrix | LinearOperator)
b (array)
x (array)
tol (float | None)
atol (float | None)
maxiter (float | None)
M (array | BsrMatrix | LinearOperator | None)
callback (Callable | None)
check_every (int)
use_cuda_graph (bool)

Unlike CG and CR, the presence of M is fixed at construction: if M was None, subsequent calls must also have M None; otherwise a compatible preconditioner must be supplied.

__init__( A, b, x, tol=None, atol=None, maxiter=0, M=None, callback=None, check_every=10, use_cuda_graph=True, is_left_preconditioner=False, )[source]#

Parameters:

A (array | BsrMatrix | LinearOperator)
b (array)
x (array)
tol (float | None)
atol (float | None)
maxiter (float | None)
M (array | BsrMatrix | LinearOperator | None)
callback (Callable | None)
check_every (int)
use_cuda_graph (bool)
is_left_preconditioner (bool)

Methods

__init__(A, b, x[, tol, atol, maxiter, M, ...])