RipsComplex: R6 Class for Rips Complex

In rgudhi: An Interface to the GUDHI Library for Topological Data Analysis

R6 Class for Rips Complex

Description

The data structure is a one skeleton graph, or Rips graph, containing edges when the edge length is less or equal to a given threshold. Edge length is computed from a user given point cloud with a given distance function, or a distance matrix.

Super class

rgudhi::PythonClass -> RipsComplex

Methods

Public methods

• RipsComplex$new()

• RipsComplex$create_simplex_tree()

• RipsComplex$clone()

Inherited methods

• rgudhi::PythonClass$get_python_class()
• rgudhi::PythonClass$set_python_class()

---

Method new()

RipsComplex constructor.

Usage

RipsComplex$new(data, max_edge_length = NULL, sparse = NULL)

Arguments

data

Either a ⁠n x d⁠ matrix or a length-n list of d-dimensional vectors or a distance matrix stored as a dist object.

max_edge_length

A numeric value specifying the Rips value.

sparse

A numeric value specifying the approximation parameter epsilon for buidling a sparse Rips complex. Defaults to NULL which builds an exact Rips complex.

Returns

A RipsComplex object storing the Rips complex.

---

Method create_simplex_tree()

Usage

RipsComplex$create_simplex_tree(max_dimension)

Arguments

max_dimension

An integer value specifying the maximal dimension which the Rips complex will be expanded to.

Returns

A SimplexTree object storing the computed simplex tree.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RipsComplex$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Clément Maria, Pawel Dlotko, Vincent Rouvreau, Marc Glisse, Yuichi Ike

See Also

Other filtrations and reconstructions: AlphaComplex, TangentialComplex, WitnessComplex

Examples

X <- seq_circle(10)
rc1 <- RipsComplex$new(data = X, max_edge_length = 1)
Xm <- Reduce(rbind, X, init = numeric())
rc2 <- RipsComplex$new(data = Xm, max_edge_length = 1)
D <- dist(Xm)
rc3 <- RipsComplex$new(data = D)


X <- seq_circle(10)
rc <- RipsComplex$new(data = X, max_edge_length = 1)
st <- rc$create_simplex_tree(1)

rgudhi documentation built on March 31, 2023, 11:38 p.m.