Struct UsingColBasisIndex 

pub struct UsingColBasisIndex<M: MatrixOracle + HasColBasis> { /* private fields */ }

Return type of MatrixOracle::using_col_basis_index.

Trait Implementations

impl<M: Clone + MatrixOracle + HasColBasis> Clone for UsingColBasisIndex<M>

fn clone(&self) -> UsingColBasisIndex<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + MatrixOracle + HasColBasis> Debug for UsingColBasisIndex<M>

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

Formats the value using the given formatter.

impl<M> HasRowFiltration for UsingColBasisIndex<M>

where M: MatrixOracle + HasColBasis + HasRowFiltration,

type FiltrationT = <M as HasRowFiltration>::FiltrationT

The type that the filtration function is valued in.

fn filtration_value(&self, row: Self::RowT) -> Self::FiltrationT

Implementing the filtration function on the row basis.

fn column_with_filtration( &self, col: Self::ColT, ) -> impl Iterator<Item = ColumnEntry<Self::FiltrationT, Self::RowT, Self::CoefficientField>>

Uses MatrixOracle::column and HasRowFiltration::filtration_value to provide an iterator over non-zero column entries, enriches with the row filtration value.

fn empty_bhcol( &self, ) -> BHCol<Self::FiltrationT, Self::RowT, Self::CoefficientField>

Initialise an empty binary heap that can accept entries from this matrix. Mostly an implementation detail of build_bhcol.

fn build_bhcol( &self, col: Self::ColT, ) -> BHCol<Self::FiltrationT, Self::RowT, Self::CoefficientField>

Builds a binary heap out of the non-zero entries in this column, sorted according to the filtration value and then the default ordering on RowT. Popping top entries off this binary heap will allow access to the column pivot.

impl<M> MatrixOracle for UsingColBasisIndex<M>

where M: MatrixOracle + HasColBasis,

type CoefficientField = <M as MatrixOracle>::CoefficientField

Represents the non-zero elements in the field over which we are doing linear algebra.

type ColT = usize

Represents elements in the domain basis.

type RowT = <M as MatrixOracle>::RowT

Represents elements in the target basis.

fn column( &self, col: Self::ColT, ) -> impl Iterator<Item = (Self::CoefficientField, Self::RowT)>

Given an element col in the domain basis, express the image of col under the linear transformation as a linear combination of elements in the target basis. You should provide this combination is an iterator of (coeff, row) tuples where each row is an element of the target basis. If coeff is 0 then omit this term from the linear combination.

fn eq_on_col<M2>(&self, other: &M2, col: Self::ColT) -> bool

where Self: Sized, M2: MatrixOracle<CoefficientField = Self::CoefficientField, ColT = Self::ColT, RowT = Self::RowT>,

Checks that the matricies are equal on the specified col, ignoring ordering due to filtration values

fn with_trivial_filtration(self) -> WithTrivialFiltration<Self>

where Self: Sized,

Endows self with a filtration in which all rows have the same filtration value: ().

fn with_filtration<FT: FiltrationValue, F: Fn(Self::RowT) -> FT>( self, filtration_function: F, ) -> WithFuncFiltration<Self, FT, F>

where Self: Sized,

Endows self with the filtration given by the provided filtration_function.

fn with_basis<B>(self, basis: B) -> MatrixWithBasis<Self, B>

where Self: Sized, B: ColBasis<ElemT = Self::ColT>,

Endows self with the basis basis.

fn reverse(self) -> ReverseMatrix<Self>

where Self: Sized,

Reverse the order on both the rows and columns. Both the indices and the filtration values are now the Reverse of their previous type.

fn unreverse<ColT, RowT>(self) -> UnreverseMatrix<Self>

where Self: Sized + MatrixOracle<RowT = Reverse<RowT>, ColT = Reverse<ColT>>,

Reverse the order on both the rows and columns. Can only be called when the indices are of the form Reverse<ColT> and Reverse<RowT> Returns a matrix indexed by ColT and RowT. Additionally, the filtration value can be ‘unreversed’. Can be useful when self was obtained by reducing a reversed matrix.

fn consolidate(self) -> Consolidator<Self>

where Self: Sized,

When accessing a column of the consolidated matrix, the corresponding column of self will be requested and stored into a binary heap. An iterator through this binary heap is then returned.

fn cache_cols(self) -> WithCachedCols<Self>

where Self: Sized,

Returns a wrapper around self which caches any calls to column in an internal HashMap.

impl<M: Copy + MatrixOracle + HasColBasis> Copy for UsingColBasisIndex<M>