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 是对称正定矩阵。

参数:
A{稀疏数组, ndarray, LinearOperator}

线性系统的实数或复数 N-by-N 矩阵。 A 必须表示 Hermitian 正定矩阵。或者,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 的预处理算子。 M 必须表示 Hermitian 正定矩阵。它应该近似于 A 的逆(参见注释)。有效的预处理可以显著提高收敛速度,这意味着需要更少的迭代才能达到给定的误差容限。

callback函数

每次迭代后要调用的用户提供的函数。它被调用为 callback(xk),其中 xk 是当前的解向量。

返回:
xndarray

收敛解。

info整数
提供收敛信息

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

注释

预处理算子 M 应该是一个矩阵,使得 M @ A 的条件数小于 A,参见 [2]

参考文献

[1]

“共轭梯度法”,维基百科,https://en.wikipedia.org/wiki/Conjugate_gradient_method

[2]

“预处理器”,维基百科,https://en.wikipedia.org/wiki/Preconditioner

示例

>>> import numpy as np
>>> from scipy.sparse import csc_array
>>> 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_array(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