Enum MatrixLocation

pub enum MatrixLocation {
    Row(usize),
    Col(usize),
    Coordinates(MatrixCoordinates),
    Range(MatrixRange),
}

Location in a 2D matrix.

Variants

Row(usize)

Entire row in a matrix.

Col(usize)

Entire column in a matrix.

Coordinates(MatrixCoordinates)

Specific coordinates in a matrix.

Range(MatrixRange)

2D area in a matrix.

Implementations

impl MatrixLocation

pub fn from_coords(row: Option<usize>, col: Option<usize>) -> Option<Self>

Create a new optional location from an optional row and column coordinate.

pub fn row(&self) -> Option<usize>

Row or starting row of this location.

pub fn col(&self) -> Option<usize>

Column or starting column of this location.

Trait Implementations

impl Add<MatrixCoordinates> for MatrixLocation

type Output = MatrixLocation

The resulting type after applying the + operator.

fn add(self, rhs: MatrixCoordinates) -> Self::Output

Performs the + operation.

impl Add for MatrixLocation

type Output = MatrixLocation

The resulting type after applying the + operator.

fn add(self, rhs: MatrixLocation) -> Self::Output

Performs the + operation.

impl AddAssign<MatrixCoordinates> for MatrixLocation

fn add_assign(&mut self, rhs: MatrixCoordinates)

Performs the += operation.

impl AddAssign for MatrixLocation

fn add_assign(&mut self, rhs: MatrixLocation)

Performs the += operation.

impl Clone for MatrixLocation

fn clone(&self) -> MatrixLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MatrixLocation

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

Formats the value using the given formatter.

impl Default for MatrixLocation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MatrixLocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Domain2D for MatrixLocation

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 From<MatrixCoordinates> for MatrixLocation

fn from(value: MatrixCoordinates) -> Self

Converts to this type from the input type.

impl From<MatrixRange> for MatrixLocation

fn from(value: MatrixRange) -> Self

Converts to this type from the input type.

impl PartialEq for MatrixLocation

fn eq(&self, other: &MatrixLocation) -> 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 Serialize for MatrixLocation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<MatrixCoordinates> for MatrixLocation

type Output = MatrixLocation

The resulting type after applying the - operator.

fn sub(self, rhs: MatrixCoordinates) -> Self::Output

Performs the - operation.

impl Sub for MatrixLocation

type Output = MatrixLocation

The resulting type after applying the - operator.

fn sub(self, rhs: MatrixLocation) -> Self::Output

Performs the - operation.

impl SubAssign<MatrixCoordinates> for MatrixLocation

fn sub_assign(&mut self, rhs: MatrixCoordinates)

Performs the -= operation.

impl SubAssign for MatrixLocation

fn sub_assign(&mut self, rhs: MatrixLocation)

Performs the -= operation.

impl Copy for MatrixLocation

impl StructuralPartialEq for MatrixLocation