Struct DistanceMatrix

pub struct DistanceMatrix { /* private fields */ }

A matrix representing the distances between pairs of items.

Implementations

impl DistanceMatrix

pub fn try_from_square( matrix: Vec<Vec<f64>>, ) -> Result<Self, DistanceMatrixError>

Create a new DistanceMatrix from a square matrix.

Errors

Returns an error if the input matrix is not square.

pub fn into_inner(self) -> Vec<Vec<f64>>

Consumes the DistanceMatrix and returns the inner matrix.

pub fn iter(&self) -> DistanceMatrixIter<'_>

Returns an iterator over the rows of the matrix.

pub fn shape(&self) -> (usize, usize)

Returns the shape of the matrix.

The first element is the number of rows and the second element is the number of columns.

The matrix is square, so the number of rows is equal to the number of columns and the number of input series.

Trait Implementations

impl Clone for DistanceMatrix

fn clone(&self) -> DistanceMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceMatrix

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

Formats the value using the given formatter.

impl Index<(usize, usize)> for DistanceMatrix

type Output = f64

The returned type after indexing.

fn index(&self, (i, j): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for DistanceMatrix

type Output = [f64]

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoIterator for DistanceMatrix

type Item = Vec<f64>

The type of the elements being iterated over.

type IntoIter = IntoIter<<DistanceMatrix as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.