Struct ibig::UBig

pub struct UBig(_);

Unsigned big integer.

Arbitrarily large unsigned integer.

Examples

let a = ubig!(a2a123bbb127779cccc123123ccc base 32);
let b = ubig!(0x1231abcd4134);
let c = UBig::from_str_radix("a2a123bbb127779cccc123123ccc", 32)?;
let d = UBig::from_str_radix("1231abcd4134", 16)?;
assert_eq!(a, c);
assert_eq!(b, d);

Implementations

impl UBig

pub fn bit(&self, n: usize) -> bool

Returns true if the n-th bit is set.

Examples

assert_eq!(ubig!(0b10010).bit(1), true);
assert_eq!(ubig!(0b10010).bit(3), false);
assert_eq!(ubig!(0b10010).bit(100), false);

pub fn set_bit(&mut self, n: usize)

Set the n-th bit.

Examples

let mut a = ubig!(0b100);
a.set_bit(0);
assert_eq!(a, ubig!(0b101));
a.set_bit(10);
assert_eq!(a, ubig!(0b10000000101));

pub fn clear_bit(&mut self, n: usize)

Clear the n-th bit.

Examples

let mut a = ubig!(0b101);
a.clear_bit(0);
assert_eq!(a, ubig!(0b100));

pub fn trailing_zeros(&self) -> Option<usize>

Returns the number of trailing zeros in the binary representation.

In other words, it is the smallest n such that 2 to the power of n divides the number.

For 0, it returns None.

Examples

assert_eq!(ubig!(17).trailing_zeros(), Some(0));
assert_eq!(ubig!(48).trailing_zeros(), Some(4));
assert_eq!(ubig!(0b101000000).trailing_zeros(), Some(6));
assert_eq!(ubig!(0).trailing_zeros(), None);

pub fn bit_len(&self) -> usize

Bit length.

The length of the binary representation of the number.

For 0, the length is 0.

For non-zero numbers it is:

• in_radix(2).to_string().len()
• the index of the top 1 bit plus one
• the floor of the logarithm base 2 of the number plus one.

Examples

assert_eq!(ubig!(17).bit_len(), 5);
assert_eq!(ubig!(0b101000000).bit_len(), 9);
assert_eq!(ubig!(0).bit_len(), 0);
let x = ubig!(_0x90ffff3450897234);
assert_eq!(x.bit_len(), x.in_radix(2).to_string().len());

pub fn is_power_of_two(&self) -> bool

True if the number is a power of 2.

Examples

assert_eq!(ubig!(0).is_power_of_two(), false);
assert_eq!(ubig!(8).is_power_of_two(), true);
assert_eq!(ubig!(9).is_power_of_two(), false);

impl UBig

pub fn from_le_bytes(bytes: &[u8]) -> UBig

Construct from little-endian bytes.

Examples

assert_eq!(UBig::from_le_bytes(&[3, 2, 1]), ubig!(0x010203));

pub fn from_be_bytes(bytes: &[u8]) -> UBig

Construct from big-endian bytes.

Examples

assert_eq!(UBig::from_be_bytes(&[1, 2, 3]), ubig!(0x010203));

pub fn to_le_bytes(&self) -> Vec<u8>

Return little-endian bytes.

Examples

assert!(ubig!(0).to_le_bytes().is_empty());
assert_eq!(ubig!(0x010203).to_le_bytes(), [3, 2, 1]);

pub fn to_be_bytes(&self) -> Vec<u8>

Return big-endian bytes.

Examples

assert!(ubig!(0).to_be_bytes().is_empty());
assert_eq!(ubig!(0x010203).to_be_bytes(), [1, 2, 3]);

pub fn to_f32(&self) -> f32

Convert to f32.

Round to nearest, breaking ties to even last bit.

Examples

assert_eq!(ubig!(134).to_f32(), 134.0f32);

pub fn to_f64(&self) -> f64

Convert to f64.

Round to nearest, breaking ties to even last bit.

Examples

assert_eq!(ubig!(134).to_f64(), 134.0f64);

impl UBig

pub fn in_radix(&self, radix: u32) -> InRadix<'_>

Representation in a given radix.

Panics

Panics if radix is not between 2 and 36 inclusive.

Examples

assert_eq!(format!("{}", ubig!(83).in_radix(3)), "10002");
assert_eq!(format!("{:+010}", ubig!(35).in_radix(36)), "+00000000z");

impl UBig

pub fn from_str_radix(src: &str, radix: u32) -> Result<UBig, ParseError>

Convert a string in a given base to UBig.

src may contain an optional + prefix. Digits 10-35 are represented by a-z or A-Z.

Panics

Panics if radix is not between 2 and 36 inclusive.

Examples

assert_eq!(UBig::from_str_radix("+7ab", 32)?, ubig!(7499));

pub fn from_str_with_radix_prefix(src: &str) -> Result<UBig, ParseError>

Convert a string with an optional radix prefix to UBig.

src may contain an optional + after the radix prefix.

Allowed prefixes: 0b for binary, 0o for octal, 0x for hexadecimal.

Examples

assert_eq!(UBig::from_str_with_radix_prefix("+0o17")?, ubig!(0o17));
assert_eq!(UBig::from_str_with_radix_prefix("0x1f")?, ubig!(0x1f));

impl UBig

pub fn pow(&self, exp: usize) -> UBig

Raises self to the power of exp.

Example

assert_eq!(ubig!(3).pow(3), ubig!(27));

impl UBig

pub const MAX_BIT_LEN: usize

Maximum length in bits.

UBigs up to this length are supported. Creating a longer number will panic.

This does not guarantee that there is sufficient memory to store numbers up to this length. Memory allocation may fail even for smaller numbers.

The fact that this limit fits in usize guarantees that all bit addressing operations can be performed using usize.

It is typically close to usize::MAX, but the exact value is platform-dependent.

Trait Implementations

impl Add<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the + operator.

fn add(self, rhs: &UBig) -> UBig

Performs the + operation.

impl Add<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the + operator.

fn add(self, rhs: &UBig) -> UBig

Performs the + operation.

impl Add<UBig> for UBig

type Output = UBig

The resulting type after applying the + operator.

fn add(self, rhs: UBig) -> UBig

Performs the + operation.

impl Add<UBig> for &UBig

type Output = UBig

The resulting type after applying the + operator.

fn add(self, rhs: UBig) -> UBig

Performs the + operation.

impl AddAssign<&'_ UBig> for UBig

fn add_assign(&mut self, rhs: &UBig)

Performs the += operation.

impl AddAssign<UBig> for UBig

fn add_assign(&mut self, rhs: UBig)

Performs the += operation.

impl AndNot<&'_ UBig> for UBig

type Output = UBig

fn and_not(self, rhs: &UBig) -> UBig

impl AndNot<&'_ UBig> for &UBig

type Output = UBig

fn and_not(self, rhs: &UBig) -> UBig

impl AndNot<UBig> for UBig

type Output = UBig

fn and_not(self, rhs: UBig) -> UBig

impl AndNot<UBig> for &UBig

type Output = UBig

fn and_not(self, rhs: UBig) -> UBig

impl Binary for UBig

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

Formats the value using the given formatter.

impl BitAnd<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the & operator.

fn bitand(self, rhs: &UBig) -> UBig

Performs the & operation.

impl BitAnd<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the & operator.

fn bitand(self, rhs: &UBig) -> UBig

Performs the & operation.

impl BitAnd<UBig> for UBig

type Output = UBig

The resulting type after applying the & operator.

fn bitand(self, rhs: UBig) -> UBig

Performs the & operation.

impl BitAnd<UBig> for &UBig

type Output = UBig

The resulting type after applying the & operator.

fn bitand(self, rhs: UBig) -> UBig

Performs the & operation.

impl BitAndAssign<&'_ UBig> for UBig

fn bitand_assign(&mut self, rhs: &UBig)

Performs the &= operation.

impl BitAndAssign<UBig> for UBig

fn bitand_assign(&mut self, rhs: UBig)

Performs the &= operation.

impl BitOr<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the | operator.

fn bitor(self, rhs: &UBig) -> UBig

Performs the | operation.

impl BitOr<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the | operator.

fn bitor(self, rhs: &UBig) -> UBig

Performs the | operation.

impl BitOr<UBig> for UBig

type Output = UBig

The resulting type after applying the | operator.

fn bitor(self, rhs: UBig) -> UBig

Performs the | operation.

impl BitOr<UBig> for &UBig

type Output = UBig

The resulting type after applying the | operator.

fn bitor(self, rhs: UBig) -> UBig

Performs the | operation.

impl BitOrAssign<&'_ UBig> for UBig

fn bitor_assign(&mut self, rhs: &UBig)

Performs the |= operation.

impl BitOrAssign<UBig> for UBig

fn bitor_assign(&mut self, rhs: UBig)

Performs the |= operation.

impl BitXor<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &UBig) -> UBig

Performs the ^ operation.

impl BitXor<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &UBig) -> UBig

Performs the ^ operation.

impl BitXor<UBig> for UBig

type Output = UBig

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: UBig) -> UBig

Performs the ^ operation.

impl BitXor<UBig> for &UBig

type Output = UBig

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: UBig) -> UBig

Performs the ^ operation.

impl BitXorAssign<&'_ UBig> for UBig

fn bitxor_assign(&mut self, rhs: &UBig)

Performs the ^= operation.

impl BitXorAssign<UBig> for UBig

fn bitxor_assign(&mut self, rhs: UBig)

Performs the ^= operation.

impl Clone for UBig

fn clone(&self) -> UBig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UBig

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

Formats the value using the given formatter.

impl Default for UBig

fn default() -> UBig

Default value: 0.

impl Display for UBig

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

Formats the value using the given formatter.

impl Div<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the / operator.

fn div(self, rhs: &UBig) -> UBig

Performs the / operation.

impl Div<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the / operator.

fn div(self, rhs: &UBig) -> UBig

Performs the / operation.

impl Div<UBig> for UBig

type Output = UBig

The resulting type after applying the / operator.

fn div(self, rhs: UBig) -> UBig

Performs the / operation.

impl Div<UBig> for &UBig

type Output = UBig

The resulting type after applying the / operator.

fn div(self, rhs: UBig) -> UBig

Performs the / operation.

impl DivAssign<&'_ UBig> for UBig

fn div_assign(&mut self, rhs: &UBig)

Performs the /= operation.

impl DivAssign<UBig> for UBig

fn div_assign(&mut self, rhs: UBig)

Performs the /= operation.

impl DivEuclid<&'_ UBig> for UBig

type Output = UBig

fn div_euclid(self, rhs: &UBig) -> UBig

impl DivEuclid<&'_ UBig> for &UBig

type Output = UBig

fn div_euclid(self, rhs: &UBig) -> UBig

impl DivEuclid<UBig> for UBig

type Output = UBig

fn div_euclid(self, rhs: UBig) -> UBig

impl DivEuclid<UBig> for &UBig

type Output = UBig

fn div_euclid(self, rhs: UBig) -> UBig

impl DivRem<&'_ UBig> for UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem(self, rhs: &UBig) -> (UBig, UBig)

impl DivRem<&'_ UBig> for &UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem(self, rhs: &UBig) -> (UBig, UBig)

impl DivRem<UBig> for UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem(self, rhs: UBig) -> (UBig, UBig)

impl DivRem<UBig> for &UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem(self, rhs: UBig) -> (UBig, UBig)

impl DivRemEuclid<&'_ UBig> for UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem_euclid(self, rhs: &UBig) -> (UBig, UBig)

impl DivRemEuclid<&'_ UBig> for &UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem_euclid(self, rhs: &UBig) -> (UBig, UBig)

impl DivRemEuclid<UBig> for UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem_euclid(self, rhs: UBig) -> (UBig, UBig)

impl DivRemEuclid<UBig> for &UBig

type OutputDiv = UBig

type OutputRem = UBig

fn div_rem_euclid(self, rhs: UBig) -> (UBig, UBig)

impl Eq for UBig

impl From<&'_ UBig> for IBig

fn from(x: &UBig) -> IBig

Performs the conversion.

impl From<UBig> for IBig

fn from(x: UBig) -> IBig

Performs the conversion.

impl From<bool> for UBig

fn from(b: bool) -> UBig

Performs the conversion.

impl From<u128> for UBig

fn from(value: u128) -> UBig

Performs the conversion.

impl From<u16> for UBig

fn from(value: u16) -> UBig

Performs the conversion.

impl From<u32> for UBig

fn from(value: u32) -> UBig

Performs the conversion.

impl From<u64> for UBig

fn from(value: u64) -> UBig

Performs the conversion.

impl From<u8> for UBig

fn from(value: u8) -> UBig

Performs the conversion.

impl From<usize> for UBig

fn from(value: usize) -> UBig

Performs the conversion.

impl FromStr for UBig

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UBig, ParseError>

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

impl Hash for UBig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoModulo for UBig

fn into_modulo(self, ring: &ModuloRing) -> Modulo<'_>

impl IntoModulo for &UBig

fn into_modulo(self, ring: &ModuloRing) -> Modulo<'_>

impl LowerHex for UBig

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

Formats the value using the given formatter.

impl Mul<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the * operator.

fn mul(self, rhs: &UBig) -> UBig

Performs the * operation.

impl Mul<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the * operator.

fn mul(self, rhs: &UBig) -> UBig

Performs the * operation.

impl Mul<UBig> for UBig

type Output = UBig

The resulting type after applying the * operator.

fn mul(self, rhs: UBig) -> UBig

Performs the * operation.

impl Mul<UBig> for &UBig

type Output = UBig

The resulting type after applying the * operator.

fn mul(self, rhs: UBig) -> UBig

Performs the * operation.

impl MulAssign<&'_ UBig> for UBig

fn mul_assign(&mut self, rhs: &UBig)

Performs the *= operation.

impl MulAssign<UBig> for UBig

fn mul_assign(&mut self, rhs: UBig)

Performs the *= operation.

impl NextPowerOfTwo for UBig

type Output = UBig

fn next_power_of_two(self) -> UBig

impl NextPowerOfTwo for &UBig

type Output = UBig

fn next_power_of_two(self) -> UBig

impl Num for UBig

type FromStrRadixErr = ParseError

fn from_str_radix(s: &str, radix: u32) -> Result<Self, ParseError>

Convert from a string and radix (typically 2..=36).

impl Octal for UBig

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

Formats the value using the given formatter.

impl One for UBig

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

pub fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

pub fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl Ord for UBig

fn cmp(&self, other: &UBig) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<UBig> for UBig

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

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

fn ne(&self, other: &UBig) -> bool

This method tests for !=.

impl PartialOrd<UBig> for UBig

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Pow<usize> for UBig

type Output = UBig

The result after applying the operator.

fn pow(self, rhs: usize) -> UBig

Returns self to the power rhs.

impl Pow<usize> for &UBig

type Output = UBig

The result after applying the operator.

fn pow(self, rhs: usize) -> UBig

Returns self to the power rhs.

impl Rem<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the % operator.

fn rem(self, rhs: &UBig) -> UBig

Performs the % operation.

impl Rem<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the % operator.

fn rem(self, rhs: &UBig) -> UBig

Performs the % operation.

impl Rem<UBig> for UBig

type Output = UBig

The resulting type after applying the % operator.

fn rem(self, rhs: UBig) -> UBig

Performs the % operation.

impl Rem<UBig> for &UBig

type Output = UBig

The resulting type after applying the % operator.

fn rem(self, rhs: UBig) -> UBig

Performs the % operation.

impl RemAssign<&'_ UBig> for UBig

fn rem_assign(&mut self, rhs: &UBig)

Performs the %= operation.

impl RemAssign<UBig> for UBig

fn rem_assign(&mut self, rhs: UBig)

Performs the %= operation.

impl RemEuclid<&'_ UBig> for UBig

type Output = UBig

fn rem_euclid(self, rhs: &UBig) -> UBig

impl RemEuclid<&'_ UBig> for &UBig

type Output = UBig

fn rem_euclid(self, rhs: &UBig) -> UBig

impl RemEuclid<UBig> for UBig

type Output = UBig

fn rem_euclid(self, rhs: UBig) -> UBig

impl RemEuclid<UBig> for &UBig

type Output = UBig

fn rem_euclid(self, rhs: UBig) -> UBig

impl SampleUniform for UBig

type Sampler = UniformUBig

The UniformSampler implementation supporting type X.

impl Shl<&'_ usize> for UBig

type Output = UBig

The resulting type after applying the << operator.

fn shl(self, rhs: &usize) -> UBig

Performs the << operation.

impl Shl<&'_ usize> for &UBig

type Output = UBig

The resulting type after applying the << operator.

fn shl(self, rhs: &usize) -> UBig

Performs the << operation.

impl Shl<usize> for UBig

type Output = UBig

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> UBig

Performs the << operation.

impl Shl<usize> for &UBig

type Output = UBig

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> UBig

Performs the << operation.

impl ShlAssign<&'_ usize> for UBig

fn shl_assign(&mut self, rhs: &usize)

Performs the <<= operation.

impl ShlAssign<usize> for UBig

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<&'_ usize> for UBig

type Output = UBig

The resulting type after applying the >> operator.

fn shr(self, rhs: &usize) -> UBig

Performs the >> operation.

impl Shr<&'_ usize> for &UBig

type Output = UBig

The resulting type after applying the >> operator.

fn shr(self, rhs: &usize) -> UBig

Performs the >> operation.

impl Shr<usize> for UBig

type Output = UBig

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> UBig

Performs the >> operation.

impl Shr<usize> for &UBig

type Output = UBig

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> UBig

Performs the >> operation.

impl ShrAssign<&'_ usize> for UBig

fn shr_assign(&mut self, rhs: &usize)

Performs the >>= operation.

impl ShrAssign<usize> for UBig

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl StructuralEq for UBig

impl StructuralPartialEq for UBig

impl Sub<&'_ UBig> for UBig

type Output = UBig

The resulting type after applying the - operator.

fn sub(self, rhs: &UBig) -> UBig

Performs the - operation.

impl Sub<&'_ UBig> for &UBig

type Output = UBig

The resulting type after applying the - operator.

fn sub(self, rhs: &UBig) -> UBig

Performs the - operation.

impl Sub<UBig> for UBig

type Output = UBig

The resulting type after applying the - operator.

fn sub(self, rhs: UBig) -> UBig

Performs the - operation.

impl Sub<UBig> for &UBig

type Output = UBig

The resulting type after applying the - operator.

fn sub(self, rhs: UBig) -> UBig

Performs the - operation.

impl SubAssign<&'_ UBig> for UBig

fn sub_assign(&mut self, rhs: &UBig)

Performs the -= operation.

impl SubAssign<UBig> for UBig

fn sub_assign(&mut self, rhs: UBig)

Performs the -= operation.

impl TryFrom<&'_ IBig> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(x: &IBig) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(x: IBig) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<i128> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<i16> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<i32> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<i64> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<i8> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<isize> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl Unsigned for UBig

impl UpperHex for UBig

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

Formats the value using the given formatter.

impl Zero for UBig

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.