pub type RowRef<'a, E> = Matrix<DenseRowRef<'a, E>>;
Expand description
Immutable view over a row vector, similar to an immutable reference to a strided slice.
§Note
Unlike a slice, the data pointed to by RowRef<'_, 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 RowRef::read
, or indirectly through any of the numerical library routines, unless
it is explicitly permitted.
Aliased Type§
struct RowRef<'a, E> { /* private fields */ }
Implementations§
source§impl<'a, E: Entity> RowRef<'a, E>
impl<'a, E: Entity> RowRef<'a, E>
sourcepub fn col_stride(&self) -> isize
pub fn col_stride(&self) -> isize
Returns the column stride of the matrix, specified in number of elements, not in bytes.
sourcepub fn ptr_at(self, col: usize) -> GroupFor<E, *const E::Unit>
pub fn ptr_at(self, col: usize) -> GroupFor<E, *const E::Unit>
Returns raw pointers to the element at the given index.
sourcepub unsafe fn ptr_inbounds_at(self, col: usize) -> GroupFor<E, *const E::Unit>
pub unsafe fn ptr_inbounds_at(self, col: 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:
col < self.ncols()
.
sourcepub unsafe fn split_at_unchecked(self, col: usize) -> (Self, Self)
pub unsafe fn split_at_unchecked(self, col: 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:
- left.
- right.
§Safety
The behavior is undefined if any of the following conditions are violated:
col <= self.ncols()
.
sourcepub unsafe fn split_at(self, col: usize) -> (Self, Self)
pub unsafe fn split_at(self, col: 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:
col <= self.ncols()
.
sourcepub unsafe fn get_unchecked<ColRange>(
self,
col: ColRange
) -> <Self as RowIndex<ColRange>>::Targetwhere
Self: RowIndex<ColRange>,
pub unsafe fn get_unchecked<ColRange>(
self,
col: ColRange
) -> <Self as RowIndex<ColRange>>::Targetwhere
Self: RowIndex<ColRange>,
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:
col
must be contained in[0, self.ncols())
.
sourcepub fn get<ColRange>(
self,
col: ColRange
) -> <Self as RowIndex<ColRange>>::Targetwhere
Self: RowIndex<ColRange>,
pub fn get<ColRange>(
self,
col: ColRange
) -> <Self as RowIndex<ColRange>>::Targetwhere
Self: RowIndex<ColRange>,
Returns references to the element at the given index, or subvector if col
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:
col
must be contained in[0, self.ncols())
.
sourcepub unsafe fn read_unchecked(&self, col: usize) -> E
pub unsafe fn read_unchecked(&self, col: 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:
col < self.ncols()
.
sourcepub fn read(&self, col: usize) -> E
pub fn read(&self, col: 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:
col < self.ncols()
.
sourcepub fn conjugate(self) -> RowRef<'a, E::Conj>where
E: Conjugate,
pub fn conjugate(self) -> RowRef<'a, E::Conj>where
E: Conjugate,
Returns a view over the conjugate of self
.
sourcepub fn adjoint(self) -> ColRef<'a, E::Conj>where
E: Conjugate,
pub fn adjoint(self) -> ColRef<'a, E::Conj>where
E: Conjugate,
Returns a view over the conjugate transpose of self
.
sourcepub fn canonicalize(self) -> (RowRef<'a, E::Canonical>, Conj)where
E: Conjugate,
pub fn canonicalize(self) -> (RowRef<'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.
sourcepub fn reverse_cols(self) -> Self
pub fn reverse_cols(self) -> Self
Returns a view over the self
, with the columnss in reversed order.
sourcepub unsafe fn subcols_unchecked(self, col_start: usize, ncols: usize) -> Self
pub unsafe fn subcols_unchecked(self, col_start: usize, ncols: usize) -> Self
Returns a view over the subvector starting at column col_start
, and with number of
columns ncols
.
§Safety
The behavior is undefined if any of the following conditions are violated:
col_start <= self.ncols()
.ncols <= self.ncols() - col_start
.
sourcepub fn subcols(self, col_start: usize, ncols: usize) -> Self
pub fn subcols(self, col_start: usize, ncols: usize) -> Self
Returns a view over the subvector starting at col col_start
, and with number of cols
ncols
.
§Panics
The function panics if any of the following conditions are violated:
col_start <= self.ncols()
.ncols <= self.ncols() - col_start
.
sourcepub fn to_owned(&self) -> Row<E::Canonical>where
E: Conjugate,
pub fn to_owned(&self) -> Row<E::Canonical>where
E: Conjugate,
Returns an owning Row
of the data.
sourcepub fn has_nan(&self) -> boolwhere
E: ComplexField,
pub fn has_nan(&self) -> boolwhere
E: ComplexField,
Returns true
if any of the elements is NaN, otherwise returns false
.
sourcepub fn is_all_finite(&self) -> boolwhere
E: ComplexField,
pub fn is_all_finite(&self) -> boolwhere
E: ComplexField,
Returns true
if all of the elements are finite, otherwise returns false
.
sourcepub fn norm_max(&self) -> E::Realwhere
E: ComplexField,
pub fn norm_max(&self) -> E::Realwhere
E: ComplexField,
Returns the maximum norm of self
.
sourcepub fn norm_l2(&self) -> E::Realwhere
E: ComplexField,
pub fn norm_l2(&self) -> E::Realwhere
E: ComplexField,
Returns the L2 norm of self
.
sourcepub fn sum(&self) -> Ewhere
E: ComplexField,
pub fn sum(&self) -> Ewhere
E: ComplexField,
Returns the sum of self
.
Trait Implementations§
source§impl<E: Entity> AsRowRef<E> for &RowRef<'_, E>
impl<E: Entity> AsRowRef<E> for &RowRef<'_, E>
source§fn as_row_ref(&self) -> RowRef<'_, E>
fn as_row_ref(&self) -> RowRef<'_, E>
source§impl<E: Entity> AsRowRef<E> for RowRef<'_, E>
impl<E: Entity> AsRowRef<E> for RowRef<'_, E>
source§fn as_row_ref(&self) -> RowRef<'_, E>
fn as_row_ref(&self) -> RowRef<'_, E>
source§impl<'a, E: Entity> IntoConst for RowRef<'a, E>
impl<'a, E: Entity> IntoConst for RowRef<'a, E>
type Target = Matrix<DenseRowRef<'a, E>>
fn into_const(self) -> Self::Target
source§impl<'a, E: Entity> MatIndex<'a> for RowRef<'_, E>
impl<'a, E: Entity> MatIndex<'a> for RowRef<'_, E>
source§unsafe fn get_unchecked(&'a mut self, (_, j): Self::Index) -> Self::Item
unsafe fn get_unchecked(&'a mut self, (_, j): Self::Index) -> Self::Item
source§unsafe fn get_from_slice_unchecked(
slice: &'a mut Self::Slice,
idx: usize
) -> Self::Item
unsafe fn get_from_slice_unchecked( slice: &'a mut Self::Slice, idx: usize ) -> Self::Item
source§fn is_contiguous(&self) -> bool
fn is_contiguous(&self) -> bool
source§fn preferred_layout(&self) -> Self::LayoutTransform
fn preferred_layout(&self) -> Self::LayoutTransform
source§fn with_layout(self, layout: Self::LayoutTransform) -> Self
fn with_layout(self, layout: Self::LayoutTransform) -> Self
source§impl<E: Entity> MaybeContiguous for RowRef<'_, E>
impl<E: Entity> MaybeContiguous for RowRef<'_, E>
§type Slice = <<E as Entity>::Group as ForType>::FaerOf<&'static [MaybeUninit<<E as Entity>::Unit>]>
type Slice = <<E as Entity>::Group as ForType>::FaerOf<&'static [MaybeUninit<<E as Entity>::Unit>]>
§type LayoutTransform = VecLayoutTransform
type LayoutTransform = VecLayoutTransform
source§impl<'short, 'a, E: Entity> ReborrowMut<'short> for RowRef<'a, E>
impl<'short, 'a, E: Entity> ReborrowMut<'short> for RowRef<'a, E>
source§impl<E: Entity> RowIndex<RangeInclusive<usize>> for RowRef<'_, E>
impl<E: Entity> RowIndex<RangeInclusive<usize>> for RowRef<'_, E>
§type Target = Matrix<DenseRowRef<'_, E>>
type Target = Matrix<DenseRowRef<'_, E>>
source§fn get(this: Self, col: RangeInclusive<usize>) -> Self
fn get(this: Self, col: RangeInclusive<usize>) -> Self
col
.source§unsafe fn get_unchecked(this: Self, col: ColRange) -> Self::Target
unsafe fn get_unchecked(this: Self, col: ColRange) -> Self::Target
col
, without bound checks.source§impl<E: Entity> RowIndex<RangeToInclusive<usize>> for RowRef<'_, E>
impl<E: Entity> RowIndex<RangeToInclusive<usize>> for RowRef<'_, E>
§type Target = Matrix<DenseRowRef<'_, E>>
type Target = Matrix<DenseRowRef<'_, E>>
source§fn get(this: Self, col: RangeToInclusive<usize>) -> Self
fn get(this: Self, col: RangeToInclusive<usize>) -> Self
col
.source§unsafe fn get_unchecked(this: Self, col: ColRange) -> Self::Target
unsafe fn get_unchecked(this: Self, col: ColRange) -> Self::Target
col
, without bound checks.