This is a pre-release version (latest).Go to latest (1.18.0)
{ } Raw JSON

bundles / scipy latest / scipy / linalg / _flapack / cpotrf

lapack_function

scipy.linalg._flapack:cpotrf

source: build-install/usr/lib/python3.14/site-packages/scipy/linalg/_flapack.cpython-314-x86_64-linux-gnu.so

Signature

def cpotrf(a, lower = 0, clean = 1, overwrite_a = 0)

Summary

Compute the Cholesky factorization of a positive definite matrix (LAPACK cpotrf).

Parameters

a : ndarray

Symmetric or Hermitian positive definite matrix of shape (n, n).

lower : int, optional

If nonzero, the lower triangle of a is referenced and the factor is lower triangular; otherwise the upper. Default is 0.

clean : int, optional

If nonzero, the triangle LAPACK does not write is zeroed, so c is genuinely triangular. If 0, that triangle still holds whatever a had there. Default is 1.

overwrite_a : int, optional

If nonzero, a may be overwritten in place. Default is 0.

Returns

c : ndarray

Cholesky factor: c.conj().T @ c == a for the upper triangle, c @ c.conj().T == a for the lower.

info : int

0 on success; if negative, the -info-th argument had an illegal value; if positive, the leading minor of order info is not positive definite.

Aliases

  • scipy.linalg._flapack.cpotrf