Enum JacobiSymbol 

#[repr(i8)]
pub enum JacobiSymbol {
    Zero = 0,
    One = 1,
    MinusOne = -1,
}

Possible return values for Jacobi symbol calculations.

Variants

Zero = 0

The two arguments are not coprime, they have a common divisor apart from 1.

One = 1

The two arguments are coprime. If the lower argument is prime, then the upper argument is quadratic residue modulo the lower argument. Otherwise, the upper argument is known to be quadratic nonresidue for an even number of prime factors of the lower argument.

MinusOne = -1

The two terms are coprime, and the upper argument is a quadratic nonresidue modulo the lower argument.

Implementations

impl JacobiSymbol

pub const fn is_zero(&self) -> Choice

Determine if the symbol is zero.

pub const fn is_one(&self) -> Choice

Determine if the symbol is one.

pub const fn is_minus_one(&self) -> Choice

Determine if the symbol is minus one.

pub const fn neg(self) -> Self

Negate the symbol.

Trait Implementations

impl Clone for JacobiSymbol

fn clone(&self) -> JacobiSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for JacobiSymbol

Available on crate feature subtle only.

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 CtEq for JacobiSymbol

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

Determine if self is equal to other in constant-time.

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

Determine if self is NOT equal to other in constant-time.

impl Debug for JacobiSymbol

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

Formats the value using the given formatter.

impl From<JacobiSymbol> for i8

fn from(symbol: JacobiSymbol) -> i8

Converts to this type from the input type.

impl Neg for JacobiSymbol

type Output = JacobiSymbol

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for JacobiSymbol

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 Copy for JacobiSymbol

impl Eq for JacobiSymbol