scipy.sparse.linalg.

cg#

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

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

參數:

A{稀疏陣列, ndarray, LinearOperator}: 線性系統的實數或複數 N 乘 N 矩陣。A 必須表示 Hermitian 正定矩陣。或者，A 可以是線性算符，其可以使用例如 scipy.sparse.linalg.LinearOperator 來產生 Ax。
bndarray: 線性系統的右側。形狀為 (N,) 或 (N,1)。
x0ndarray: 解的起始猜測值。
rtol, atolfloat, optional: 收斂性測試的參數。為了收斂，應該滿足 norm(b - A @ x) <= max(rtol*norm(b), atol)。預設值為 atol=0. 和 rtol=1e-5。
maxiterinteger: 最大迭代次數。即使尚未達到指定的容忍度，迭代也會在 maxiter 步驟後停止。
M{稀疏陣列, ndarray, LinearOperator}: A 的預處理器。M 必須表示 Hermitian 正定矩陣。它應該近似於 A 的逆矩陣（請參閱「註解」）。有效的預處理可以顯著提高收斂速度，這表示達到給定的誤差容忍度所需的迭代次數更少。
callbackfunction: 在每次迭代後呼叫的使用者提供函數。它被呼叫為 callback(xk)，其中 xk 是目前的解向量。

返回:

xndarray

收斂解。

infointeger

提供收斂資訊: 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