Struct Matrix

pub struct Matrix<C> {
    pub values: Vec<C>,
    pub dimensions: MatrixDimensions,
}

Two-dimensional matrix.

Fields

values: Vec<C>

Matrix values as a single vector.

dimensions: MatrixDimensions

Matrix dimensions.

Implementations

impl<C> Matrix<C>

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

Get the vector index based on a set of coordinates.

pub fn slice<R: Into<MatrixRange>>( &self, range: R, ) -> Result<MatrixSlice<'_, C>, MatrixSliceError>

Slice this matrix to these rows and columns.

Trait Implementations

impl<C: Clone> Clone for Matrix<C>

fn clone(&self) -> Matrix<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Matrix<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for Matrix<C>

fn default() -> Matrix<C>

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for Matrix<C>

where Matrix<C>: Default, C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Domain2D for Matrix<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<C> Matrix2D<C> for Matrix<C>

fn new(values: Vec<C>, n_cols: usize) -> Result<Self, MatrixDimensionError>

Create a new matrix from this value slice with the given number of columns in a row.

impl<C> MatrixMut<C> for Matrix<C>

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

Set a certain cell’s value. Coordinates should be row and column indices with respect to the source matrix.

impl<C> MatrixRef<C> for Matrix<C>

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

Get a matrix value at these coordinates. Coordinates should be row and column indices with respect to the source matrix.

impl<C: PartialEq> PartialEq for Matrix<C>

fn eq(&self, other: &Matrix<C>) -> bool

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

const 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<C> Serialize for Matrix<C>

where C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> StructuralPartialEq for Matrix<C>