Struct rulinalg::matrix::Column

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

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);

Methods from Deref<Target = MatrixSlice<'a, T>>

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 a point in the matrix without bounds checking.

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

Important traits for SliceIter<'a, T>

impl<'a, T> Iterator for SliceIter<'a, T> type Item = &'a T;

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

Returns an iterator over the matrix data.

Important traits for Cols<'a, T>

impl<'a, T> Iterator for Cols<'a, T> type Item = Column<'a, T>;

fn col_iter(&self) -> Cols<T>

Iterate over the columns of the matrix.

Important traits for Rows<'a, T>

impl<'a, T> Iterator for Rows<'a, T> type Item = Row<'a, T>;

fn row_iter(&self) -> Rows<T>

Iterate over the rows of the matrix.

Important traits for Diagonal<'a, T, M>

impl<'a, T, M: BaseMatrix<T>> Iterator for Diagonal<'a, T, M> type Item = &'a T;

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

Iterate over diagonal entries

fn sum_rows(&self) -> Vector<T> where
    T: Copy + Zero + Add<T, Output = T>, 

The sum of the rows of the matrix.

fn sum_cols(&self) -> Vector<T> where
    T: Copy + Zero + Add<T, Output = T>, 

The sum of the columns of the matrix.

fn norm<N: MatrixNorm<T, Self>>(&self, norm: N) -> T where
    T: Float, 

Compute given matrix norm for matrix.

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

Compute the metric distance between two matrices.

fn sum(&self) -> T where
    T: Copy + Zero + Add<T, Output = T>, 

The sum of all elements in the matrix

fn min(&self, axis: Axes) -> Vector<T> where
    T: Copy + PartialOrd, 

The min of the specified axis of the matrix.

fn max(&self, axis: Axes) -> Vector<T> where
    T: Copy + PartialOrd, 

The max of the specified axis of the matrix.

fn into_matrix(self) -> Matrix<T> where
    T: Copy, 

Convert the matrix struct into a owned Matrix.

fn select_rows<'a, I>(&self, rows: I) -> Matrix<T> where
    T: Copy,
    I: IntoIterator<Item = &'a usize>,
    I::IntoIter: ExactSizeIterator + Clone, 

Select rows from matrix

fn select_cols<'a, I>(&self, cols: I) -> Matrix<T> where
    T: Copy,
    I: IntoIterator<Item = &'a usize>,
    I::IntoIter: ExactSizeIterator + Clone, 

Select columns from matrix

fn elemul(&self, m: &Self) -> Matrix<T> where
    T: Copy + Mul<T, Output = T>, 

The elementwise product of two matrices.

fn elediv(&self, m: &Self) -> Matrix<T> where
    T: Copy + Div<T, Output = T>, 

The elementwise division of two matrices.

fn select(&self, rows: &[usize], cols: &[usize]) -> Matrix<T> where
    T: Copy, 

Select block matrix from matrix

fn hcat<S>(&self, m: &S) -> Matrix<T> where
    T: Copy,
    S: BaseMatrix<T>, 

Horizontally concatenates two matrices. With self on the left.

fn vcat<S>(&self, m: &S) -> Matrix<T> where
    T: Copy,
    S: BaseMatrix<T>, 

Vertically concatenates two matrices. With self on top.

Important traits for Diagonal<'a, T, M>

impl<'a, T, M: BaseMatrix<T>> Iterator for Diagonal<'a, T, M> type Item = &'a T;

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

Extract the diagonal of the matrix

fn transpose(&self) -> Matrix<T> where
    T: Copy, 

Tranposes the given matrix

fn is_diag(&self) -> bool where
    T: Zero + PartialEq, 

Checks if matrix is diagonal.

fn solve_u_triangular(&self, y: Vector<T>) -> Result<Vector<T>, Error> where
    T: Any + Float, 

Solves an upper triangular linear system.

fn solve_l_triangular(&self, y: Vector<T>) -> Result<Vector<T>, Error> where
    T: Any + Float, 

Solves a lower triangular linear system.

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.

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

Performs copy-assignment from source.

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

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

Performs the conversion.

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

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> 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: Debug + 'a> Debug for Column<'a, T>

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

Formats the value using the given formatter.