Struct ff_uint::Num

#[repr(transparent)]pub struct Num<Fp: PrimeField>(pub Fp);

Implementations

impl<Fp: PrimeField> Num<Fp>

pub const ZERO: Self

pub const ONE: Self

pub const MODULUS: NumRepr<Fp::Inner>

pub const MODULUS_BITS: u32

pub fn is_even(&self) -> bool

pub fn is_odd(&self) -> bool

pub fn double(self) -> Self

pub fn square(self) -> Self

pub fn new(n: Fp) -> Self

pub fn checked_inv(self) -> Option<Self>

pub fn is_zero(self) -> bool

pub fn from_uint(v: NumRepr<Fp::Inner>) -> Option<Self>

pub fn from_uint_reduced(v: NumRepr<Fp::Inner>) -> Self

pub fn from_mont_uint(v: NumRepr<Fp::Inner>) -> Option<Self>

pub fn from_uint_unchecked(v: NumRepr<Fp::Inner>) -> Self

pub fn from_mont_uint_unchecked(v: NumRepr<Fp::Inner>) -> Self

pub fn sqrt(&self) -> Option<Self>

pub fn even_sqrt(&self) -> Option<Self>

pub fn to_uint(&self) -> NumRepr<Fp::Inner>

pub fn to_mont_uint(&self) -> NumRepr<Fp::Inner>

pub fn as_mont_uint(&self) -> &NumRepr<Fp::Inner>

pub fn as_mont_uint_mut(&mut self) -> &mut NumRepr<Fp::Inner>

pub fn to_other<Fq: PrimeField>(&self) -> Option<Num<Fq>>

pub fn to_other_reduced<Fq: PrimeField>(&self) -> Num<Fq>

Trait Implementations

impl<'macro_lifetime, U: PrimeField> Add<&'macro_lifetime Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the + operator.

fn add(self, other: &'macro_lifetime Num<U>) -> Self::Output

Performs the + operation.

impl<'macro_lifetime_a, 'macro_lifetime_b, U: PrimeField> Add<&'macro_lifetime_a Num<U>> for &'macro_lifetime_b Num<U>

type Output = Num<U>

The resulting type after applying the + operator.

fn add(self, other: &'macro_lifetime_a Num<U>) -> Self::Output

Performs the + operation.

impl<U: PrimeField> Add<Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the + operator.

fn add(self, other: Num<U>) -> Self::Output

Performs the + operation.

impl<'macro_lifetime, U: PrimeField> Add<Num<U>> for &'macro_lifetime Num<U>

type Output = Num<U>

The resulting type after applying the + operator.

fn add(self, other: Num<U>) -> Self::Output

Performs the + operation.

impl<'macro_lifetime, U: PrimeField> AddAssign<&'macro_lifetime Num<U>> for Num<U>

fn add_assign(&mut self, other: &'macro_lifetime Num<U>)

Performs the += operation.

impl<U: PrimeField> AddAssign<Num<U>> for Num<U>

fn add_assign(&mut self, other: Num<U>)

Performs the += operation.

impl<Fp: PrimeField> BitIterBE for Num<Fp>

type Iter = BitIteratorBE<Fp::Inner>

fn bit_iter_be(&self) -> Self::Iter

impl<Fp: PrimeField> BitIterLE for Num<Fp>

type Iter = BitIteratorLE<Fp::Inner>

fn bit_iter_le(&self) -> Self::Iter

impl<Fp: PrimeField> BorshDeserialize for Num<Fp>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

pub fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl<Fp: PrimeField> BorshSerialize for Num<Fp>

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

pub fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it’s worth handling it as a special case to improve performance. It’s a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl<Fp: Clone + PrimeField> Clone for Num<Fp>

fn clone(&self) -> Num<Fp>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Fp: Copy + PrimeField> Copy for Num<Fp>

impl<Fp: PrimeField> Debug for Num<Fp>

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

Formats the value using the given formatter.

impl<'de, Fp: PrimeField> Deserialize<'de> for Num<Fp>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<Fp: PrimeField> Display for Num<Fp>

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

Formats the value using the given formatter.

impl<'macro_lifetime, U: PrimeField> Div<&'macro_lifetime Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the / operator.

fn div(self, other: &'macro_lifetime Num<U>) -> Self::Output

Performs the / operation.

impl<'macro_lifetime_a, 'macro_lifetime_b, U: PrimeField> Div<&'macro_lifetime_a Num<U>> for &'macro_lifetime_b Num<U>

type Output = Num<U>

The resulting type after applying the / operator.

fn div(self, other: &'macro_lifetime_a Num<U>) -> Self::Output

Performs the / operation.

impl<U: PrimeField> Div<Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the / operator.

fn div(self, other: Num<U>) -> Self::Output

Performs the / operation.

impl<'macro_lifetime, U: PrimeField> Div<Num<U>> for &'macro_lifetime Num<U>

type Output = Num<U>

The resulting type after applying the / operator.

fn div(self, other: Num<U>) -> Self::Output

Performs the / operation.

impl<'macro_lifetime, U: PrimeField> DivAssign<&'macro_lifetime Num<U>> for Num<U>

fn div_assign(&mut self, other: &'macro_lifetime Num<U>)

Performs the /= operation.

impl<U: PrimeField> DivAssign<Num<U>> for Num<U>

fn div_assign(&mut self, other: Num<U>)

Performs the /= operation.

impl<Fp: PrimeField> Eq for Num<Fp>

impl<Fp: PrimeField> From<&'static str> for Num<Fp>

fn from(s: &'static str) -> Self

Performs the conversion.

impl<Fp: PrimeField> From<bool> for Num<Fp>

fn from(n: bool) -> Self

Performs the conversion.

impl<Fp: PrimeField> From<i128> for Num<Fp>

fn from(value: i128) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<i16> for Num<Fp>

fn from(value: i16) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<i32> for Num<Fp>

fn from(value: i32) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<i64> for Num<Fp>

fn from(value: i64) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<i8> for Num<Fp>

fn from(value: i8) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<u128> for Num<Fp>

fn from(value: u128) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<u16> for Num<Fp>

fn from(value: u16) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<u32> for Num<Fp>

fn from(value: u32) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<u64> for Num<Fp>

fn from(value: u64) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> From<u8> for Num<Fp>

fn from(value: u8) -> Num<Fp>

Performs the conversion.

impl<Fp: PrimeField> FromStr for Num<Fp>

type Err = <Fp as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Num<Fp>, Self::Err>

Parses a string s to return a value of this type.

impl<'macro_lifetime, U: PrimeField> Mul<&'macro_lifetime Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the * operator.

fn mul(self, other: &'macro_lifetime Num<U>) -> Self::Output

Performs the * operation.

impl<'macro_lifetime_a, 'macro_lifetime_b, U: PrimeField> Mul<&'macro_lifetime_a Num<U>> for &'macro_lifetime_b Num<U>

type Output = Num<U>

The resulting type after applying the * operator.

fn mul(self, other: &'macro_lifetime_a Num<U>) -> Self::Output

Performs the * operation.

impl<U: PrimeField> Mul<Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the * operator.

fn mul(self, other: Num<U>) -> Self::Output

Performs the * operation.

impl<'macro_lifetime, U: PrimeField> Mul<Num<U>> for &'macro_lifetime Num<U>

type Output = Num<U>

The resulting type after applying the * operator.

fn mul(self, other: Num<U>) -> Self::Output

Performs the * operation.

impl<'macro_lifetime, U: PrimeField> MulAssign<&'macro_lifetime Num<U>> for Num<U>

fn mul_assign(&mut self, other: &'macro_lifetime Num<U>)

Performs the *= operation.

impl<U: PrimeField> MulAssign<Num<U>> for Num<U>

fn mul_assign(&mut self, other: Num<U>)

Performs the *= operation.

impl<U: PrimeField> Neg for Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn neg(self) -> Num<U>

Performs the unary - operation.

impl<'macro_lifetime, U: PrimeField> Neg for &'macro_lifetime Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn neg(self) -> Num<U>

Performs the unary - operation.

impl<Fp: PrimeField> PartialEq<Num<Fp>> for Num<Fp>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Fp: PrimeField> RefCast for Num<Fp>

type From = Fp

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl<Fp: PrimeField> Serialize for Num<Fp>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'macro_lifetime, U: PrimeField> Sub<&'macro_lifetime Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn sub(self, other: &'macro_lifetime Num<U>) -> Self::Output

Performs the - operation.

impl<'macro_lifetime_a, 'macro_lifetime_b, U: PrimeField> Sub<&'macro_lifetime_a Num<U>> for &'macro_lifetime_b Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn sub(self, other: &'macro_lifetime_a Num<U>) -> Self::Output

Performs the - operation.

impl<U: PrimeField> Sub<Num<U>> for Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn sub(self, other: Num<U>) -> Self::Output

Performs the - operation.

impl<'macro_lifetime, U: PrimeField> Sub<Num<U>> for &'macro_lifetime Num<U>

type Output = Num<U>

The resulting type after applying the - operator.

fn sub(self, other: Num<U>) -> Self::Output

Performs the - operation.

impl<'macro_lifetime, U: PrimeField> SubAssign<&'macro_lifetime Num<U>> for Num<U>

fn sub_assign(&mut self, other: &'macro_lifetime Num<U>)

Performs the -= operation.

impl<U: PrimeField> SubAssign<Num<U>> for Num<U>

fn sub_assign(&mut self, other: Num<U>)

Performs the -= operation.