Struct nalgebra::DMatrix3

pub struct DMatrix3<N> {
    // some fields omitted
}

A stack-allocated dynamically sized square or rectangular matrix with at most 3 rows and columns.

Methods

impl<N: Zero + Clone + Copy> DMatrix3<N>

fn new_zeros(nrows: usize, ncols: usize) -> DMatrix3<N>

Builds a matrix filled with zeros.

Arguments

• dimension - The dimension of the matrix. A dimension-dimensional matrix contains dimension * dimension components.

fn is_zero(&self) -> bool

Tests if all components of the matrix are zeroes.

fn reset(&mut self)

Set this matrix components to zero.

impl<N: Zero + Copy + Rand> DMatrix3<N>

fn new_random(nrows: usize, ncols: usize) -> DMatrix3<N>

Builds a matrix filled with random values.

impl<N: One + Zero + Clone + Copy> DMatrix3<N>

fn new_ones(nrows: usize, ncols: usize) -> DMatrix3<N>

Builds a matrix filled with a given constant.

impl<N> DMatrix3<N>

fn nrows(&self) -> usize

The number of row on the matrix.

fn ncols(&self) -> usize

The number of columns on the matrix.

fn as_vector(&self) -> &[N]

Gets a reference to this matrix data. The returned vector contains the matrix data in column-major order.

fn as_mut_vector(&mut self) -> &mut [N]

Gets a mutable reference to this matrix data. The returned vector contains the matrix data in column-major order.

impl<N: Zero + Clone + Copy> DMatrix3<N>

fn from_element(nrows: usize, ncols: usize, elem: N) -> DMatrix3<N>

Builds a matrix filled with a given constant.

fn from_row_vector(nrows: usize, ncols: usize, vector: &[N]) -> DMatrix3<N>

Builds a matrix filled with the components provided by a vector. The vector contains the matrix data in row-major order. Note that from_column_vector is a lot faster than from_row_vector since a $dmatrix stores its data in column-major order.

The vector must have at least nrows * ncols elements.

fn from_column_vector(nrows: usize, ncols: usize, vector: &[N]) -> DMatrix3<N>

Builds a matrix filled with the components provided by a vector. The vector contains the matrix data in column-major order. Note that from_column_vector is a lot faster than from_row_vector since a $dmatrix stores its data in column-major order.

The vector must have at least nrows * ncols elements.

fn from_fn<F: FnMut(usize, usize) -> N>(nrows: usize, ncols: usize, f: F) -> DMatrix3<N>

Builds a matrix using an initialization function.

impl<N: Copy> DMatrix3<N>

unsafe fn new_uninitialized(nrows: usize, ncols: usize) -> DMatrix3<N>

Creates a new matrix with uninitialized components (with mem::uninitialized()).

Trait Implementations

impl<N: PartialEq> PartialEq for DMatrix3<N>

fn eq(&self, other: &DMatrix3<N>) -> bool

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

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

This method tests for !=.

impl<N: Clone> Clone for DMatrix3<N>

fn clone(&self) -> DMatrix3<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: One + Zero + Clone + Copy> Eye for DMatrix3<N>

fn new_identity(dimension: usize) -> DMatrix3<N>

Builds an identity matrix.

Arguments

• dimension - The dimension of the matrix. A dimension-dimensional matrix contains dimension * dimension components.

impl<N: Copy> Indexable<(usize, usize), N> for DMatrix3<N>

unsafe fn unsafe_set(&mut self, rowcol: (usize, usize), val: N)

Just like set without bounds checking.

unsafe fn unsafe_at(&self, rowcol: (usize, usize)) -> N

Just like at without bounds checking.

fn swap(&mut self, rowcol1: (usize, usize), rowcol2: (usize, usize))

Swaps the i-th element of self with its j-th element.

impl<N> Shape<(usize, usize)> for DMatrix3<N>

fn shape(&self) -> (usize, usize)

Returns the shape of an indexable object.

impl<N> Index<(usize, usize)> for DMatrix3<N>

type Output = N

The returned type after indexing

fn index(&self, (i, j): (usize, usize)) -> &N

The method for the indexing (Foo[Bar]) operation

impl<N> IndexMut<(usize, usize)> for DMatrix3<N>

fn index_mut(&mut self, (i, j): (usize, usize)) -> &mut N

The method for the indexing (Foo[Bar]) operation

impl<N> Mul<DMatrix3<N>> for DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

type Output = DMatrix3<N>

The resulting type after applying the * operator

fn mul(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the * operator

impl<'a, N> Mul<&'a DMatrix3<N>> for DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

type Output = DMatrix3<N>

The resulting type after applying the * operator

fn mul(self, right: &'a DMatrix3<N>) -> DMatrix3<N>

The method for the * operator

impl<'a, N> Mul<DMatrix3<N>> for &'a DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

type Output = DMatrix3<N>

The resulting type after applying the * operator

fn mul(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the * operator

impl<'a, 'b, N> Mul<&'b DMatrix3<N>> for &'a DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

type Output = DMatrix3<N>

The resulting type after applying the * operator

fn mul(self, right: &DMatrix3<N>) -> DMatrix3<N>

The method for the * operator

impl<N> MulAssign<DMatrix3<N>> for DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

fn mul_assign(&mut self, right: DMatrix3<N>)

The method for the *= operator

impl<'a, N> MulAssign<&'a DMatrix3<N>> for DMatrix3<N> where N: Copy + Mul<N, Output=N> + Add<N, Output=N> + Zero

fn mul_assign(&mut self, right: &'a DMatrix3<N>)

The method for the *= operator

impl<N> Mul<DVector3<N>> for DMatrix3<N> where N: Copy + Add<N, Output=N> + Mul<N, Output=N> + Zero

type Output = DVector3<N>

The resulting type after applying the * operator

fn mul(self, right: DVector3<N>) -> DVector3<N>

The method for the * operator

impl<'a, N> Mul<DVector3<N>> for &'a DMatrix3<N> where N: Copy + Add<N, Output=N> + Mul<N, Output=N> + Zero

type Output = DVector3<N>

The resulting type after applying the * operator

fn mul(self, right: DVector3<N>) -> DVector3<N>

The method for the * operator

impl<'a, N> Mul<&'a DVector3<N>> for DMatrix3<N> where N: Copy + Add<N, Output=N> + Mul<N, Output=N> + Zero

type Output = DVector3<N>

The resulting type after applying the * operator

fn mul(self, right: &'a DVector3<N>) -> DVector3<N>

The method for the * operator

impl<'a, 'b, N> Mul<&'b DVector3<N>> for &'a DMatrix3<N> where N: Copy + Add<N, Output=N> + Mul<N, Output=N> + Zero

type Output = DVector3<N>

The resulting type after applying the * operator

fn mul(self, right: &'b DVector3<N>) -> DVector3<N>

The method for the * operator

impl<N: Copy + Add<N, Output=N>> Add<DMatrix3<N>> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the + operator

fn add(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the + operator

impl<'a, N: Copy + Add<N, Output=N>> Add<DMatrix3<N>> for &'a DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the + operator

fn add(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the + operator

impl<'a, N: Copy + Add<N, Output=N>> Add<&'a DMatrix3<N>> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the + operator

fn add(self, right: &'a DMatrix3<N>) -> DMatrix3<N>

The method for the + operator

impl<N: Copy + AddAssign<N>> AddAssign<DMatrix3<N>> for DMatrix3<N>

fn add_assign(&mut self, right: DMatrix3<N>)

The method for the += operator

impl<'a, N: Copy + AddAssign<N>> AddAssign<&'a DMatrix3<N>> for DMatrix3<N>

fn add_assign(&mut self, right: &'a DMatrix3<N>)

The method for the += operator

impl<N: Copy + Sub<N, Output=N>> Sub<N> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the - operator

fn sub(self, right: N) -> DMatrix3<N>

The method for the - operator

impl<'a, N: Copy + SubAssign<N>> SubAssign<N> for DMatrix3<N>

fn sub_assign(&mut self, right: N)

The method for the -= operator

impl<N: Copy + Sub<N, Output=N>> Sub<DMatrix3<N>> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the - operator

fn sub(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the - operator

impl<'a, N: Copy + Sub<N, Output=N>> Sub<DMatrix3<N>> for &'a DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the - operator

fn sub(self, right: DMatrix3<N>) -> DMatrix3<N>

The method for the - operator

impl<'a, N: Copy + Sub<N, Output=N>> Sub<&'a DMatrix3<N>> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the - operator

fn sub(self, right: &'a DMatrix3<N>) -> DMatrix3<N>

The method for the - operator

impl<N: Copy + SubAssign<N>> SubAssign<DMatrix3<N>> for DMatrix3<N>

fn sub_assign(&mut self, right: DMatrix3<N>)

The method for the -= operator

impl<'a, N: Copy + SubAssign<N>> SubAssign<&'a DMatrix3<N>> for DMatrix3<N>

fn sub_assign(&mut self, right: &'a DMatrix3<N>)

The method for the -= operator

impl<N: BaseNum + Clone> Inverse for DMatrix3<N>

fn inverse(&self) -> Option<DMatrix3<N>>

Returns the inverse of m.

fn inverse_mut(&mut self) -> bool

In-place version of inverse.

impl<N: Clone + Copy> Transpose for DMatrix3<N>

fn transpose(&self) -> DMatrix3<N>

Computes the transpose of a matrix.

fn transpose_mut(&mut self)

In-place version of transposed.

impl<N: BaseNum + Cast<f64> + Clone> Mean<DVector3<N>> for DMatrix3<N>

fn mean(&self) -> DVector3<N>

Computes the mean of the observations stored by v.

impl<N: BaseNum + Cast<f64> + Clone> Covariance<DMatrix3<N>> for DMatrix3<N>

fn covariance(&self) -> DMatrix3<N>

Computes the covariance of the obsevations stored by m:

fn covariance_to(&self, out: &mut M)

Computes the covariance of the obsevations stored by m:

impl<N: Copy + Zero> Column<DVector3<N>> for DMatrix3<N>

fn ncols(&self) -> usize

The number of column of this matrix or vector.

fn set_column(&mut self, column_id: usize, column: DVector3<N>)

Writes the i-th column of self.

fn column(&self, column_id: usize) -> DVector3<N>

Reads the i-th column of self.

impl<N: Copy + Clone + Zero> ColumnSlice<DVector3<N>> for DMatrix3<N>

fn column_slice(&self, column_id: usize, row_start: usize, row_end: usize) -> DVector3<N>

Returns a view to a slice of a column of a matrix.

impl<N: Copy + Zero> Row<DVector3<N>> for DMatrix3<N>

fn nrows(&self) -> usize

The number of column of self.

fn set_row(&mut self, row_id: usize, row: DVector3<N>)

Writes the i-th row of self.

fn row(&self, row_id: usize) -> DVector3<N>

Reads the i-th row of self.

impl<N: Copy> RowSlice<DVector3<N>> for DMatrix3<N>

fn row_slice(&self, row_id: usize, column_start: usize, column_end: usize) -> DVector3<N>

Returns a view to a slice of a row of a matrix.

impl<N: Copy + Clone + Zero> Diagonal<DVector3<N>> for DMatrix3<N>

fn from_diagonal(diagonal: &DVector3<N>) -> DMatrix3<N>

Creates a new matrix with the given diagonal.

fn diagonal(&self) -> DVector3<N>

The diagonal of this matrix.

impl<N: ApproxEq<N>> ApproxEq<N> for DMatrix3<N>

fn approx_epsilon() -> N

Default epsilon for approximation.

fn approx_ulps() -> u32

Default ULPs for approximation.

fn approx_eq_eps(&self, other: &DMatrix3<N>, epsilon: &N) -> bool

Tests approximate equality using a custom epsilon.

fn approx_eq_ulps(&self, other: &DMatrix3<N>, ulps: u32) -> bool

Tests approximate equality using units in the last place (ULPs)

fn approx_eq(&self, other: &Self) -> bool

Tests approximate equality.

impl<N: Debug + Copy> Debug for DMatrix3<N>

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

Formats the value using the given formatter.

impl<N: Copy + Mul<N, Output=N>> Mul<N> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the * operator

fn mul(self, right: N) -> DMatrix3<N>

The method for the * operator

impl<N: Copy + Div<N, Output=N>> Div<N> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the / operator

fn div(self, right: N) -> DMatrix3<N>

The method for the / operator

impl<N: Copy + Add<N, Output=N>> Add<N> for DMatrix3<N>

type Output = DMatrix3<N>

The resulting type after applying the + operator

fn add(self, right: N) -> DMatrix3<N>

The method for the + operator