Struct Depends 

pub struct Depends<T> { /* private fields */ }

A quantity on every residue class of the generator. See the module documentation.

Implementations

impl<T: Clone + PartialEq> Depends<T>

pub fn constant(v: T, ty: &ResidueType) -> Depends<T>

pub fn from_fn( m: u64, ty: &ResidueType, f: impl Fn(u64) -> T, ) -> Result<Depends<T>, ResidueError>

The quantity f(H mod m) on the classes the type admits; refused when m and the type’s modulus together pass MAX_MODULUS.

pub fn from_branches( ty: ResidueType, m: u64, raw: Vec<Option<T>>, ) -> Option<Depends<T>>

Rebuild a quantity from its value on every class modulo m (None exactly for the classes ty rules out), held at its smallest modulus; None when the classes and the type disagree.

pub fn raw_branches(&self) -> Vec<Option<T>>

The value on every class modulo Depends::modulus, None for a class the type rules out.

pub fn modulus(&self) -> u64

pub fn residue_type(&self) -> &ResidueType

pub fn single(&self) -> Option<&T>

The value, when every admitted class has the same one.

pub fn at(&self, h: u64) -> Option<&T>

The value at H = h; None when the type rules h out.

pub fn branches(&self) -> impl Iterator<Item = (u64, &T)>

The admitted classes and their values, by residue.

pub fn map<U: Clone + PartialEq>(&self, f: impl Fn(&T) -> U) -> Depends<U>

pub fn zip_with<U: Clone + PartialEq, V: Clone + PartialEq>( &self, o: &Depends<U>, f: impl Fn(&T, &U) -> V, ) -> Result<Depends<V>, ResidueError>

Combine two quantities branch by branch; refused when their classes together pass MAX_MODULUS or their types admit no common class.

pub fn render(&self, generator: &str, show: impl Fn(&T) -> String) -> String

v alone when it is single; otherwise the dependence on the generator, written generator: 0 when ⌈1/dt⌉ is even, 1 when it is odd, or one clause per class modulo the modulus.

impl Depends<Algebraic>

pub fn apply(&self, rule: LimitRule) -> Result<Algebraic, String>

The value under rule, the generator written ⌈1/dt⌉ in an error.

pub fn apply_with( &self, rule: LimitRule, generator: &str, ) -> Result<Algebraic, String>

The value under rule; an error naming the dependence (the generator written generator) when the rule demands a limit that does not exist.

Trait Implementations

impl<T: Clone> Clone for Depends<T>

fn clone(&self) -> Depends<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Depends<T>

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

Formats the value using the given formatter.

impl<T: ExactCodec + Clone + PartialEq> ExactCodec for Depends<T>

fn write(&self, out: &mut Vec<u8>)

The residue type, the modulus, then each class’s value (0 for a class the type rules out, 1 and the value otherwise).

fn read(buf: &[u8], pos: &mut usize) -> Option<Self>

fn to_bytes(&self) -> Vec<u8>

fn from_bytes(buf: &[u8]) -> Option<Self>

The value buf canonically encodes, with nothing left over.

impl<T: Hash> Hash for Depends<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for Depends<T>

fn eq(&self, other: &Depends<T>) -> 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<T: Eq> Eq for Depends<T>

impl<T> StructuralPartialEq for Depends<T>