scipy 1.8.0 Pypi GitHub Homepage
Other Docs
ParametersReturns
gcrotmk(A, b, x0=None, tol=1e-05, maxiter=1000, M=None, callback=None, m=20, k=None, CU=None, discard_C=False, truncate='oldest', atol=None)

Parameters

A : {sparse matrix, ndarray, LinearOperator}

The real or complex N-by-N matrix of the linear system. Alternatively, A can be a linear operator which can produce Ax using, e.g., scipy.sparse.linalg.LinearOperator .

b : ndarray

Right hand side of the linear system. Has shape (N,) or (N,1).

x0 : ndarray

Starting guess for the solution.

tol, atol : float, optional

Tolerances for convergence, norm(residual) <= max(tol*norm(b), atol) . The default for atol is :None:None:`tol`.

warning

The default value for :None:None:`atol` will be changed in a future release. For future compatibility, specify :None:None:`atol` explicitly.

maxiter : int, optional

Maximum number of iterations. Iteration will stop after maxiter steps even if the specified tolerance has not been achieved.

M : {sparse matrix, ndarray, LinearOperator}, optional

Preconditioner for A. The preconditioner should approximate the inverse of A. gcrotmk is a 'flexible' algorithm and the preconditioner can vary from iteration to iteration. Effective preconditioning dramatically improves the rate of convergence, which implies that fewer iterations are needed to reach a given error tolerance.

callback : function, optional

User-supplied function to call after each iteration. It is called as callback(xk), where xk is the current solution vector.

m : int, optional

Number of inner FGMRES iterations per each outer iteration. Default: 20

k : int, optional

Number of vectors to carry between inner FGMRES iterations. According to , good values are around m. Default: m

CU : list of tuples, optional

List of tuples (c, u) which contain the columns of the matrices C and U in the GCROT(m,k) algorithm. For details, see . The list given and vectors contained in it are modified in-place. If not given, start from empty matrices. The c elements in the tuples can be None , in which case the vectors are recomputed via c = A u on start and orthogonalized as described in .

discard_C : bool, optional

Discard the C-vectors at the end. Useful if recycling Krylov subspaces for different linear systems.

truncate : {'oldest', 'smallest'}, optional

Truncation scheme to use. Drop: oldest vectors, or vectors with smallest singular values using the scheme discussed in [1,2]. See for detailed comparison. Default: 'oldest'

Returns

x : ndarray

The solution found.

info : int

Provides convergence information:

Solve a matrix equation using flexible GCROT(m,k) algorithm.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /scipy/sparse/linalg/_isolve/_gcrotmk.py#182
type: <class 'function'>
Commit: