Struct rulinalg::matrix::Column

pub struct Column<'a, T: 'a> { /* private fields */ }

Column of a matrix.

This struct points to a MatrixSlice making up a column in a matrix. You can deref this struct to retrieve the raw column MatrixSlice.

Example

use rulinalg::matrix::BaseMatrix;

let mat = matrix![1.0, 2.0;
                  3.0, 4.0];

let col = mat.col(1);
assert_eq!((*col + 2.0).sum(), 10.0);

Implementations

impl<'a, T> Column<'a, T>where
    T: Clone,

pub fn clone_into_slice(&self, slice: &mut [T])

Clones the elements of this column into a slice of compatible size.

Panics

• The slice does not have the same length as the number of rows in the column.

Trait Implementations

impl<'a, T> BaseMatrix<T> for Column<'a, T>

fn rows(&self) -> usize

Rows in the matrix.

fn cols(&self) -> usize

Columns in the matrix.

fn row_stride(&self) -> usize

Row stride in the matrix.

fn as_ptr(&self) -> *const T

Top left index of the matrix.

fn is_empty(&self) -> bool

Returns true if the matrix contais no elements

fn as_slice(&self) -> MatrixSlice<'_, T>

Returns a MatrixSlice over the whole matrix.

unsafe fn get_unchecked(&self, index: [usize; 2]) -> &T

Get a reference to an element in the matrix without bounds checking.

fn get(&self, index: [usize; 2]) -> Option<&T>

Get a reference to an element in the matrix.

fn col(&self, index: usize) -> Column<'_, T>

Returns the column of a matrix at the given index. None if the index is out of bounds.

unsafe fn col_unchecked(&self, index: usize) -> Column<'_, T>

Returns the column of a matrix at the given index without doing a bounds check.

fn row(&self, index: usize) -> Row<'_, T>

Returns the row of a matrix at the given index.

unsafe fn row_unchecked(&self, index: usize) -> Row<'_, T>

Returns the row of a matrix at the given index without doing unbounds checking

fn iter<'a>(&self) -> SliceIter<'a, T>where
    T: 'a,

Returns an iterator over the matrix data.

fn col_iter(&self) -> Cols<'_, T>

Iterate over the columns of the matrix.

fn row_iter(&self) -> Rows<'_, T>

Iterate over the rows of the matrix.

fn diag_iter(&self, k: DiagOffset) -> Diagonal<'_, T, Self>

Iterate over diagonal entries

fn metric<'a, 'b, B, M>(&'a self, mat: &'b B, metric: M) -> Twhere
    B: 'b + BaseMatrix<T>,
    M: MatrixMetric<'a, 'b, T, Self, B>,

Compute the metric distance between two matrices.

fn diag(&self) -> Diagonal<'_, T, Self>

Extract the diagonal of the matrix

fn split_at(
    &self,
    mid: usize,
    axis: Axes
) -> (MatrixSlice<'_, T>, MatrixSlice<'_, T>)

Split the matrix at the specified axis returning two MatrixSlices.

fn sub_slice<'a>(
    &self,
    start: [usize; 2],
    rows: usize,
    cols: usize
) -> MatrixSlice<'a, T>where
    T: 'a,

Produce a MatrixSlice from an existing matrix.

impl<'a, T: Clone + 'a> Clone for Column<'a, T>

fn clone(&self) -> Column<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + 'a> Debug for Column<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: 'a> Deref for Column<'a, T>

type Target = MatrixSlice<'a, T>

The resulting type after dereferencing.

fn deref(&self) -> &MatrixSlice<'a, T>

Dereferences the value.

impl<'a, T: Clone> From<Column<'a, T>> for Vector<T>

fn from(column: Column<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> Index<usize> for Column<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, idx: usize) -> &T

Performs the indexing (container[index]) operation.

impl<'a, T: Copy + 'a> Copy for Column<'a, T>