Struct noises_and_patterns::prelude::ArrayStorage

pub struct ArrayStorage<T, const R: usize, const C: usize>(pub [[T; R]; C]);

A array-based statically sized matrix data storage.

Tuple Fields

0: [[T; R]; C]

Implementations

impl<T, const R: usize, const C: usize> ArrayStorage<T, R, C>

pub fn as_slice(&self) -> &[T]

Converts this array storage to a slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Converts this array storage to a mutable slice.

Trait Implementations

impl<T, const R: usize, const C: usize> Clone for ArrayStorage<T, R, C>where
    T: Clone,

fn clone(&self) -> ArrayStorage<T, R, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, const R: usize, const C: usize> Debug for ArrayStorage<T, R, C>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T, const R: usize, const C: usize> Default for ArrayStorage<T, R, C>where
    T: Default,
    [[T; R]; C]: Default,

fn default() -> ArrayStorage<T, R, C>

Returns the “default value” for a type.

impl<T, const R: usize, const C: usize> Hash for ArrayStorage<T, R, C>where
    T: Hash,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T, const R: usize, const C: usize> PartialEq<ArrayStorage<T, R, C>> for ArrayStorage<T, R, C>where
    T: PartialEq<T>,

fn eq(&self, other: &ArrayStorage<T, R, C>) -> 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, const R: usize, const C: usize> RawStorage<T, Const<R>, Const<C>> for ArrayStorage<T, R, C>

type RStride = Const<1>

The static stride of this storage’s rows.

type CStride = Const<R>

The static stride of this storage’s columns.

fn ptr(&self) -> *const T

The matrix data pointer.

fn shape(&self) -> (Const<R>, Const<C>)

The dimension of the matrix at run-time. Arr length of zero indicates the additive identity element of any dimension. Must be equal to Self::dimension() if it is not None.

fn strides(
    &self
) -> (<ArrayStorage<T, R, C> as RawStorage<T, Const<R>, Const<C>>>::RStride, <ArrayStorage<T, R, C> as RawStorage<T, Const<R>, Const<C>>>::CStride)

The spacing between consecutive row elements and consecutive column elements.

fn is_contiguous(&self) -> bool

Indicates whether this data buffer stores its elements contiguously.

unsafe fn as_slice_unchecked(&self) -> &[T]

Retrieves the data buffer as a contiguous slice.

fn linear_index(&self, irow: usize, icol: usize) -> usize

Compute the index corresponding to the irow-th row and icol-th column of this matrix. The index must be such that the following holds:

fn get_address_unchecked_linear(&self, i: usize) -> *const T

Gets the address of the i-th matrix component without performing bound-checking.

fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T

Gets the address of the i-th matrix component without performing bound-checking.

unsafe fn get_unchecked_linear(&self, i: usize) -> &T

Retrieves a reference to the i-th element without bound-checking.

unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T

Retrieves a reference to the i-th element without bound-checking.

impl<T, const R: usize, const C: usize> RawStorageMut<T, Const<R>, Const<C>> for ArrayStorage<T, R, C>

fn ptr_mut(&mut self) -> *mut T

The matrix mutable data pointer.

unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [T]

Retrieves the mutable data buffer as a contiguous slice.

fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T

Gets the mutable address of the i-th matrix component without performing bound-checking.

fn get_address_unchecked_mut(&mut self, irow: usize, icol: usize) -> *mut T

Gets the mutable address of the i-th matrix component without performing bound-checking.

unsafe fn get_unchecked_linear_mut(&mut self, i: usize) -> &mut T

Retrieves a mutable reference to the i-th element without bound-checking.

unsafe fn get_unchecked_mut(&mut self, irow: usize, icol: usize) -> &mut T

Retrieves a mutable reference to the element at (irow, icol) without bound-checking.

unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)

Swaps two elements using their linear index without bound-checking.

unsafe fn swap_unchecked(
    &mut self,
    row_col1: (usize, usize),
    row_col2: (usize, usize)
)

Swaps two elements without bound-checking.

impl<T, const R1: usize, const C1: usize, const R2: usize, const C2: usize> ReshapableStorage<T, Const<R1>, Const<C1>, Const<R2>, Const<C2>> for ArrayStorage<T, R1, C1>where
    T: Scalar,
    Const<R1>: ToTypenum,
    Const<C1>: ToTypenum,
    Const<R2>: ToTypenum,
    Const<C2>: ToTypenum,
    <Const<R1> as ToTypenum>::Typenum: Mul<<Const<C1> as ToTypenum>::Typenum>,
    <Const<R2> as ToTypenum>::Typenum: Mul<<Const<C2> as ToTypenum>::Typenum, Output = <<Const<R1> as ToTypenum>::Typenum as Mul<<Const<C1> as ToTypenum>::Typenum>>::Output>,

type Output = ArrayStorage<T, R2, C2>

The reshaped storage type.

fn reshape_generic(
    self,
    _: Const<R2>,
    _: Const<C2>
) -> <ArrayStorage<T, R1, C1> as ReshapableStorage<T, Const<R1>, Const<C1>, Const<R2>, Const<C2>>>::Output

Reshapes the storage into the output storage type.

impl<T, const R: usize, const C: usize> Storage<T, Const<R>, Const<C>> for ArrayStorage<T, R, C>where
    T: Scalar,
    DefaultAllocator: Allocator<T, Const<R>, Const<C>, Buffer = ArrayStorage<T, R, C>>,

fn into_owned(
    self
) -> <DefaultAllocator as Allocator<T, Const<R>, Const<C>>>::Bufferwhere
    DefaultAllocator: Allocator<T, Const<R>, Const<C>>,

Builds a matrix data storage that does not contain any reference.

fn clone_owned(
    &self
) -> <DefaultAllocator as Allocator<T, Const<R>, Const<C>>>::Bufferwhere
    DefaultAllocator: Allocator<T, Const<R>, Const<C>>,

Clones this data storage to one that does not contain any reference.

impl<T, const R: usize, const C: usize> Copy for ArrayStorage<T, R, C>where
    T: Copy,

impl<T, const R: usize, const C: usize> Eq for ArrayStorage<T, R, C>where
    T: Eq,

impl<T, const R: usize, const C: usize> IsContiguous for ArrayStorage<T, R, C>

impl<T, const R: usize, const C: usize> StructuralEq for ArrayStorage<T, R, C>

impl<T, const R: usize, const C: usize> StructuralPartialEq for ArrayStorage<T, R, C>