NFoldManifold: Class for N-Fold Product Manifolds

In rgeomstats: Interface to 'Geomstats'

Class for N-Fold Product Manifolds

Description

Class for an n-fold product manifold M^n. It defines a manifold as the product manifold of n copies of a given base manifold M.

Super classes

rgeomstats::PythonClass -> rgeomstats::Manifold -> NFoldManifold

Methods

Public methods

• NFoldManifold$new()

• NFoldManifold$clone()

Inherited methods

• rgeomstats::PythonClass$get_python_class()
• rgeomstats::PythonClass$set_python_class()
• rgeomstats::Manifold$belongs()
• rgeomstats::Manifold$is_tangent()
• rgeomstats::Manifold$random_point()
• rgeomstats::Manifold$random_tangent_vec()
• rgeomstats::Manifold$regularize()
• rgeomstats::Manifold$set_metric()
• rgeomstats::Manifold$to_tangent()

---

Method new()

The NFoldManifold class constructor.

Usage

NFoldManifold$new(
  base_manifold,
  n_copies,
  metric = NULL,
  default_coords_type = "intrinsic",
  py_cls = NULL
)

Arguments

base_manifold

An R6::R6Class specifying the base manifold to copy.

n_copies

An integer value specifying the number of replication of the base manifold.

metric

An R6::R6Class specifying the base metric to use. Defaults to NULL which uses the Riemannian metric.

default_coords_type

A string specifying the coordinate type. Choices are "intrinsic" or "extrinsic". Defaults to "intrinsic".

py_cls

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

Returns

A NFoldManifold R6::R6Class object.

Examples

if (reticulate::py_module_available("geomstats")) {
  nfm <- NFoldManifold$new(
    base_manifold = SPDMatrix(n = 3),
    n_copies = 3
  )
  nfm
}

---

Method clone()

The objects of this class are cloneable with this method.

Usage

NFoldManifold$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Nicolas Guigui

Examples

## ------------------------------------------------
## Method `NFoldManifold$new`
## ------------------------------------------------

if (reticulate::py_module_available("geomstats")) {
  nfm <- NFoldManifold$new(
    base_manifold = SPDMatrix(n = 3),
    n_copies = 3
  )
  nfm
}

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