SPDMetricEuclidean: Class for the Euclidean Metric on the Manifold of Symmetric...

SPDMetricEuclideanR Documentation

Class for the Euclidean Metric on the Manifold of Symmetric Positive Definite Matrices

Description

An R6::R6Class object implementing the SPDMetricEuclidean class. This is the class for the Euclidean metric on the SPD manifold.

Super classes

rgeomstats::PythonClass -> rgeomstats::Connection -> rgeomstats::RiemannianMetric -> SPDMetricEuclidean

Public fields

n

An integer value specifying the shape of the matrices: n \times n.

power_euclidean

An integer value specifying the power transformation of the classical SPD metric.

Methods

Public methods

Inherited methods

Method new()

The SPDMetricEuclidean class constructor.

Usage
SPDMetricEuclidean$new(n, power_euclidean = 1, py_cls = NULL)
Arguments
n

An integer value specifying the shape of the matrices: n \times n.

power_euclidean

An integer value specifying the power transformation of the classical SPD metric. Defaults to 1L.

py_cls

A Python object of class SPDMetricEuclidean. Defaults to NULL in which case it is instantiated on the fly using the other input arguments.

Returns

An object of class SPDMetricEuclidean.


Method clone()

The objects of this class are cloneable with this method.

Usage
SPDMetricEuclidean$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Yann Thanwerdas


rgeomstats documentation built on Nov. 4, 2022, 5:09 p.m.