pulsatrix 1.1.0
Loading...
Searching...
No Matches
significance.hpp
Go to the documentation of this file.
1
20#pragma once
21
22#include <cstdint>
23#include <vector>
24
28#include "pulsatrix/tensor.hpp"
29
30namespace pulsatrix {
31
35 int64_t index = 0;
37 double ratio = 0;
39 double ell = 0;
41 double p_value = 1;
43 bool significant = false;
44};
45
49 std::vector<FeatureSignificance> features;
51 double mean_log_log = 0;
53 double threshold = 0;
54};
55
68[[nodiscard]] UniversalNullResult UniversalNullTest(const PersistenceDiagram& diagram, double alpha = 0.05);
69
73 int64_t resamples = 100;
75 double alpha = 0.05;
77 uint32_t seed = 0;
81};
82
87 double band = 0;
89 std::vector<double> distances;
94 std::vector<int64_t> significant;
95};
96
109[[nodiscard]] BootstrapBandResult BootstrapBand(const DistanceMatrix& distances, int dimension,
110 const BootstrapOptions& options = {});
111
121[[nodiscard]] Tensor GaussianBaseline(const Tensor& points, int64_t count, uint32_t seed = 0);
122
129[[nodiscard]] double BaselinePValue(double observed, const std::vector<double>& baselines);
130
133[[nodiscard]] double MaxPersistence(const PersistenceDiagram& diagram);
134
137[[nodiscard]] DistanceMatrix SubDistanceMatrix(const DistanceMatrix& distances, const std::vector<int64_t>& indices);
138
139} // namespace pulsatrix
N-dimensional tensor. Owns its data buffer exclusively; a DeviceBackend* is injected (not owned) – th...
Definition tensor.hpp:29
Pairwise Euclidean distances of a point cloud, computed with one GEMM on any backend,...
Definition acquisition_functions.hpp:16
Tensor GaussianBaseline(const Tensor &points, int64_t count, uint32_t seed=0)
count points from a Gaussian with the mean and sample covariance of the rows of points: mu + Z^T (X -...
UniversalNullResult UniversalNullTest(const PersistenceDiagram &diagram, double alpha=0.05)
Bobrowski and Skraba's universal null test for every feature of a Vietoris-Rips diagram in dimension ...
double BaselinePValue(double observed, const std::vector< double > &baselines)
The rank p-value of an observed statistic against the same statistic on baselines: (1 + #{baseline >=...
double MaxPersistence(const PersistenceDiagram &diagram)
The largest finite persistence in a diagram, 0 if it has none: a common statistic for BaselinePValue(...
DistanceMatrix SubDistanceMatrix(const DistanceMatrix &distances, const std::vector< int64_t > &indices)
A sub-matrix of a distance matrix: the distances among the given points (repeats allowed),...
BootstrapBandResult BootstrapBand(const DistanceMatrix &distances, int dimension, const BootstrapOptions &options={})
A bootstrap confidence band for a Rips diagram (after Fasy, Lecci, Rinaldo, Wasserman,...
A persistence diagram: the features of one homology dimension, each born at one scale and dying at a ...
Persistent homology of the Vietoris-Rips filtration in every dimension up to a maximum: components (H...
BootstrapBand()'s result.
Definition significance.hpp:84
double band
The (1 - alpha) quantile c of the bottleneck distances: the diagram is within c of the population's w...
Definition significance.hpp:87
PersistenceDiagram diagram
The original diagram in the tested dimension.
Definition significance.hpp:91
std::vector< double > distances
Every resample's bottleneck distance to the original diagram, sorted.
Definition significance.hpp:89
std::vector< int64_t > significant
Indices of its features with persistence above 2 * band: farther from the diagonal than the band reac...
Definition significance.hpp:94
BootstrapBand()'s settings.
Definition significance.hpp:71
RipsOptions rips
The Rips settings for every resample's diagram (the threshold is reused as given; with the default,...
Definition significance.hpp:80
double alpha
The band is the (1 - alpha) quantile of the bootstrap distances.
Definition significance.hpp:75
uint32_t seed
The random seed: the same seed gives the same band on every platform.
Definition significance.hpp:77
int64_t resamples
How many resamples.
Definition significance.hpp:73
The distances between every pair of n points, condensed.
Definition distance_matrix.hpp:56
One feature's result in UniversalNullTest().
Definition significance.hpp:33
int64_t index
The feature's index in the diagram's pairs.
Definition significance.hpp:35
bool significant
p_value < alpha / (number of features tested), Bonferroni's correction.
Definition significance.hpp:43
double ell
The normalized statistic: A log log(ratio) + B.
Definition significance.hpp:39
double ratio
death / birth, the multiplicative persistence.
Definition significance.hpp:37
double p_value
exp(-e^ell): the chance of an ell this large under the left-skewed Gumbel null.
Definition significance.hpp:41
The features of one homology dimension: H0 for components, H1 for loops, H2 for voids.
Definition persistence_diagram.hpp:32
ComputeRipsPersistence()'s settings.
Definition rips_persistence.hpp:35
UniversalNullTest()'s result.
Definition significance.hpp:47
double threshold
alpha / features.size(): the corrected threshold.
Definition significance.hpp:53
double mean_log_log
The mean of log log(ratio) over the tested features, L-bar.
Definition significance.hpp:51
std::vector< FeatureSignificance > features
One entry per tested feature (finite, birth above 0), in diagram order.
Definition significance.hpp:49
N-dimensional tensor – owns a buffer via DeviceBackend*, RAII (Rule of Five).