Struct faer_core::ColRef

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

Column vector view with general row stride.

For usage examples, see MatRef.

Implementations

impl<'a, T> ColRef<'a, T>

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

Returns a 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.
The referenced memory must not be mutated during the lifetime 'a.

pub fn as_ptr(self) -> *const T

Returns a 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) -> *const T

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

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

Returns a 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) -> *const T

Returns a 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 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 T

Returns a 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 T

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

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

Returns an equivalent matrix view over the same data.

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

Returns the transpose of self.

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

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

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

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

Trait Implementations

impl<'a, T> Clone for ColRef<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type Item = &'short 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 ColRef<'a, T>

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

Formats the value using the given formatter.

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

type Target = ColRef<'a, T>

fn into_const(self) -> Self::Target

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = ElemIter<'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 ColRef<'a, T>> for ColRef<'a, T>

type Target = ColRef<'b, T>

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

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

type Target = ColRef<'b, T>

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

impl<'a, T> Copy for ColRef<'a, T>

impl<'a, T: Sync> Send for ColRef<'a, T>

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