Struct lightmotif::dense::DenseMatrix

pub struct DenseMatrix<T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo = DefaultAlignment> { /* private fields */ }

A memory-aligned dense matrix with a constant number of columns.

Implementations

impl<T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> DenseMatrix<T, C, A>

pub fn new(rows: usize) -> Self

Create a new matrix with the given number of rows.

pub unsafe fn uninitialized(rows: usize) -> Self

Create a new uninitialized matrix with the given number of rows.

pub fn from_rows<I>(rows: I) -> Self

where I: IntoIterator, <I as IntoIterator>::Item: AsRef<[T]>, <I as IntoIterator>::IntoIter: ExactSizeIterator,

Create a new dense matrix from an iterable of rows.

Panics

Panics if any of the rows does not have the number of elements corresponding to the dense matrix columns.

pub const fn columns(&self) -> usize

The number of columns of the matrix.

pub const fn stride(&self) -> usize

The stride of the matrix, as a number of elements.

This may be different from the number of columns to account for memory alignment constraints. Multiply by std::mem::size_of::<T>() to obtain the stride in bytes.

Example

let d = DenseMatrix::<u8, U43, U32>::new(0);
assert_eq!(d.stride(), 64);

pub const fn rows(&self) -> usize

The number of rows of the matrix.

pub fn resize(&mut self, rows: usize)

Change the number of rows of the matrix.

pub fn iter(&self) -> Iter<'_, T, C, A>

Iterate over the rows of the matrix.

pub fn iter_mut(&mut self) -> IterMut<'_, T, C, A>

Returns an iterator that allows modifying each row.

pub fn fill(&mut self, value: T)

Fill the entire matrix with a constant value.

Trait Implementations

impl<C: StrictlyPositive> AsMut<DenseMatrix<f32, C>> for StripedScores<C>

fn as_mut(&mut self) -> &mut DenseMatrix<f32, C>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<A: Alphabet, C: StrictlyPositive> AsRef<DenseMatrix<<A as Alphabet>::Symbol, C>> for StripedSequence<A, C>

fn as_ref(&self) -> &DenseMatrix<A::Symbol, C>

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Alphabet> AsRef<DenseMatrix<f32, <A as Alphabet>::K>> for FrequencyMatrix<A>

fn as_ref(&self) -> &DenseMatrix<f32, A::K>

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Alphabet> AsRef<DenseMatrix<f32, <A as Alphabet>::K>> for ScoringMatrix<A>

fn as_ref(&self) -> &DenseMatrix<f32, A::K>

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Alphabet> AsRef<DenseMatrix<f32, <A as Alphabet>::K>> for WeightMatrix<A>

fn as_ref(&self) -> &DenseMatrix<f32, A::K>

Converts this type into a shared reference of the (usually inferred) input type.

impl<C: StrictlyPositive> AsRef<DenseMatrix<f32, C>> for StripedScores<C>

fn as_ref(&self) -> &DenseMatrix<f32, C>

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Alphabet> AsRef<DenseMatrix<u32, <A as Alphabet>::K>> for CountMatrix<A>

fn as_ref(&self) -> &DenseMatrix<u32, A::K>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + Default + Copy, C: Clone + Unsigned, A: Clone + Unsigned + PowerOfTwo> Clone for DenseMatrix<T, C, A>

fn clone(&self) -> DenseMatrix<T, C, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default + Copy + Debug, C: Unsigned, A: Unsigned + PowerOfTwo> Debug for DenseMatrix<T, C, A>

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

Formats the value using the given formatter.

impl<A: Alphabet, C: StrictlyPositive> From<StripedSequence<A, C>> for DenseMatrix<A::Symbol, C>

fn from(striped: StripedSequence<A, C>) -> Self

Converts to this type from the input type.

impl<T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> Index<MatrixCoordinates> for DenseMatrix<T, C, A>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> Index<usize> for DenseMatrix<T, C, A>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> IndexMut<usize> for DenseMatrix<T, C, A>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl<'a, T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> IntoIterator for &'a DenseMatrix<T, C, A>

type Item = &'a [T]

The type of the elements being iterated over.

type IntoIter = Iter<'a, T, C, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Default + Copy, C: Unsigned, A: Unsigned + PowerOfTwo> IntoIterator for &'a mut DenseMatrix<T, C, A>

type Item = &'a mut [T]

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T, C, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Default + Copy + PartialEq, C: Unsigned, A: Unsigned + PowerOfTwo> PartialEq for DenseMatrix<T, C, A>

fn eq(&self, other: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq + Default + Copy, C: Eq + Unsigned, A: Eq + Unsigned + PowerOfTwo> Eq for DenseMatrix<T, C, A>