Skip to main content

FilteredSimplicialComplex

holos_tda::filtration

Struct FilteredSimplicialComplex 

Source 
pub struct FilteredSimplicialComplex<G> { /* private fields */ }
Expand description

A finite explicit filtered simplicial complex.

Vertex labels are stable keys. Every nonempty face must occur exactly once, and each face grade must precede the grade of its cofaces.

Implementations§

Source§

impl FilteredSimplicialComplex<ScalarGrade>

Source

pub fn from_flag_graph( input: &SparseDistanceMatrix, labels: &[usize], params: FlagComplexParams, ) -> Result<Self, FiltrationError>

Materialize the flag complex of a sparse graph with stable labels.

Source§

impl<G: FiltrationGrade> FilteredSimplicialComplex<G>

Source

pub fn new( vertex_labels: Vec<usize>, simplices: Vec<Vec<FilteredSimplex<G>>>, ) -> Result<Self, FiltrationError>

Construct a checked explicit complex grouped by simplex dimension.

Source

pub fn vertex_labels(&self) -> &[usize]

Stable labels of all vertices in this complex.

Source

pub fn max_dimension(&self) -> usize

Highest stored simplex dimension, including a trailing empty group.

Source

pub fn simplices(&self) -> &[Vec<FilteredSimplex<G>>]

Simplices grouped by dimension and ordered by vertex key.

Source

pub fn simplex_count(&self) -> usize

Number of stored simplices in all dimensions.

Source

pub fn project<P: ScalarProjection<G>>( &self, projection: &P, ) -> Result<FilteredSimplicialComplex<ScalarGrade>, FiltrationError>

Apply a scalar projection and check the resulting filtration.

Trait Implementations§

Source§

impl<G: Clone> Clone for FilteredSimplicialComplex<G>

Source§

fn clone(&self) -> FilteredSimplicialComplex<G>

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<G: Debug> Debug for FilteredSimplicialComplex<G>

Source§

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

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

impl<G: Eq> Eq for FilteredSimplicialComplex<G>

Source§

impl<G: PartialEq> PartialEq for FilteredSimplicialComplex<G>

Source§

fn eq(&self, other: &FilteredSimplicialComplex<G>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<G: PartialEq> StructuralPartialEq for FilteredSimplicialComplex<G>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.