Struct MatrixAddress 

pub struct MatrixAddress<I>
where
    I: Coordinate,
{
    pub row: I,
    pub column: I,
}

MatrixAddress references a cell in a matrix by its row and column. Rows are numbered from zero at the top, and columns are numbered from zero at the left. Thus (0, 0), the origin, is positioned at the upper-left of the matrix. Any built in numeric or character type that fits in usize can be used as the index (thus in practice up to i16 / u16).

Fields

row: I

column: I

Implementations

impl<I> MatrixAddress<I>

where I: Coordinate,

pub fn neighbors<'a, T>( &self, matrix: &dyn Matrix<'a, T, I>, ) -> Vec<MatrixAddress<I>>

where T: 'static, I: Coordinate,

pub fn transpose(&self) -> MatrixAddress<I>

Trait Implementations

impl<I> Add for MatrixAddress<I>

where I: Coordinate,

type Output = MatrixAddress<I>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<I> Clone for MatrixAddress<I>

where I: Coordinate + Clone,

fn clone(&self) -> MatrixAddress<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I> Debug for MatrixAddress<I>

where I: Coordinate + Debug,

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

Formats the value using the given formatter.

impl<I> Default for MatrixAddress<I>

where I: Coordinate,

fn default() -> Self

Returns the “default value” for a type.

impl<I> Display for MatrixAddress<I>

where I: Coordinate,

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

Formats the value using the given formatter.

impl<I> From<[I; 2]> for MatrixAddress<I>

where I: Coordinate,

fn from(value: [I; 2]) -> Self

Converts to this type from the input type.

impl<I> From<MatrixAddress<I>> for [I; 2]

where I: Coordinate,

fn from(value: MatrixAddress<I>) -> Self

Converts to this type from the input type.

impl<I> Hash for MatrixAddress<I>

where I: Coordinate + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> Index<LogicalDimension> for MatrixAddress<I>

where I: Coordinate,

type Output = I

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T, I> Index<MatrixAddress<I>> for DenseMatrix<T, I>

where I: Coordinate,

type Output = T

The returned type after indexing.

fn index(&self, index: MatrixAddress<I>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I> Index<usize> for MatrixAddress<I>

where I: Coordinate,

type Output = I

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, I> IndexMut<MatrixAddress<I>> for DenseMatrix<T, I>

where I: Coordinate,

fn index_mut(&mut self, index: MatrixAddress<I>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<I> Ord for MatrixAddress<I>

where I: Coordinate + Ord,

fn cmp(&self, other: &MatrixAddress<I>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<I> PartialEq for MatrixAddress<I>

where I: Coordinate + PartialEq,

fn eq(&self, other: &MatrixAddress<I>) -> 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<I> PartialOrd for MatrixAddress<I>

where I: Coordinate + PartialOrd,

fn partial_cmp(&self, other: &MatrixAddress<I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I> Sub for MatrixAddress<I>

where I: Coordinate,

type Output = MatrixAddress<I>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T: 'a, I> Tensor<T, I, MatrixAddress<I>, 2> for DenseMatrix<T, I>

where I: Coordinate,

fn range(&self) -> Range<MatrixAddress<I>>

range provides the bounds of the address space for the Tensor. The lower (inclusive bound) is the origin, conceptually placed at the left of a vector, the upper left of a matrix, and so on. That lower bound is conventionally zero-based, but does not have to be. The upper bound (exclusive) is the right side of the vector, the lower right of the matrix, etc. Be aware that while Range provides iterator functionality, once you move beyond single-dimension Tensors, that iterator does not provide the correct iteration of available addresses.

fn get(&self, address: MatrixAddress<I>) -> Option<&T>

An out-of-range-safe version of the Index trait.

fn get_mut(&mut self, address: MatrixAddress<I>) -> Option<&mut T>

An out-of-range-safe version of the IndexMut trait.

fn contains(&self, address: A) -> bool

contains is true if the given address is within the Tensor’s bounds for all dimensions.

impl<I> Address<I, 2> for MatrixAddress<I>

where I: Coordinate,

impl<I> Copy for MatrixAddress<I>

where I: Coordinate + Copy,

impl<I> Eq for MatrixAddress<I>

where I: Coordinate + Eq,

impl<I> StructuralPartialEq for MatrixAddress<I>

where I: Coordinate,