Struct pathfinding::Matrix

pub struct Matrix<C> {
    pub rows: usize,
    pub columns: usize,
    // some fields omitted
}

Matrix of an arbitrary type. Data are stored consecutively in memory, by rows. Raw data can be accessed using as_ref() or as_mut().

Fields

rows: usize

Rows

columns: usize

Columns

Methods

impl<C: Clone> Matrix<C>

fn new(rows: usize, columns: usize, value: C) -> Matrix<C>

Create new matrix with an initial value.

fn new_square(size: usize, value: C) -> Matrix<C>

Create new square matrix with initial value.

fn fill(&mut self, value: C)

Fill with a known value.

fn slice(&self, rows: Range<usize>, columns: Range<usize>) -> Matrix<C>

Return a copy of a sub-matrix.

fn rotated_cw(&self, times: usize) -> Matrix<C>

Return a copy of a square matrix rotated clock-wise a number of times.

Panics

This function panics if the matrix is not square.

fn rotated_ccw(&self, times: usize) -> Matrix<C>

Return a copy of a square matrix rotated counter-clock-wise a number of times.

Panics

This function panics if the matrix is not square.

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

Return a copy of the matrix flipped along the vertical axis.

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

Return a copy of the matrix flipped along the horizontal axis.

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

Return a copy of the matrix after transposition.

impl<C: Copy> Matrix<C>

fn set_slice(&mut self, pos: &(usize, usize), slice: &Matrix<C>)

Replace a slice of the current matrix with the content of another one.

impl<C> Matrix<C>

fn from_vec(rows: usize, columns: usize, values: Vec<C>) -> Matrix<C>

Create new matrix from vector values. The first value will be assigned to index (0, 0), the second one to index (0, 1), and so on.

Panics

This function will panic if the number of values does not correspond to the announced size.

fn square_from_vec(values: Vec<C>) -> Matrix<C>

Create new square matrix from vector values. The first value will be assigned to index (0, 0), the second one to index (0, 1), and so on.

Panics

This function will panic if the number of values is not a square number.

fn is_square(&self) -> bool

Check if a matrix is a square one.

fn idx(&self, i: &(usize, usize)) -> usize

Index in raw data of a given position.

fn flip_lr(&mut self)

Flip the matrix around the vertical axis.

fn flip_ud(&mut self)

Flip the matrix around the horizontal axis.

fn rotate_cw(&mut self, times: usize)

Rotate a square matrix clock-wise a number of times.

Panics

This function panics if the matrix is not square.

fn rotate_ccw(&mut self, times: usize)

Rotate a square matrix counter-clock-wise a number of times.

Panics

This function panics if the matrix is not square.

Trait Implementations

impl<C: Copy> Weights<C> for Matrix<C>

fn rows(&self) -> usize

Return the number of rows.

fn columns(&self) -> usize

Return the number of columns.

fn at(&self, row: usize, col: usize) -> C

Return the element at position.

fn neg(&self) -> Self where
    C: Signed, 

Return the negated weights.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<C: Eq> Eq for Matrix<C>

impl<C: Hash> Hash for Matrix<C>

fn hash<__HC: Hasher>(&self, __arg_0: &mut __HC)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

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

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Matrix<C>) -> bool

This method tests for !=.

impl<C: Send> Send for Matrix<C>

impl<C: Clone + Signed> Neg for Matrix<C>

type Output = Matrix<C>

The resulting type after applying the - operator.

fn neg(self) -> Matrix<C>

Performs the unary - operation.

impl<'a, C> Index<&'a (usize, usize)> for Matrix<C>

type Output = C

The returned type after indexing.

fn index(&self, index: &'a (usize, usize)) -> &C

Performs the indexing (container[index]) operation.

impl<'a, C> IndexMut<&'a (usize, usize)> for Matrix<C>

fn index_mut(&mut self, index: &'a (usize, usize)) -> &mut C

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

impl<C> AsRef<[C]> for Matrix<C>

fn as_ref(&self) -> &[C]

Performs the conversion.

impl<C> AsMut<[C]> for Matrix<C>

fn as_mut(&mut self) -> &mut [C]

Performs the conversion.