pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::PersistenceDiagramDocument Struct Reference

Persistence diagrams of one point cloud, one entry per homology dimension. More...

#include <topology_documents.hpp>

Public Member Functions

const PersistenceDiagramEntry * find (int dimension) const
 The entry for dimension, or nullptr.
 
PersistenceDiagramEntry * find (int dimension)
 

Public Attributes

std::string title
 
std::string filtration = "rips"
 The filtration that made the diagrams, for example "rips".
 
std::string source
 What the points were, for example "SmolLM2-135M, layer 12, weekday tokens".
 
int64_t num_points = 0
 How many points; 0 when unknown.
 
double threshold = 0
 The largest scale the filtration was computed to (RipsResult::threshold); 0 when unknown. Essential features are drawn at this scale.
 
std::vector< PersistenceDiagramEntry > diagrams
 One per dimension, each dimension at most once.
 

Detailed Description

Persistence diagrams of one point cloud, one entry per homology dimension.

Member Function Documentation

◆ find() [1/2]

PersistenceDiagramEntry * pulsatrix::PersistenceDiagramDocument::find ( int  dimension)

◆ find() [2/2]

const PersistenceDiagramEntry * pulsatrix::PersistenceDiagramDocument::find ( int  dimension) const

The entry for dimension, or nullptr.

Member Data Documentation

◆ diagrams

std::vector<PersistenceDiagramEntry> pulsatrix::PersistenceDiagramDocument::diagrams

One per dimension, each dimension at most once.

◆ filtration

std::string pulsatrix::PersistenceDiagramDocument::filtration = "rips"

The filtration that made the diagrams, for example "rips".

◆ num_points

int64_t pulsatrix::PersistenceDiagramDocument::num_points = 0

How many points; 0 when unknown.

◆ source

std::string pulsatrix::PersistenceDiagramDocument::source

What the points were, for example "SmolLM2-135M, layer 12, weekday tokens".

◆ threshold

double pulsatrix::PersistenceDiagramDocument::threshold = 0

The largest scale the filtration was computed to (RipsResult::threshold); 0 when unknown. Essential features are drawn at this scale.

◆ title

std::string pulsatrix::PersistenceDiagramDocument::title

The documentation for this struct was generated from the following file: