Type Alias faer_core::Col

pub type Col<E> = Matrix<DenseColOwn<E>>;

Heap allocated resizable column vector.

Note

The memory layout of Col is guaranteed to be column-major, meaning that it has a row stride of 1.

Aliased Type

struct Col<E> { /* private fields */ }

Implementations

impl<E: Entity> Col<E>

pub fn new() -> Self

pub fn with_capacity(row_capacity: usize) -> Self

Returns a new column vector with 0 rows, with enough capacity to hold a maximum of row_capacity rows columns without reallocating. If row_capacity is 0, the function will not allocate.

Panics

The function panics if the total capacity in bytes exceeds isize::MAX.

pub fn from_fn(nrows: usize, f: impl FnMut(usize) -> E) -> Self

Returns a new matrix with number of rows nrows, filled with the provided function.

Panics

The function panics if the total capacity in bytes exceeds isize::MAX.

pub fn zeros(nrows: usize) -> Self

where E: ComplexField,

Returns a new matrix with number of rows nrows, filled with zeros.

Panics

The function panics if the total capacity in bytes exceeds isize::MAX.

pub fn nrows(&self) -> usize

pub fn ncols(&self) -> usize

pub unsafe fn set_nrows(&mut self, nrows: usize)

Set the dimensions of the matrix.

Safety

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

• nrows < self.row_capacity().
• The elements that were previously out of bounds but are now in bounds must be initialized.

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

Returns a pointer to the data of the matrix.

pub fn as_ptr_mut(&mut self) -> GroupFor<E, *mut E::Unit>

Returns a mutable pointer to the data of the matrix.

pub fn row_capacity(&self) -> usize

Returns the row capacity, that is, the number of rows that the matrix is able to hold without needing to reallocate, excluding column insertions.

pub fn row_stride(&self) -> isize

Returns the offset between the first elements of two successive rows in the matrix. Always returns 1 since the matrix is column major.

pub fn reserve_exact(&mut self, row_capacity: usize)

Reserves the minimum capacity for row_capacity rows without reallocating. Does nothing if the capacity is already sufficient.

Panics

The function panics if the new total capacity in bytes exceeds isize::MAX.

pub fn resize_with(&mut self, new_nrows: usize, f: impl FnMut(usize) -> E)

Resizes the vector in-place so that the new number of rows is new_nrows. New elements are created with the given function f, so that elements at index i are created by calling f(i).

pub fn as_slice(&self) -> GroupFor<E, &[E::Unit]>

Returns a reference to a slice over the column.

pub fn as_slice_mut(&mut self) -> GroupFor<E, &mut [E::Unit]>

Returns a mutable reference to a slice over the column.

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

Returns a view over the vector.

pub fn as_mut(&mut self) -> ColMut<'_, E>

Returns a mutable view over the vector.

pub unsafe fn get_unchecked<RowRange>( &self, row: RowRange ) -> <ColRef<'_, E> as ColIndex<RowRange>>::Target

where for<'a> ColRef<'a, E>: ColIndex<RowRange>,

Returns references to the element at the given index, or submatrices 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 ) -> <ColRef<'_, E> as ColIndex<RowRange>>::Target

where for<'a> ColRef<'a, E>: ColIndex<RowRange>,

Returns references to the element at the given index, or submatrices 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 get_mut_unchecked<RowRange>( &mut self, row: RowRange ) -> <ColMut<'_, E> as ColIndex<RowRange>>::Target

where for<'a> ColMut<'a, E>: ColIndex<RowRange>,

Returns mutable references to the element at the given index, or submatrices 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_mut<RowRange>( &mut self, row: RowRange ) -> <ColMut<'_, E> as ColIndex<RowRange>>::Target

where for<'a> ColMut<'a, E>: ColIndex<RowRange>,

Returns mutable references to the element at the given index, or submatrices 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 unsafe fn write_unchecked(&mut self, row: usize, value: E)

Writes the value to the element at the given index.

Safety

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

• row < self.nrows().

pub fn write(&mut self, row: usize, value: E)

Writes the value to 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 copy_from(&mut self, other: impl AsColRef<E>)

Copies the values from other into self.

pub fn fill_zero(&mut self)

where E: ComplexField,

Fills the elements of self with zeros.

pub fn fill(&mut self, constant: E)

Fills the elements of self with copies of constant.

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

Returns a view over the transpose of self.

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

where E: Conjugate,

Returns a view over the conjugate of self.

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

where E: Conjugate,

Returns a view over the conjugate transpose of self.

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.

Trait Implementations

impl<E: Entity> AsColMut<E> for &mut Col<E>

fn as_col_mut(&mut self) -> ColMut<'_, E>

impl<E: Entity> AsColMut<E> for Col<E>

fn as_col_mut(&mut self) -> ColMut<'_, E>

impl<E: Entity> AsColRef<E> for &Col<E>

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

impl<E: Entity> AsColRef<E> for Col<E>

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

impl<E: Entity> Default for Col<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: SimpleEntity> Index<usize> for Col<E>

type Output = E

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<E: SimpleEntity> IndexMut<usize> for Col<E>

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

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

impl<E: Entity> ViewMut for &Col<E>

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

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

impl<E: Entity> ViewMut for &mut Col<E>

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

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

impl<E: Entity> ViewMut for Col<E>

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

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