Struct faer_core::RowMut

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

Mutable row vector view with general column stride.

For usage examples, see MatRef.

Implementations

impl<'a, T> RowMut<'a, T>

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

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

Safety

ptr must be non null and properly aligned for type T.
For each j < ncols,
ptr.offset(j as isize * col_stride) must point to a valid initialized object of type T, unless memory pointing to that address is never read.
Additionally, when j != 0, this pointer is never equal to ptr (no self aliasing).
The referenced memory must not be accessed by another pointer which was not derived from the return value, during the lifetime 'a.

pub fn as_ptr(self) -> *mut T

Returns a mutable pointer to the first (left) element of the row vector.

pub fn nrows(&self) -> usize

Returns the number of rows of the row vector. Always returns 1.

pub fn ncols(&self) -> usize

Returns the number of columns of the row vector.

pub fn col_stride(&self) -> isize

Returns the offset between the first elements of two successive columns in the row vector.

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

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

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

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

Safety

Requires that

• j < self.ncols().

Otherwise, the behavior is undefined.

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

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

Panics

Requires that

• j < self.ncols().

Otherwise, it panics.

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

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

Safety

Requires that

• j < self.ncols().

Otherwise, the behavior is undefined.

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

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

Panics

Requires that

• j < self.ncols().

Otherwise, it panics.

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

Splits the row vector into two parts in the following order: left, right.

Safety

Requires that

• j <= self.ncols().

Otherwise, the behavior is undefined.

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

Splits the row vector into two parts in the following order: left, right.

Panics

Requires that

• j <= self.ncols().

Otherwise, it panics.

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

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

Safety

Requires j < self.ncols().

Otherwise, the behavior is undefined.

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

Returns a mutable reference to the element at position (0, j), 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) -> ColMut<'a, T>

Returns the transpose of self.

pub unsafe fn subcols_unchecked(self, j: usize, ncols: usize) -> Self

Returns a view over subcolumns of self, starting at position j with a column count of ncols.

Safety

Requires that

• j <= self.ncols(),
• ncols <= self.ncols() - j.

Otherwise, the behavior is undefined.

pub fn subcols(self, j: usize, ncols: usize) -> Self

Returns a view over subcolumnss of self, starting at position j with a col count of ncols.

Panics

Requires that

• j <= self.ncols(),
• ncols <= self.ncols() - j.

Otherwise, it panics.

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

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

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

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

Trait Implementations

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

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

impl<'short, 'a, T> CwiseRow<'short, &'short RowMut<'a, T>> for RowMut<'a, T>

type Item = &'short mut T

fn ncols(&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 RowMut<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Index<usize> for RowMut<'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 RowMut<'a, T>

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

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

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

type Target = RowRef<'a, T>

fn into_const(self) -> Self::Target

impl<'a, T> IntoIterator for RowMut<'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 RowMut<'a, T>> for RowMut<'a, T>

type Target = RowRef<'b, T>

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

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

type Target = RowMut<'b, T>

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

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

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