Riemann (version 0.1.4)

spd.geometry: Supported Geometries on SPD Manifold

Description

SPD manifold is a well-studied space in that there have been many geometries proposed on the space. For special functions on under SPD category, this function finds whether there exists a matching name that is currently supported in Riemann. If there is none, it will return an error message.

Usage

spd.geometry(geometry)

Arguments

geometry

name of supported geometries, including

AIRM

Affine-Invariant Riemannian Metric.

LERM

Log-Euclidean Riemannian Metric.

Jeffrey

Jeffrey's divergence.

Stein

Stein's metric.

Wasserstein

2-Wasserstein geometry.

Value

a matching name in lower-case.

Examples

# NOT RUN {
# it just returns a small-letter string.
mygeom = spd.geometry("stein")

# }