Struct XgcdOutput 

pub struct XgcdOutput<const LIMBS: usize, GCD: Copy> {
    pub gcd: GCD,
    pub x: Int<LIMBS>,
    pub y: Int<LIMBS>,
    pub lhs_on_gcd: Uint<LIMBS>,
    pub rhs_on_gcd: Uint<LIMBS>,
}

Container for the processed output of the Binary XGCD algorithm.

Fields

gcd: GCD

Greatest common divisor

x: Int<LIMBS>

x;

y: Int<LIMBS>

y;

lhs_on_gcd: Uint<LIMBS>

lhs / gcd

rhs_on_gcd: Uint<LIMBS>

rhs / gcd

Implementations

impl<const LIMBS: usize, GCD: Copy> XgcdOutput<LIMBS, GCD>

pub const fn gcd(&self) -> GCD

The greatest common divisor stored in this object.

pub const fn bezout_coefficients(&self) -> (Int<LIMBS>, Int<LIMBS>)

Obtain a copy of the Bézout coefficients.

pub const fn quotients(&self) -> (Uint<LIMBS>, Uint<LIMBS>)

Obtain a copy of the quotients lhs/gcd and rhs/gcd.

impl<const LIMBS: usize> XgcdOutput<LIMBS, OddUint<LIMBS>>

pub(crate) const fn from_pattern_output( output: RawXgcdOutput<LIMBS, PatternMatrix<LIMBS>>, ) -> Self

pub(crate) const fn to_nz_output( self, k: u32, swap: Choice, ) -> XgcdOutput<LIMBS, NonZeroUint<LIMBS>>

Trait Implementations

impl<const LIMBS: usize, GCD: Clone + Copy> Clone for XgcdOutput<LIMBS, GCD>

fn clone(&self) -> XgcdOutput<LIMBS, GCD>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LIMBS: usize, GCD: Debug + Copy> Debug for XgcdOutput<LIMBS, GCD>

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

Formats the value using the given formatter.

impl<const LIMBS: usize, GCD: Copy + Copy> Copy for XgcdOutput<LIMBS, GCD>