Struct Subquotient 

pub struct Subquotient {
    gens: Subspace,
    quotient: Subspace,
    dimension: usize,
}

Fields

gens: Subspace

quotient: Subspace

dimension: usize

Implementations

impl Subquotient

pub fn new(p: ValidPrime, dim: usize) -> Self

Create a new subquotient of an ambient space of dimension dim. This defaults to the zero subspace.

pub fn new_full(p: ValidPrime, dim: usize) -> Self

Create a new subquotient of an ambient space of dimension dim, where the subspace is the full subspace and quotient is trivial.

pub fn reduce(&self, elt: FpSliceMut<'_>) -> Vec<u32>

Given a vector elt, project elt to the complement and express as a linear combination of the basis. The result is returned as a list of coefficients. If elt is nonzero afterwards, this means the vector was not in the subspace to begin with.

pub fn reduce_by_quotient(&self, elt: FpSliceMut<'_>)

Project the vector onto the complement of the quotient part of the subquotient.

pub fn set_to_full(&mut self)

Set the subquotient to be the full ambient space quotiented by zero

pub fn zeros(&self) -> &Subspace

pub fn gens(&self) -> impl Iterator<Item = FpSlice<'_>>

pub fn quotient_dimension(&self) -> usize

pub fn subspace_dimension(&self) -> usize

The dimension of the subspace part of the subquotient.

pub fn subspace_gens(&self) -> impl Iterator<Item = FpSlice<'_>>

The generators of the subspace part of the subquotient.

pub fn complement_pivots(&self) -> impl Iterator<Item = usize> + '_

The pivot columns of the complement to the subspace

pub fn quotient(&mut self, elt: FpSlice<'_>)

pub fn dimension(&self) -> usize

pub fn ambient_dimension(&self) -> usize

pub fn prime(&self) -> ValidPrime

pub fn is_empty(&self) -> bool

pub fn clear_gens(&mut self)

pub fn add_gen(&mut self, g: FpSlice<'_>)

pub fn reduce_matrix( matrix: &Matrix, source: &Self, target: &Self, ) -> Vec<Vec<u32>>

pub fn from_parts(sub: Subspace, quotient: Subspace) -> Self

Given a chain of subspaces quotient < sub in some ambient space, compute the subquotient sub/quotient. The answer is expressed as a list of basis vectors of sub whose image in sub/quotient forms a basis, and a basis vector of sub is described by its index in the list of basis vectors of sub (not the ambient space).

Note that the quotient argument does not need to be a subspace of the sub argument, nor do they need to be disjoint. Mathematically, this method constructs the space (sub + quotient) / quotient.

pub fn quotient_pivots(&self) -> &[isize]

Trait Implementations

impl Arbitrary for Subquotient

type Parameters = SubquotientArbParams

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Subquotient>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Subquotient

fn clone(&self) -> Subquotient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subquotient

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

Formats the value using the given formatter.

impl Display for Subquotient

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

Formats the value using the given formatter.