scipy.sparse.linalg.

cg#

scipy.sparse.linalg.cg(A, b, x0=None, *, rtol=1e-05, atol=0.0, maxiter=None, M=None, callback=None)[source]#

使用共轭梯度迭代法求解 Ax = b。

参数:
A{稀疏矩阵，ndarray，LinearOperator}

线性系统的实数或复数 N×N 矩阵。 A 必须表示一个厄米特正定矩阵。或者，A 可以是线性算子，可以使用 scipy.sparse.linalg.LinearOperator 等生成 Ax。

bndarray

线性系统的右侧。形状为 (N,) 或 (N,1)。

x0ndarray

解的初始猜测。

rtol, atolfloat，可选

收敛测试参数。为了收敛，norm(b - A @ x) <= max(rtol*norm(b), atol) 应该满足。默认值为 atol=0. 和 rtol=1e-5。

maxiter整数

最大迭代次数。即使未达到指定容差，迭代也会在 maxiter 步后停止。

M{稀疏矩阵，ndarray，LinearOperator}

A 的预处理器。预处理器应该近似于 A 的逆。有效的预处理极大地提高了收敛速度，这意味着达到给定误差容差所需的迭代次数更少。

callback函数

每次迭代后调用用户提供的函数。它以 callback(xk) 的形式调用，其中 xk 是当前解向量。

返回值:
xndarray

收敛解。

info整数
提供收敛信息

0 : 成功退出 >0 : 未达到容差收敛，迭代次数

示例

>>> import numpy as np
>>> from scipy.sparse import csc_matrix
>>> from scipy.sparse.linalg import cg
>>> P = np.array([[4, 0, 1, 0],
...               [0, 5, 0, 0],
...               [1, 0, 3, 2],
...               [0, 0, 2, 4]])
>>> A = csc_matrix(P)
>>> b = np.array([-1, -0.5, -1, 2])
>>> x, exit_code = cg(A, b, atol=1e-5)
>>> print(exit_code)    # 0 indicates successful convergence
0
>>> np.allclose(A.dot(x), b)
True
本页内容