spd_learn.functional.log_map_logchol#

spd_learn.functional.log_map_logchol(X, Cref, **kwargs)[source]#

Project matrices in tangent space by log-Cholesky logarithmic map.

The projection of a matrix \(\mathbf{X}\) from SPD/HPD manifold to tangent space by log-Cholesky logarithmic map, see Table 2 of [1] .

Parameters:
  • X (ndarray, shape (..., n, n)) – Matrices in SPD/HPD manifold.

  • Cref (ndarray, shape (n, n)) – Reference SPD matrix.

Returns:

X_new – Matrices projected in tangent space.

Return type:

ndarray, shape (…, n, n)

Notes

Added in version 0.7.

Changed in version 0.12: Add support for NumPy and PyTorch.

References

[1]

Riemannian geometry of symmetric positive definite matrices via Cholesky decomposition Z. Lin. SIAM J Matrix Anal Appl, 2019, 40(4), pp. 1353-1370.