Struct faer_core::ColMut

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

Mutable column vector view with general row stride.

For usage examples, see MatRef.

Implementations

impl<'a, T> ColMut<'a, T>

pub unsafe fn from_raw_parts( ptr: *mut T, nrows: usize, row_stride: isize ) -> Self

Returns a mutable column vector slice from the given arguments.
ptr: pointer to the first element of the column vector.
ncols: number of columns of the column vector.
col_stride: offset between the first elements of two successive columns in the column vector.

Safety

ptr must be non null and properly aligned for type T.
For each i < nrows,
ptr.offset(i as isize * row_stride) must point to a valid initialized object of type T, unless memory pointing to that address is never read.
Additionally, when i != 0, this pointer is never equal to ptr (no self aliasing).
The referenced memory must not be mutated during the lifetime 'a.

pub fn as_ptr(self) -> *mut T

Returns a mutable pointer to the first (top) element of the column vector.

pub fn nrows(&self) -> usize

Returns the number of rows of the column vector.

pub fn ncols(&self) -> usize

Returns the number of columns of the column vector. Always returns 1.

pub fn row_stride(&self) -> isize

Returns the offset between the first elements of two successive rows in the column vector.

pub fn ptr_at(self, i: usize) -> *mut T

Returns a mutable pointer to the element at position (i, 0) in the column vector.

pub unsafe fn ptr_in_bounds_at_unchecked(self, i: usize) -> *mut T

Returns a mutable pointer to the element at position (i, 0) in the column vector, assuming it falls within its bounds with no bound checks.

Safety

Requires that

• i < self.nrows().

Otherwise, the behavior is undefined.

pub fn ptr_in_bounds_at(self, i: usize) -> *mut T

Returns a mutable pointer to the element at position (i, 0) in the column vector, while asserting that it falls within its bounds.

Panics

Requires that

• i < self.nrows().

Otherwise, it panics.

pub unsafe fn write_at_unchecked(&mut self, i: usize, value: T)

Writes the given value to the matrix at position (i, 0) in the column vector, assuming it falls within its bounds with no bound checks.

Safety

Requires that

• i < self.nrows().

Otherwise, the behavior is undefined.

pub fn write_at(&mut self, i: usize, value: T)

Writes the given value to the matrix at position (i, 0) in the column vector, or panics if the index is out of bounds.

Panics

Requires that

• i < self.nrows().

Otherwise, it panics.

pub unsafe fn split_at_unchecked(self, i: usize) -> (Self, Self)

Splits the column vector into two parts in the following order: top, bottom.

Safety

Requires that

• i <= self.nrows().

Otherwise, the behavior is undefined.

pub fn split_at(self, i: usize) -> (Self, Self)

Splits the column vector into two parts in the following order: top, bottom.

Panics

Requires that

• i <= self.nrows().

Otherwise, it panics.

pub unsafe fn get_unchecked(self, i: usize) -> &'a mut T

Returns a mutable reference to the element at position (i, 0), with no bound checks.

Safety

Requires i < self.nrows().

Otherwise, the behavior is undefined.

pub fn get(self, i: usize) -> &'a mut T

Returns a mutable reference to the element at position (i, 0), or panics if the index is out of bounds.

pub fn as_2d(self) -> MatMut<'a, T>

Returns an equivalent matrix view over the same data.

pub fn transpose(self) -> RowMut<'a, T>

Returns the transpose of self.

pub unsafe fn subrows_unchecked(self, i: usize, nrows: usize) -> Self

Returns a view over subrows of self, starting at position i with a row count of nrows.

Safety

Requires that

• i <= self.nrows(),
• nrows <= self.nrows() - i.

Otherwise, the behavior is undefined.

pub fn subrows(self, i: usize, nrows: usize) -> Self

Returns a view over subrows of self, starting at position i with a row count of nrows.

Panics

Requires that

• i <= self.nrows(),
• nrows <= self.nrows() - i.

Otherwise, it panics.

pub fn cwise(self) -> ZipCol<(Self,)>

Returns a thin wrapper that can be used to execute coefficientwise operations on matrices.

impl<'a, T> ColMut<'a, Complex<T>>

pub fn into_real_imag(self) -> (ColMut<'a, T>, ColMut<'a, T>)

Trait Implementations

impl<'a, T: 'static, U: 'static> Coerce<ColMut<'a, U>> for ColMut<'a, T>

fn coerce(self) -> ColMut<'a, U>

impl<'short, 'a, T> CwiseCol<'short, &'short ColMut<'a, T>> for ColMut<'a, T>

type Item = &'short mut T

fn nrows(&self) -> usize

fn is_contiguous(&self) -> bool

unsafe fn get_unchecked(&'short mut self, i: usize) -> Self::Item

unsafe fn get_contiguous_unchecked(&'short mut self, i: usize) -> Self::Item

impl<'a, T: Debug + 'static> Debug for ColMut<'a, T>

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

Formats the value using the given formatter.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T> IndexMut<usize> for ColMut<'a, T>

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

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

impl<'a, T> IntoConst for ColMut<'a, T>

type Target = ColRef<'a, T>

fn into_const(self) -> Self::Target

impl<'a, T> IntoIterator for ColMut<'a, T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = ElemIterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'b, 'a, T> Reborrow<'b, &'b ColMut<'a, T>> for ColMut<'a, T>

type Target = ColRef<'b, T>

fn rb(&'b self) -> Self::Target

impl<'b, 'a, T> ReborrowMut<'b, &'b ColMut<'a, T>> for ColMut<'a, T>

type Target = ColMut<'b, T>

fn rb_mut(&'b mut self) -> Self::Target

impl<'a, T: Send> Send for ColMut<'a, T>

impl<'a, T: Sync> Sync for ColMut<'a, T>