Struct ratio_matrix::MatrixSlice

pub struct MatrixSlice<'a, C> {
    pub values: &'a [C],
    pub input_dimensions: MatrixDimensions,
    pub view_range: MatrixRange,
}

Slice of a matrix.

Fields

values: &'a [C]

Input matrix values as a single slice reference.

input_dimensions: MatrixDimensions

Dimensions of the input data.

view_range: MatrixRange

Slice or view range with respect to the input data.

Implementations

impl<'a, C> MatrixSlice<'a, C>

pub fn new<R: Into<MatrixRange>>( values: &'a [C], n_cols: usize, range: R, ) -> Result<Self, MatrixSliceError>

Create a new slice from a matrix. Takes a reference to the input values’ slice and the number of columns in each row as well as the intended range of the slice.

pub fn index<T: Into<MatrixCoordinates>>( &self, coordinates: T, ) -> Result<usize, CoordinatesOutOfBoundsError>

Get the index for item access in the reference slice. The provided coordinates should be with respect to the slice’s start!

impl<'a, C> MatrixSlice<'a, C>

where C: Clone + Default,

pub fn to_matrix(&self) -> Matrix<C>

Clone the data into this slice into a matrix of it’s own size.

Trait Implementations

impl<'a, C: Clone> Clone for MatrixSlice<'a, C>

fn clone(&self) -> MatrixSlice<'a, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, C: Debug> Debug for MatrixSlice<'a, C>

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

Formats the value using the given formatter.

impl<'a, C: Default> Default for MatrixSlice<'a, C>

fn default() -> MatrixSlice<'a, C>

Returns the “default value” for a type.

impl<'a, C> Domain2D for MatrixSlice<'a, C>

fn row_range(&self) -> Range<usize>

Range of rows included in this object’s domain.

fn col_range(&self) -> Range<usize>

Range of columns included in this object’s domain.

fn range(&self) -> MatrixRange

The area spanned by this domain.

fn start(&self) -> MatrixCoordinates

Starting coordinate of this domain (inclusive).

fn end(&self) -> MatrixCoordinates

Ending coordinate of this domain (exclusive).

fn middle(&self) -> (f64, f64)

The middle point of this cluster as a tuple of (rows, columns), fractional.

impl<'a, C> MatrixRef<C> for MatrixSlice<'a, C>

fn get<T: Into<MatrixCoordinates>>( &self, coordinates: T, ) -> Result<&C, CoordinatesOutOfBoundsError>

Get a matrix value at this coordinate.

impl<'a, C: PartialEq> PartialEq for MatrixSlice<'a, C>

fn eq(&self, other: &MatrixSlice<'a, C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, C> StructuralPartialEq for MatrixSlice<'a, C>