Struct FPModule 

pub struct FPModule<A: Algebra> {
    name: String,
    min_degree: i32,
    generators: Arc<FreeModule<A>>,
    relations: Arc<FreeModule<A>>,
    map: Arc<FreeModuleHomomorphism<FreeModule<A>>>,
    index_table: OnceBiVec<FPMIndexTable>,
}

Fields

name: String

min_degree: i32

generators: Arc<FreeModule<A>>

relations: Arc<FreeModule<A>>

map: Arc<FreeModuleHomomorphism<FreeModule<A>>>

index_table: OnceBiVec<FPMIndexTable>

Implementations

impl<A: Algebra> FinitelyPresentedModule<A>

pub fn new(algebra: Arc<A>, name: String, min_degree: i32) -> Self

pub fn generators(&self) -> Arc<FreeModule<A>>

pub fn add_generators(&mut self, degree: i32, gen_names: Vec<String>)

pub fn add_relations(&mut self, degree: i32, relations: Vec<FpVector>)

pub fn gen_idx_to_fp_idx(&self, degree: i32, idx: usize) -> isize

pub fn fp_idx_to_gen_idx(&self, degree: i32, idx: usize) -> usize

impl<A: Algebra> FinitelyPresentedModule<A>

pub fn from_json(algebra: Arc<A>, json: &Value) -> Result<Self>

Trait Implementations

impl<A: Algebra> Display for FinitelyPresentedModule<A>

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

Formats the value using the given formatter.

impl<A: Algebra> Module for FinitelyPresentedModule<A>

type Algebra = A

fn algebra(&self) -> Arc<A>

The algebra the module is over.

fn min_degree(&self) -> i32

The minimum degree of the module, which is required to be bounded below

fn max_computed_degree(&self) -> i32

The maximum t for which the module is fully defined at t. See Module documentation for more details.

fn compute_basis(&self, degree: i32)

Compute internal data of the module so that we can query information up to degree degree. This should be run by the user whenever they want to query such information.

fn dimension(&self, degree: i32) -> usize

The dimension of a module at the given degree

fn act_on_basis( &self, result: FpSliceMut<'_>, coeff: u32, op_degree: i32, op_index: usize, mod_degree: i32, mod_index: usize, )

fn basis_element_to_string(&self, degree: i32, idx: usize) -> String

The name of a basis element. This is useful for debugging and printing results.

fn max_generator_degree(&self) -> Option<i32>

Maximum degree of a generator under the Steenrod action. Every element in higher degree must be obtainable from applying a Steenrod action to a lower degree element.

fn is_unit(&self) -> bool

Whether this is the unit module.

fn prime(&self) -> ValidPrime

The prime the module is over, which should be equal to the prime of the algebra.

fn max_degree(&self) -> Option<i32>

max_degree is the a degree such that if t > max_degree, then self.dimension(t) = 0.

fn total_dimension(&self) -> usize

fn act( &self, result: FpSliceMut<'_>, coeff: u32, op_degree: i32, op_index: usize, input_degree: i32, input: FpSlice<'_>, )

The length of input need not be equal to the dimension of the module in said degree. Missing entries are interpreted to be 0, while extra entries must be zero.

fn act_by_element( &self, result: FpSliceMut<'_>, coeff: u32, op_degree: i32, op: FpSlice<'_>, input_degree: i32, input: FpSlice<'_>, )

fn act_by_element_on_basis( &self, result: FpSliceMut<'_>, coeff: u32, op_degree: i32, op: FpSlice<'_>, input_degree: i32, input_index: usize, )

fn element_to_string(&self, degree: i32, element: FpSlice<'_>) -> String

Gives the name of an element. The default implementation is derived from Module::basis_element_to_string in the obvious way.

impl<A: Algebra> PartialEq for FinitelyPresentedModule<A>

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Algebra> ZeroModule for FinitelyPresentedModule<A>

fn zero_module(algebra: Arc<A>, min_degree: i32) -> Self

impl<A: Algebra> Eq for FinitelyPresentedModule<A>