papyri
{ } Raw JSON

bundles / scipy latest / scipy / linalg / _decomp_cholesky / cho_factor

function

scipy.linalg._decomp_cholesky:cho_factor

source: /scipy/linalg/_decomp_cholesky.py :111

Signature

def   cho_factor ( a ,  lower = False ,  overwrite_a = False ,  check_finite = True )

Summary

Compute the Cholesky decomposition of a matrix, to use in cho_solve

Extended Summary

Returns a matrix containing the Cholesky decomposition, A = L L* or A = U* U of a Hermitian positive-definite matrix a. The return value can be directly used as the first parameter to cho_solve.

The documentation is written assuming array arguments are of specified "core" shapes. However, array argument(s) of this function may have additional "batch" dimensions prepended to the core shape. In this case, the array is treated as a batch of lower-dimensional slices; see linalg_batch for details. Note that calls with zero-size batches are unsupported and will raise a ValueError.

Parameters

a : (M, M) array_like

Matrix to be decomposed

lower : bool, optional

Whether to compute the upper or lower triangular Cholesky factorization. During decomposition, only the selected half of the matrix is referenced. (Default: upper-triangular)

overwrite_a : bool, optional

Whether to overwrite data in a (may improve performance)

check_finite : bool, optional

Whether to check that the entire input matrix contains only finite numbers. Disabling may give a performance gain, but may result in problems (crashes, non-termination) if the inputs do contain infinities or NaNs.

Returns

c : (M, M) ndarray

Matrix whose upper or lower triangle contains the Cholesky factor of a. Other parts of the matrix contain random data.

lower : bool

Flag indicating whether the factor is in the lower or upper triangle

Raises

: LinAlgError

Raised if decomposition fails.

Notes

During the finiteness check (if selected), the entire matrix a is checked. During decomposition, a is assumed to be symmetric or Hermitian (as applicable), and only the half selected by option lower is referenced. Consequently, if a is asymmetric/non-Hermitian, cholesky may still succeed if the symmetric/Hermitian matrix represented by the selected half is positive definite, yet it may fail if an element in the other half is non-finite.

Examples

import numpy as np
from scipy.linalg import cho_factor
A = np.array([[9, 3, 1, 5], [3, 7, 5, 1], [1, 5, 9, 2], [5, 1, 2, 6]])
c, low = cho_factor(A)
✓
c
✗
np.allclose(np.triu(c).T @ np. triu(c) - A, np.zeros((4, 4)))
✓

See also

cho_solve

Solve a linear set equations using the Cholesky factorization of a matrix.

Aliases

  • scipy.linalg.cho_factor