MetricStep: Metric Step
In rgudhi: An Interface to the GUDHI Library for Topological Data Analysis
MetricStep R Documentation
Metric Step
Description
Metric Step
Metric Step
Super classes
rgudhi::PythonClass -> rgudhi::SKLearnClass -> MetricStep
Methods
Public methods
-
-
-
-
-
Inherited methods
Method apply()
Applies the class on a single persistence diagram and
outputs the result.
Usage
MetricStep$apply(diag1, diag2)
Arguments
diag1A 2-column tibble::tibble specifying a persistence diagram.
diag2A 2-column tibble::tibble specifying a persistence diagram.
Returns
A numeric value storing the distance between the two input
diagrams.
Method fit()
Fits the class on a sample of persistence diagrams.
Usage
MetricStep$fit(X, y = NULL)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of
persistence diagrams.
yAn integer vector specifying persistence diagram labels (unused for
now).
Returns
The class itself invisibly.
Method transform()
Applies the class on a sample of persistence diagrams.
Usage
MetricStep$transform(X)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of
persistence diagrams.
Returns
A numeric matrix of shape n_\mathrm{out} \times
n_\mathrm{in} storing the distances between the n_\mathrm{out}
persistence diagrams passed to the $transform() method and the
n_\mathrm{in} persistence diagrams passed to the $fit() method.
Method fit_transform()
Applies sequentially the $fit() and $transform() methods
on a sample of persistence diagrams in a more efficient way than
calling them directly.
Usage
MetricStep$fit_transform(X, y = NULL)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of
persistence diagrams.
yAn integer vector specifying persistence diagram labels (unused for
now).
Returns
A numeric matrix of shape n \times n storing the distance
between the n persistence diagrams passed to both the $fit()
and $transform() methods.
Method clone()
The objects of this class are cloneable with this method.
Usage
MetricStep$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Mathieu Carrière
rgudhi documentation built on March 31, 2023, 11:38 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| MetricStep | R Documentation |
Metric Step
Description
Metric Step
Metric Step
Super classes
rgudhi::PythonClass -> rgudhi::SKLearnClass -> MetricStep
Methods
Public methods
Inherited methods
Method apply()
Applies the class on a single persistence diagram and outputs the result.
Usage
MetricStep$apply(diag1, diag2)
Arguments
diag1A 2-column tibble::tibble specifying a persistence diagram.
diag2A 2-column tibble::tibble specifying a persistence diagram.
Returns
A numeric value storing the distance between the two input diagrams.
Method fit()
Fits the class on a sample of persistence diagrams.
Usage
MetricStep$fit(X, y = NULL)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of persistence diagrams.
yAn integer vector specifying persistence diagram labels (unused for now).
Returns
The class itself invisibly.
Method transform()
Applies the class on a sample of persistence diagrams.
Usage
MetricStep$transform(X)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of persistence diagrams.
Returns
A numeric matrix of shape n_\mathrm{out} \times
n_\mathrm{in} storing the distances between the n_\mathrm{out}
persistence diagrams passed to the $transform() method and the
n_\mathrm{in} persistence diagrams passed to the $fit() method.
Method fit_transform()
Applies sequentially the $fit() and $transform() methods
on a sample of persistence diagrams in a more efficient way than
calling them directly.
Usage
MetricStep$fit_transform(X, y = NULL)
Arguments
XA list of 2-column tibble::tibbles specifying a sample of persistence diagrams.
yAn integer vector specifying persistence diagram labels (unused for now).
Returns
A numeric matrix of shape n \times n storing the distance
between the n persistence diagrams passed to both the $fit()
and $transform() methods.
Method clone()
The objects of this class are cloneable with this method.
Usage
MetricStep$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Mathieu Carrière
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.