Type Alias faer_core::ColRef

pub type ColRef<'a, E> = Matrix<DenseColRef<'a, E>>;

Immutable view over a column vector, similar to an immutable reference to a strided slice.

Note

Unlike a slice, the data pointed to by ColRef<'_, E> is allowed to be partially or fully uninitialized under certain conditions. In this case, care must be taken to not perform any operations that read the uninitialized values, or form references to them, either directly through ColRef::read, or indirectly through any of the numerical library routines, unless it is explicitly permitted.

Aliased Type

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

Implementations

impl<'a, E: Entity> ColRef<'a, E>

pub fn nrows(&self) -> usize

Returns the number of rows of the column.

pub fn ncols(&self) -> usize

Returns the number of columns of the column. This is always equal to 1.

pub fn as_ptr(self) -> GroupFor<E, *const E::Unit>

Returns pointers to the matrix data.

pub fn row_stride(&self) -> isize

Returns the row stride of the matrix, specified in number of elements, not in bytes.

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

Returns self as a matrix view.

pub fn ptr_at(self, row: usize) -> GroupFor<E, *const E::Unit>

Returns raw pointers to the element at the given index.

pub unsafe fn ptr_inbounds_at(self, row: usize) -> GroupFor<E, *const E::Unit>

Returns raw pointers to the element at the given index, assuming the provided index is within the size of the vector.

Safety

The behavior is undefined if any of the following conditions are violated:

• row < self.nrows().

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

Splits the column vector at the given index into two parts and returns an array of each subvector, in the following order:

• top.
• bottom.

Safety

The behavior is undefined if any of the following conditions are violated:

• row <= self.nrows().

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

Splits the column vector at the given index into two parts and returns an array of each subvector, in the following order:

• top.
• bottom.

Panics

The function panics if any of the following conditions are violated:

• row <= self.nrows().

pub unsafe fn get_unchecked<RowRange>( self, row: RowRange ) -> <Self as ColIndex<RowRange>>::Target

where Self: ColIndex<RowRange>,

Returns references to the element at the given index, or subvector if row is a range.

Note

The values pointed to by the references are expected to be initialized, even if the pointed-to value is not read, otherwise the behavior is undefined.

Safety

The behavior is undefined if any of the following conditions are violated:

• row must be contained in [0, self.nrows()).

pub fn get<RowRange>( self, row: RowRange ) -> <Self as ColIndex<RowRange>>::Target

where Self: ColIndex<RowRange>,

Returns references to the element at the given index, or subvector if row is a range, with bound checks.

Note

The values pointed to by the references are expected to be initialized, even if the pointed-to value is not read, otherwise the behavior is undefined.

Panics

The function panics if any of the following conditions are violated:

• row must be contained in [0, self.nrows()).

pub unsafe fn read_unchecked(&self, row: usize) -> E

Reads the value of the element at the given index.

Safety

The behavior is undefined if any of the following conditions are violated:

• row < self.nrows().

pub fn read(&self, row: usize) -> E

Reads the value of the element at the given index, with bound checks.

Panics

The function panics if any of the following conditions are violated:

• row < self.nrows().

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

Returns a view over the transpose of self.

pub fn conjugate(self) -> ColRef<'a, E::Conj>

where E: Conjugate,

Returns a view over the conjugate of self.

pub fn adjoint(self) -> RowRef<'a, E::Conj>

where E: Conjugate,

Returns a view over the conjugate transpose of self.

pub fn canonicalize(self) -> (ColRef<'a, E::Canonical>, Conj)

where E: Conjugate,

Returns a view over the canonical representation of self, as well as a flag declaring whether self is implicitly conjugated or not.

pub fn reverse_rows(self) -> Self

Returns a view over the self, with the rows in reversed order.

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

Returns a view over the subvector starting at row row_start, and with number of rows nrows.

Safety

The behavior is undefined if any of the following conditions are violated:

• row_start <= self.nrows().
• nrows <= self.nrows() - row_start.

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

Returns a view over the subvector starting at row row_start, and with number of rows nrows.

Safety

The behavior is undefined if any of the following conditions are violated:

• row_start <= self.nrows().
• nrows <= self.nrows() - row_start.

pub fn column_vector_as_diagonal(self) -> Matrix<DiagRef<'a, E>>

Given a matrix with a single column, returns an object that interprets the column as a diagonal matrix, whoes diagonal elements are values in the column.

pub fn to_owned(&self) -> Col<E::Canonical>

where E: Conjugate,

Returns an owning Col of the data.

pub fn has_nan(&self) -> bool

where E: ComplexField,

Returns true if any of the elements is NaN, otherwise returns false.

pub fn is_all_finite(&self) -> bool

where E: ComplexField,

Returns true if all of the elements are finite, otherwise returns false.

pub fn norm_max(&self) -> E::Real

where E: ComplexField,

Returns the maximum norm of self.

pub fn norm_l2(&self) -> E::Real

where E: ComplexField,

Returns the L2 norm of self.

pub fn sum(&self) -> E

where E: ComplexField,

Returns the sum of self.

pub fn kron(&self, rhs: impl As2D<E>) -> Mat<E>

where E: ComplexField,

Kroneckor product of self and rhs.

This is an allocating operation; see kron for the allocation-free version or more info in general.

pub fn as_ref(&self) -> ColRef<'_, E>

Returns a view over the matrix.

Trait Implementations

impl<E: Entity> As2D<E> for &ColRef<'_, E>

fn as_2d_ref(&self) -> MatRef<'_, E>

Convert to a 2D matrix view.

impl<E: Entity> As2D<E> for ColRef<'_, E>

fn as_2d_ref(&self) -> MatRef<'_, E>

Convert to a 2D matrix view.

impl<E: Entity> AsColRef<E> for &ColRef<'_, E>

fn as_col_ref(&self) -> ColRef<'_, E>

Convert to a column view.

impl<E: Entity> AsColRef<E> for ColRef<'_, E>

fn as_col_ref(&self) -> ColRef<'_, E>

Convert to a column view.

impl<E: Entity> ColIndex<Range<usize>> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: Range<usize>) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<E: Entity> ColIndex<RangeFrom<usize>> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFrom<usize>) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<E: Entity> ColIndex<RangeFull> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFull) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<E: Entity> ColIndex<RangeInclusive<usize>> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeInclusive<usize>) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<E: Entity> ColIndex<RangeTo<usize>> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeTo<usize>) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<E: Entity> ColIndex<RangeToInclusive<usize>> for ColRef<'_, E>

type Target = Matrix<DenseColRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeToInclusive<usize>) -> Self

Index the column at row.

unsafe fn get_unchecked(this: Self, row: RowRange) -> Self::Target

Index the column at row, without bound checks.

impl<'a, E: Entity> ColIndex<usize> for ColRef<'a, E>

type Target = <<E as Entity>::Group as ForType>::FaerOf<&'a <E as Entity>::Unit>

Resulting type of the indexing operation.

unsafe fn get_unchecked(this: Self, row: usize) -> Self::Target

Index the column at row, without bound checks.

fn get(this: Self, row: usize) -> Self::Target

Index the column at row.

impl<'a, E: Entity> Debug for ColRef<'a, E>

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

Formats the value using the given formatter.

impl<E: SimpleEntity> Index<usize> for ColRef<'_, E>

type Output = E

The returned type after indexing.

fn index(&self, row: usize) -> &E

Performs the indexing (container[index]) operation.

impl<'a, E: Entity> IntoConst for ColRef<'a, E>

type Target = Matrix<DenseColRef<'a, E>>

fn into_const(self) -> Self::Target

impl<'a, E: Entity> MatIndex<'a> for ColRef<'_, E>

type Item = Read<'a, E>

Item produced by the zipped views.

unsafe fn get_unchecked(&'a mut self, (i, _): Self::Index) -> Self::Item

Get the item at the given index, skipping bound checks.

unsafe fn get_from_slice_unchecked( slice: &'a mut Self::Slice, idx: usize ) -> Self::Item

Get the item at the given slice position, skipping bound checks.

fn is_contiguous(&self) -> bool

Checks if the zipped matrices are contiguous.

fn preferred_layout(&self) -> Self::LayoutTransform

Computes the preferred iteration layout of the matrices.

fn with_layout(self, layout: Self::LayoutTransform) -> Self

Applies the layout transformation to the matrices.

impl<E: Entity> MatShape for ColRef<'_, E>

type Rows = usize

Type of rows.

type Cols = ()

Type of columns.

fn nrows(&self) -> Self::Rows

Returns the number of rows.

fn ncols(&self) -> Self::Cols

Returns the number of columns.

impl<E: Entity> MaybeContiguous for ColRef<'_, E>

type Index = (usize, ())

Indexing type.

type Slice = <<E as Entity>::Group as ForType>::FaerOf<&'static [MaybeUninit<<E as Entity>::Unit>]>

Contiguous slice type.

type LayoutTransform = VecLayoutTransform

Layout transformation type.

unsafe fn get_slice_unchecked( &mut self, (i, _): Self::Index, n_elems: usize ) -> Self::Slice

Returns slice at index of length n_elems.

impl<'short, 'a, E: Entity> Reborrow<'short> for ColRef<'a, E>

type Target = Matrix<DenseColRef<'short, E>>

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

impl<'short, 'a, E: Entity> ReborrowMut<'short> for ColRef<'a, E>

type Target = Matrix<DenseColRef<'short, E>>

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

impl<E: Entity> ViewMut for &ColRef<'_, E>

type Target<'a> = Matrix<DenseColRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.

impl<E: Entity> ViewMut for &mut ColRef<'_, E>

type Target<'a> = Matrix<DenseColRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.

impl<E: Entity> ViewMut for ColRef<'_, E>

type Target<'a> = Matrix<DenseColRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.