Skip to main content

PersistenceDiagram

Struct PersistenceDiagram 

Source
pub struct PersistenceDiagram {
    pub pairs: Vec<PersistentInterval>,
}
Expand description

A persistence diagram: a collection of birth-death pairs.

Each pair represents a topological feature that appears at birth and disappears at death in a filtration.

Fields§

§pairs: Vec<PersistentInterval>

The birth-death pairs (birth, death, dimension).

Implementations§

Source§

impl PersistenceDiagram

Source

pub fn new() -> Self

Create an empty PersistenceDiagram.

Source

pub fn add(&mut self, birth: f64, death: f64, dimension: usize)

Add a birth-death pair to the diagram.

Source

pub fn from_vietoris_rips_h0(vr: &VietorisRips) -> Self

Build a persistence diagram from the 0-dimensional VR filtration.

Source

pub fn pairs_in_dim(&self, dim: usize) -> Vec<&PersistentInterval>

Filter pairs by homological dimension.

Source

pub fn max_persistence(&self) -> f64

Maximum persistence (lifetime) over all finite pairs.

Source

pub fn n_essential(&self) -> usize

Number of essential (infinite) bars.

Source

pub fn entropy(&self) -> f64

Persistence entropy of the diagram (in nats).

Source

pub fn total_persistence(&self) -> f64

Total persistence Σ (death − birth) for finite pairs.

Trait Implementations§

Source§

impl Clone for PersistenceDiagram

Source§

fn clone(&self) -> PersistenceDiagram

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PersistenceDiagram

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PersistenceDiagram

Source§

fn default() -> PersistenceDiagram

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.