Trait vectrix::MatrixIndex

pub unsafe trait MatrixIndex<T: ?Sized>: Sealed {
    type Output: ?Sized;

    fn get(self, matrix: &T) -> Option<&Self::Output>;
    fn get_mut(self, matrix: &mut T) -> Option<&mut Self::Output>;
    unsafe fn get_unchecked(self, matrix: *const T) -> *const Self::Output;
    unsafe fn get_unchecked_mut(self, stride: *mut T) -> *mut Self::Output;
    fn index(self, stride: &T) -> &Self::Output;
    fn index_mut(self, stride: &mut T) -> &mut Self::Output;
}

A helper trait used for indexing operations.

This is the Matrix version of SliceIndex. You should not use or implement this trait directly but instead use the corresponding methods on Matrix.

Safety

Implementations of this trait have to promise that if the argument to get_(mut_)unchecked is a safe reference, then so is the result.

Required Associated Types

type Output: ?Sized

The output type returned by methods.

Required Methods

fn get(self, matrix: &T) -> Option<&Self::Output>

Returns a shared reference to the output at this location, if in bounds.

fn get_mut(self, matrix: &mut T) -> Option<&mut Self::Output>

Returns a mutable reference to the output at this location, if in bounds.

unsafe fn get_unchecked(self, matrix: *const T) -> *const Self::Output

Returns a shared reference to the output at this location, without performing any bounds checking.

Safety

Calling this method with an out-of-bounds index or a dangling matrix pointer is undefined behavior even if the resulting reference is not used.

unsafe fn get_unchecked_mut(self, stride: *mut T) -> *mut Self::Output

Returns a mutable reference to the output at this location, without performing any bounds checking.

Safety

Calling this method with an out-of-bounds index or a dangling matrix pointer is undefined behavior even if the resulting reference is not used.

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

Returns a shared reference to the output at this location, panicking if out of bounds.

fn index_mut(self, stride: &mut T) -> &mut Self::Output

Returns a mutable reference to the output at this location, panicking if out of bounds.

Implementations on Foreign Types

impl<T, const M: usize, const N: usize> MatrixIndex<Matrix<T, M, N>> for usize

type Output = T

fn get(self, matrix: &Matrix<T, M, N>) -> Option<&Self::Output>

fn get_mut(self, matrix: &mut Matrix<T, M, N>) -> Option<&mut Self::Output>

unsafe fn get_unchecked(
    self,
    matrix: *const Matrix<T, M, N>
) -> *const Self::Output

unsafe fn get_unchecked_mut(
    self,
    matrix: *mut Matrix<T, M, N>
) -> *mut Self::Output

fn index(self, matrix: &Matrix<T, M, N>) -> &Self::Output

fn index_mut(self, matrix: &mut Matrix<T, M, N>) -> &mut Self::Output

impl<T, const M: usize, const N: usize> MatrixIndex<Matrix<T, M, N>> for (usize, usize)

type Output = T

fn get(self, matrix: &Matrix<T, M, N>) -> Option<&Self::Output>

fn get_mut(self, matrix: &mut Matrix<T, M, N>) -> Option<&mut Self::Output>

unsafe fn get_unchecked(
    self,
    matrix: *const Matrix<T, M, N>
) -> *const Self::Output

unsafe fn get_unchecked_mut(
    self,
    matrix: *mut Matrix<T, M, N>
) -> *mut Self::Output

fn index(self, matrix: &Matrix<T, M, N>) -> &Self::Output

fn index_mut(self, matrix: &mut Matrix<T, M, N>) -> &mut Self::Output

Implementors