Skip to main content

VietorisRipsComplex

Struct VietorisRipsComplex 

Source
pub struct VietorisRipsComplex {
    pub points: Vec<Vec<f64>>,
    pub epsilon: f64,
    pub simplices: Vec<Vec<usize>>,
}
Expand description

A Vietoris-Rips simplicial complex at a fixed scale epsilon.

Unlike VietorisRips (which computes the full persistent homology across all scales), this struct stores the explicit list of simplices formed when all pairwise distances ≤ epsilon.

§Example

use scirs2_transform::tda_ext::VietorisRipsComplex;

let pts = vec![
    vec![0.0, 0.0],
    vec![1.0, 0.0],
    vec![1.0, 1.0],
    vec![0.0, 1.0],
];
let vrc = VietorisRipsComplex::new(&pts, 1.5).expect("should succeed");
assert!(vrc.n_simplices(0) == 4); // four 0-simplices (vertices)
assert!(vrc.euler_characteristic() != 0); // non-trivial topology

Fields§

§points: Vec<Vec<f64>>

Input point cloud

§epsilon: f64

Scale parameter (all edges with length ≤ epsilon are included)

§simplices: Vec<Vec<usize>>

All simplices (sorted by dimension then by vertex tuple)

Implementations§

Source§

impl VietorisRipsComplex

Source

pub fn new(points: &[Vec<f64>], epsilon: f64) -> Result<Self>

Construct the Vietoris-Rips complex for the given point cloud at scale epsilon.

Only simplices up to dimension 2 (triangles) are computed for tractability.

§Arguments
  • points — slice of point vectors (all of equal length)
  • epsilon — maximum edge length to include
Source

pub fn n_simplices(&self, dim: usize) -> usize

Count the number of simplices of a given dimension.

Dimension 0 = vertices, 1 = edges, 2 = triangles.

Source

pub fn euler_characteristic(&self) -> i64

Compute the Euler characteristic χ = Σ_k (-1)^k * C_k, where C_k is the number of k-simplices.

Source

pub fn are_connected(&self, u: usize, v: usize) -> bool

Check whether two vertices are connected by an edge in the complex.

Source

pub fn edges(&self) -> Vec<(usize, usize)>

List all edges (1-simplices) as pairs (u, v).

Trait Implementations§

Source§

impl Clone for VietorisRipsComplex

Source§

fn clone(&self) -> VietorisRipsComplex

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VietorisRipsComplex

Source§

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

Formats the value using the given formatter. 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> 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<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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V