Struct ResidueType 

pub struct ResidueType { /* private fields */ }

The residues the infinite generator may take. See the module documentation.

Implementations

impl ResidueType

pub fn any() -> ResidueType

Nothing is known.

pub fn congruent(r: u64, m: u64) -> ResidueType

H ≡ r (mod m).

Panics

When m is 0 or above MAX_MODULUS; a modulus a program supplies goes through ResidueType::from_allowed, which refuses it instead.

pub fn modulus(&self) -> u64

pub fn admits(&self, x: u64) -> bool

Whether H = x is consistent with the type.

pub fn allows(&self, r: u64, m: u64) -> bool

Whether some admitted H has H ≡ r (mod m). By the Chinese remainder theorem that is an admitted class s with s ≡ r modulo gcd(m, modulus), so any m is answered in time linear in the type’s own modulus.

pub fn from_allowed( m: u64, allowed: &[u64], ) -> Result<ResidueType, ResidueError>

The type allowing exactly allowed modulo m (residues reduce modulo m): a contradiction when nothing is allowed, too fine when m passes MAX_MODULUS.

pub fn residues(&self) -> Vec<u64>

The allowed residues modulo ResidueType::modulus, ascending.

pub fn and(&self, o: &ResidueType) -> Result<ResidueType, ResidueError>

Both facts at once.

Trait Implementations

impl Clone for ResidueType

fn clone(&self) -> ResidueType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResidueType

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

Formats the value using the given formatter.

impl ExactCodec for ResidueType

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

The modulus, then the allowed residues.

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 Hash for ResidueType

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 PartialEq for ResidueType

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

impl StructuralPartialEq for ResidueType