scipy 1.8.0 Pypi GitHub Homepage
Other Docs
ParametersRaisesReturnsBackRef
pinvh(a, atol=None, rtol=None, lower=True, return_rank=False, check_finite=True, cond=None, rcond=None)

Calculate a generalized inverse of a complex Hermitian/real symmetric matrix using its eigenvalue decomposition and including all eigenvalues with 'large' absolute value.

Parameters

a : (N, N) array_like

Real symmetric or complex hermetian matrix to be pseudo-inverted

atol: float, optional :

Absolute threshold term, default value is 0.

versionadded
rtol: float, optional :

Relative threshold term, default value is N * eps where eps is the machine precision value of the datatype of a .

versionadded
lower : bool, optional

Whether the pertinent array data is taken from the lower or upper triangle of a. (Default: lower)

return_rank : bool, optional

If True, return the effective rank of the matrix.

check_finite : bool, optional

Whether to check that the 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.

cond, rcond : float, optional

In older versions, these values were meant to be used as atol with rtol=0 . If both were given rcond overwrote cond and hence the code was not correct. Thus using these are strongly discouraged and the tolerances above are recommended instead. In fact, if provided, atol, rtol takes precedence over these keywords.

versionchanged

Deprecated in favor of rtol and atol parameters above and will be removed in future versions of SciPy.

versionchanged

Previously the default cutoff value was just eps*f where f was 1e3 for single precision and 1e6 for double precision.

Raises

LinAlgError

If eigenvalue algorithm does not converge.

Returns

B : (N, N) ndarray

The pseudo-inverse of matrix a.

rank : int

The effective rank of the matrix. Returned if :None:None:`return_rank` is True.

Compute the (Moore-Penrose) pseudo-inverse of a Hermitian matrix.

Examples

>>> from scipy.linalg import pinvh
... rng = np.random.default_rng()
... a = rng.standard_normal((9, 6))
... a = np.dot(a, a.T)
... B = pinvh(a)
... np.allclose(a, a @ B @ a) True
>>> np.allclose(B, B @ a @ B)
True
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

scipy.linalg._basic.pinvh

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /scipy/linalg/_basic.py#1404
type: <class 'function'>
Commit: