Struct Odd 

pub struct Odd<T>(/* private fields */);

Wrapper type for odd integers.

These are frequently used in cryptography, e.g. as a modulus.

Implementations

impl<T> Odd<T>

pub fn new(n: T) -> CtOption<Self>

where T: Integer,

Create a new odd integer.

pub const fn as_ref(&self) -> &T

Provides access to the contents of Odd in a const context.

pub const fn as_nz_ref(&self) -> &NonZero<T>

All odd integers are definitionally non-zero, so we can also obtain a reference to NonZero.

pub fn get(self) -> T

Returns the inner value.

impl<const LIMBS: usize> Odd<Uint<LIMBS>>

pub const fn from_be_hex(hex: &str) -> Self

Create a new Odd<Uint<LIMBS>> from the provided big endian hex string.

Panics if the hex is malformed or not zero-padded accordingly for the size, or if the value is even.

pub const fn from_le_hex(hex: &str) -> Self

Create a new Odd<Uint<LIMBS>> from the provided little endian hex string.

Panics if the hex is malformed or not zero-padded accordingly for the size, or if the value is even.

impl<const SAT_LIMBS: usize, const UNSAT_LIMBS: usize> Odd<Uint<SAT_LIMBS>>

where Self: PrecomputeInverter<Inverter = SafeGcdInverter<SAT_LIMBS, UNSAT_LIMBS>>,

pub const fn gcd_vartime(&self, rhs: &Uint<SAT_LIMBS>) -> Uint<SAT_LIMBS>

Compute the greatest common divisor (GCD) of this number and another.

Runs in variable time with respect to rhs.

Trait Implementations

impl<T> AsRef<[Limb]> for Odd<T>

where T: AsRef<[Limb]>,

fn as_ref(&self) -> &[Limb]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<NonZero<T>> for Odd<T>

fn as_ref(&self) -> &NonZero<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<T> for Odd<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Binary for Odd<T>

where T: Binary,

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

Formats the value using the given formatter.

impl<T: Clone> Clone for Odd<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> ConditionallySelectable for Odd<T>

where T: ConditionallySelectable,

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl<T> ConstantTimeEq for Odd<T>

where T: ConstantTimeEq,

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<T: Debug> Debug for Odd<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Odd<T>

fn default() -> Odd<T>

Returns the “default value” for a type.

impl<T> Deref for Odd<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Display for Odd<T>

where T: Display,

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

Formats the value using the given formatter.

impl<const SAT_LIMBS: usize, const UNSAT_LIMBS: usize> Gcd<Uint<SAT_LIMBS>> for Odd<Uint<SAT_LIMBS>>

where Odd<Self>: PrecomputeInverter<Inverter = SafeGcdInverter<SAT_LIMBS, UNSAT_LIMBS>>,

type Output = Uint<SAT_LIMBS>

Output type.

fn gcd(&self, rhs: &Uint<SAT_LIMBS>) -> Uint<SAT_LIMBS>

Compute the greatest common divisor of self and rhs.

fn gcd_vartime(&self, rhs: &Uint<SAT_LIMBS>) -> Self::Output

Compute the greatest common divisor of self and rhs in variable time.

impl<T: Hash> Hash for Odd<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> LowerHex for Odd<T>

where T: LowerHex,

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

Formats the value using the given formatter.

impl<T> Octal for Odd<T>

where T: Octal,

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Odd<T>

fn cmp(&self, other: &Odd<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const LIMBS: usize> PartialEq<Odd<Uint<LIMBS>>> for Uint<LIMBS>

fn eq(&self, other: &Odd<Uint<LIMBS>>) -> 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: PartialEq> PartialEq for Odd<T>

fn eq(&self, other: &Odd<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<const LIMBS: usize> PartialOrd<Odd<Uint<LIMBS>>> for Uint<LIMBS>

fn partial_cmp(&self, other: &Odd<Uint<LIMBS>>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialOrd> PartialOrd for Odd<T>

fn partial_cmp(&self, other: &Odd<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PrecomputeInverter for Odd<U64>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U128>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U704>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U768>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U832>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U896>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U960>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U1024>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U1280>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U1536>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U1792>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U2048>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U192>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U3072>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U3584>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U4096>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U4224>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U4352>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U6144>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U8192>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U16384>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U32768>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U256>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U320>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U384>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U448>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U512>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U576>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl PrecomputeInverter for Odd<U640>

Precompute a Bernstein-Yang inverter using self as the modulus.

type Inverter = SafeGcdInverter<{ nlimbs!($bits) }, { safegcd_nlimbs!($bits as usize) }>

Inverter type for integers of this size.

type Output = Uint<{ nlimbs!($bits) }>

Output produced by the inverter.

fn precompute_inverter(&self) -> Self::Inverter

Obtain a precomputed inverter for &self as the modulus, using Self::one() as an adjusting parameter.

impl<T> UpperHex for Odd<T>

where T: UpperHex,

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Odd<T>

impl<T: Eq> Eq for Odd<T>

impl<T> StructuralPartialEq for Odd<T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.