Struct Integer

pub struct Integer<E: Environment, I: IntegerType> { /* private fields */ }

Implementations

impl<E: Environment, I: IntegerType> Integer<E, I>

pub fn from_field_lossy(field: &Field<E>) -> Self

Casts an integer from a base field, with lossy truncation.

This method is commonly-used by hash-to-integer algorithms, where the hash output does not need to preserve the full base field.

impl<E: Environment, I: IntegerType> Integer<E, I>

pub fn to_scalar(&self) -> Scalar<E>

Converts an integer into a scalar.

impl<E: Environment, I: IntegerType> Integer<E, I>

pub const MAX: Self = _

pub const MIN: Self = _

pub const fn new(integer: I) -> Self

Initializes a new integer.

Trait Implementations

impl<E: Environment, I: IntegerType> AbsChecked for Integer<E, I>

fn abs_checked(self) -> Self::Output

Returns the absolute value of self.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> AbsWrapped for Integer<E, I>

fn abs_wrapped(self) -> Self::Output

Returns the absolute value of self.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Add<&Integer<E, I>> for Integer<E, I>

fn add(self, other: &Integer<E, I>) -> Self::Output

Returns the sum of self and other.

type Output = Integer<E, I>

The resulting type after applying the + operator.

impl<E: Environment, I: IntegerType> Add for Integer<E, I>

fn add(self, other: Integer<E, I>) -> Self::Output

Returns the sum of self and other.

type Output = Integer<E, I>

The resulting type after applying the + operator.

impl<E: Environment, I: IntegerType> AddAssign<&Integer<E, I>> for Integer<E, I>

fn add_assign(&mut self, other: &Integer<E, I>)

Adds other to self.

impl<E: Environment, I: IntegerType> AddAssign for Integer<E, I>

fn add_assign(&mut self, other: Integer<E, I>)

Adds other to self.

impl<E: Environment, I: IntegerType> AddWrapped for Integer<E, I>

fn add_wrapped(&self, other: &Integer<E, I>) -> Self::Output

Returns the sum of self and other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> BitAnd<&Integer<E, I>> for Integer<E, I>

fn bitand(self, other: &Integer<E, I>) -> Self::Output

Returns the bitwise AND of self and other.

type Output = Integer<E, I>

The resulting type after applying the & operator.

impl<E: Environment, I: IntegerType> BitAnd for Integer<E, I>

fn bitand(self, other: Self) -> Self::Output

Returns the bitwise AND of self and other.

type Output = Integer<E, I>

The resulting type after applying the & operator.

impl<E: Environment, I: IntegerType> BitAndAssign for Integer<E, I>

fn bitand_assign(&mut self, other: Self)

Performs the bitwise AND of self and other and assigns the result to self.

impl<E: Environment, I: IntegerType> BitOr<&Integer<E, I>> for Integer<E, I>

fn bitor(self, other: &Integer<E, I>) -> Self::Output

Returns the bitwise OR of self and other.

type Output = Integer<E, I>

The resulting type after applying the | operator.

impl<E: Environment, I: IntegerType> BitOr for Integer<E, I>

fn bitor(self, other: Self) -> Self::Output

Returns the bitwise OR of self and other.

type Output = Integer<E, I>

The resulting type after applying the | operator.

impl<E: Environment, I: IntegerType> BitOrAssign for Integer<E, I>

fn bitor_assign(&mut self, other: Self)

Performs the bitwise OR of self and other and assigns the result to self.

impl<E: Environment, I: IntegerType> BitXor<&Integer<E, I>> for Integer<E, I>

fn bitxor(self, other: &Integer<E, I>) -> Self::Output

Returns the bitwise XOR of self and other.

type Output = Integer<E, I>

The resulting type after applying the ^ operator.

impl<E: Environment, I: IntegerType> BitXor for Integer<E, I>

fn bitxor(self, other: Self) -> Self::Output

Returns the bitwise XOR of self and other.

type Output = Integer<E, I>

The resulting type after applying the ^ operator.

impl<E: Environment, I: IntegerType> BitXorAssign for Integer<E, I>

fn bitxor_assign(&mut self, other: Self)

Performs the bitwise XOR of self and other and assigns the result to self.

impl<E: Clone + Environment, I: Clone + IntegerType> Clone for Integer<E, I>

fn clone(&self) -> Integer<E, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Environment, I: IntegerType> Compare for Integer<E, I>

fn is_less_than(&self, other: &Self) -> Self::Output

Returns true if self is less than other.

fn is_greater_than(&self, other: &Self) -> Self::Output

Returns true if self is greater than other.

fn is_less_than_or_equal(&self, other: &Self) -> Self::Output

Returns true if self is less than or equal to other.

fn is_greater_than_or_equal(&self, other: &Self) -> Self::Output

Returns true if self is greater than or equal to other.

type Output = Boolean<E>

impl<E: Environment, I: IntegerType> Debug for Integer<E, I>

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

Formats the value using the given formatter.

impl<E: Environment, I: IntegerType> Deref for Integer<E, I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, E: Environment, I: IntegerType> Deserialize<'de> for Integer<E, I>

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

Deserializes the integer from a string or bytes.

impl<E: Environment, I: IntegerType> Display for Integer<E, I>

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

Formats the value using the given formatter.

impl<E: Environment, I: IntegerType> Distribution<Integer<E, I>> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Integer<E, I>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<E: Environment, I: IntegerType> Div<&Integer<E, I>> for Integer<E, I>

fn div(self, other: &Integer<E, I>) -> Self::Output

Returns the quotient of self and other.

type Output = Integer<E, I>

The resulting type after applying the / operator.

impl<E: Environment, I: IntegerType> Div for Integer<E, I>

fn div(self, other: Integer<E, I>) -> Self::Output

Returns the quotient of self and other.

type Output = Integer<E, I>

The resulting type after applying the / operator.

impl<E: Environment, I: IntegerType> DivAssign<&Integer<E, I>> for Integer<E, I>

fn div_assign(&mut self, other: &Integer<E, I>)

Divides self by other.

impl<E: Environment, I: IntegerType> DivAssign for Integer<E, I>

fn div_assign(&mut self, other: Integer<E, I>)

Divides self by other.

impl<E: Environment, I: IntegerType> DivWrapped for Integer<E, I>

fn div_wrapped(&self, other: &Integer<E, I>) -> Self::Output

Returns the quotient of self and other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Equal for Integer<E, I>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

impl<E: Environment, I: IntegerType> FromBits for Integer<E, I>

fn from_bits_le(bits_le: &[bool]) -> Result<Self>

Initializes a new integer from a list of little-endian bits.

fn from_bits_be(bits_be: &[bool]) -> Result<Self>

Initializes a new integer from a list of big-endian bits.

impl<E: Environment, I: IntegerType> FromBytes for Integer<E, I>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the integer from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<E: Environment, I: IntegerType> FromField for Integer<E, I>

fn from_field(field: &Self::Field) -> Result<Self>

Casts an integer from a base field.

This method guarantees the following:

1. If the field element is larger than the integer domain, then the operation will fail.
2. If the field element is smaller than the integer domain, then the operation will succeed.

type Field = Field<E>

impl<E: Environment, I: IntegerType> FromFields for Integer<E, I>

fn from_fields(fields: &[Self::Field]) -> Result<Self>

Initializes a new integer by recovering the x-coordinate of an affine group from a field element.

type Field = Field<E>

impl<E: Environment, I: IntegerType> FromStr for Integer<E, I>

fn from_str(string: &str) -> Result<Self>

Parses a string into an integer.

type Err = Error

The associated error which can be returned from parsing.

impl<E: Hash + Environment, I: Hash + IntegerType> Hash for Integer<E, I>

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<E: Environment, I: IntegerType> Modulo for Integer<E, I>

fn modulo(&self, other: &Integer<E, I>) -> Self

Returns the result of taking the modulus of self with respect to other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Mul<&Integer<E, I>> for Integer<E, I>

fn mul(self, other: &Integer<E, I>) -> Self::Output

Returns the product of self and other.

type Output = Integer<E, I>

The resulting type after applying the * operator.

impl<E: Environment, I: IntegerType> Mul for Integer<E, I>

fn mul(self, other: Integer<E, I>) -> Self::Output

Returns the product of self and other.

type Output = Integer<E, I>

The resulting type after applying the * operator.

impl<E: Environment, I: IntegerType> MulAssign<&Integer<E, I>> for Integer<E, I>

fn mul_assign(&mut self, other: &Integer<E, I>)

Multiplies self by other.

impl<E: Environment, I: IntegerType> MulAssign for Integer<E, I>

fn mul_assign(&mut self, other: Integer<E, I>)

Multiplies self by other.

impl<E: Environment, I: IntegerType> MulWrapped for Integer<E, I>

fn mul_wrapped(&self, other: &Integer<E, I>) -> Self::Output

Returns the product of self and other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Neg for Integer<E, I>

fn neg(self) -> Self::Output

Returns the negation of self.

type Output = Integer<E, I>

The resulting type after applying the - operator.

impl<E: Environment, I: IntegerType> Not for Integer<E, I>

fn not(self) -> Self::Output

Returns the bitwise NOT of self.

type Output = Integer<E, I>

The resulting type after applying the ! operator.

impl<E: Environment, I: IntegerType> One for Integer<E, I>

fn one() -> Self

Returns the 1 element of the integer.

fn is_one(&self) -> bool

Returns true if the element is one.

fn set_one(&mut self)

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

impl<E: Environment, I: IntegerType> Ord for Integer<E, I>

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

Returns the lexicographic ordering of 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<E: Environment, I: IntegerType> Parser for Integer<E, I>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a integer circuit.

impl<E: PartialEq + Environment, I: PartialEq + IntegerType> PartialEq for Integer<E, I>

fn eq(&self, other: &Integer<E, I>) -> 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<E: Environment, I: IntegerType> PartialOrd for Integer<E, I>

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

Returns the lexicographic ordering of self and other.

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<E: Environment, I: IntegerType, M: Magnitude> Pow<&Integer<E, M>> for Integer<E, I>

fn pow(self, other: &Integer<E, M>) -> Self::Output

Returns the power of self to the power of other.

type Output = Integer<E, I>

The result after applying the operator.

impl<E: Environment, I: IntegerType, M: Magnitude> Pow<Integer<E, M>> for Integer<E, I>

fn pow(self, other: Integer<E, M>) -> Self::Output

Returns the power of self to the power of other.

type Output = Integer<E, I>

The result after applying the operator.

impl<E: Environment, I: IntegerType, M: Magnitude> PowWrapped<Integer<E, M>> for Integer<E, I>

fn pow_wrapped(&self, other: &Integer<E, M>) -> Self::Output

Returns the power of self to the power of other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Rem<&Integer<E, I>> for Integer<E, I>

fn rem(self, other: &Integer<E, I>) -> Self

Returns the remainder of self divided by other.

type Output = Integer<E, I>

The resulting type after applying the % operator.

impl<E: Environment, I: IntegerType> Rem for Integer<E, I>

fn rem(self, other: Integer<E, I>) -> Self

Returns the remainder of self divided by other.

type Output = Integer<E, I>

The resulting type after applying the % operator.

impl<E: Environment, I: IntegerType> RemAssign<&Integer<E, I>> for Integer<E, I>

fn rem_assign(&mut self, other: &Integer<E, I>)

Returns the remainder of self divided by other.

impl<E: Environment, I: IntegerType> RemAssign for Integer<E, I>

fn rem_assign(&mut self, other: Integer<E, I>)

Returns the remainder of self divided by other.

impl<E: Environment, I: IntegerType> RemWrapped for Integer<E, I>

fn rem_wrapped(&self, other: &Integer<E, I>) -> Self::Output

Returns the remainder of self divided by other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Serialize for Integer<E, I>

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

Serializes the integer into a string or as bytes.

impl<E: Environment, I: IntegerType, M: Magnitude> Shl<&Integer<E, M>> for Integer<E, I>

fn shl(self, n: &Integer<E, M>) -> Self::Output

Shifts self to the left by n bits.

type Output = Integer<E, I>

The resulting type after applying the << operator.

impl<E: Environment, I: IntegerType, M: Magnitude> Shl<Integer<E, M>> for Integer<E, I>

fn shl(self, n: Integer<E, M>) -> Self::Output

Shifts self to the left by n bits.

type Output = Integer<E, I>

The resulting type after applying the << operator.

impl<E: Environment, I: IntegerType, M: Magnitude> ShlAssign<Integer<E, M>> for Integer<E, I>

fn shl_assign(&mut self, n: Integer<E, M>)

Shifts self to the left by n bits and assigns the result to self.

impl<E: Environment, I: IntegerType, M: Magnitude> ShlChecked<Integer<E, M>> for Integer<E, I>

fn shl_checked(&self, n: &Integer<E, M>) -> Self::Output

Shifts self to the left by n bits.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType, M: Magnitude> ShlWrapped<Integer<E, M>> for Integer<E, I>

fn shl_wrapped(&self, n: &Integer<E, M>) -> Self::Output

Shifts self to the left by n bits, continuing past the boundary.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType, M: Magnitude> Shr<&Integer<E, M>> for Integer<E, I>

fn shr(self, n: &Integer<E, M>) -> Self::Output

Shifts self to the right by n bits.

type Output = Integer<E, I>

The resulting type after applying the >> operator.

impl<E: Environment, I: IntegerType, M: Magnitude> Shr<Integer<E, M>> for Integer<E, I>

fn shr(self, n: Integer<E, M>) -> Self::Output

Shifts self to the right by n bits.

type Output = Integer<E, I>

The resulting type after applying the >> operator.

impl<E: Environment, I: IntegerType, M: Magnitude> ShrAssign<Integer<E, M>> for Integer<E, I>

fn shr_assign(&mut self, n: Integer<E, M>)

Shifts self to the right by n bits and assigns the result to self.

impl<E: Environment, I: IntegerType, M: Magnitude> ShrChecked<Integer<E, M>> for Integer<E, I>

fn shr_checked(&self, n: &Integer<E, M>) -> Self::Output

Shifts self to the right by n bits.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType, M: Magnitude> ShrWrapped<Integer<E, M>> for Integer<E, I>

fn shr_wrapped(&self, n: &Integer<E, M>) -> Self::Output

Shifts self to the right by n bits, continuing past the boundary.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> SizeInBits for Integer<E, I>

fn size_in_bits() -> usize

Returns the integer size in bits.

impl<E: Environment, I: IntegerType> SizeInBytes for Integer<E, I>

fn size_in_bytes() -> usize

Returns the integer size in bytes.

impl<E: Environment, I: IntegerType> Square for Integer<E, I>

fn square(&self) -> Self::Output

Returns the square of self.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Sub<&Integer<E, I>> for Integer<E, I>

fn sub(self, other: &Integer<E, I>) -> Self::Output

Returns the difference of self and other.

type Output = Integer<E, I>

The resulting type after applying the - operator.

impl<E: Environment, I: IntegerType> Sub for Integer<E, I>

fn sub(self, other: Integer<E, I>) -> Self::Output

Returns the difference of self and other.

type Output = Integer<E, I>

The resulting type after applying the - operator.

impl<E: Environment, I: IntegerType> SubAssign<&Integer<E, I>> for Integer<E, I>

fn sub_assign(&mut self, other: &Integer<E, I>)

Subtracts other from self.

impl<E: Environment, I: IntegerType> SubAssign for Integer<E, I>

fn sub_assign(&mut self, other: Integer<E, I>)

Subtracts other from self.

impl<E: Environment, I: IntegerType> SubWrapped for Integer<E, I>

fn sub_wrapped(&self, other: &Integer<E, I>) -> Self::Output

Returns the difference of self and other.

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> Ternary for Integer<E, I>

fn ternary( condition: &Self::Boolean, first: &Self, second: &Self, ) -> Self::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Integer<E, I>

impl<E: Environment, I: IntegerType> ToBits for Integer<E, I>

fn write_bits_le(&self, vec: &mut Vec<bool>)

Outputs the little-endian bit representation of self without trailing zeros.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Outputs the big-endian bit representation of self without leading zeros.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<E: Environment, I: IntegerType> ToBytes for Integer<E, I>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the integer to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<E: Environment, I: IntegerType> ToField for Integer<E, I>

fn to_field(&self) -> Result<Self::Field>

Converts an integer into a field element.

type Field = Field<E>

impl<E: Environment, I: IntegerType> ToFields for Integer<E, I>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns the integer as field elements.

type Field = Field<E>

impl<E: Environment, I: IntegerType> TypeName for Integer<E, I>

fn type_name() -> &'static str

Returns the type name as a string.

impl<E: Environment, I: IntegerType> Visibility for Integer<E, I>

fn size_in_fields(&self) -> Result<u16>

Returns the number of field elements to encode self.

type Boolean = Boolean<E>

impl<E: Environment, I: IntegerType> Zero for Integer<E, I>

fn zero() -> Self

Returns the 0 element of the integer.

fn is_zero(&self) -> bool

Returns true if the element is zero.

fn set_zero(&mut self)

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

impl<E: Copy + Environment, I: Copy + IntegerType> Copy for Integer<E, I>

impl<E: Eq + Environment, I: Eq + IntegerType> Eq for Integer<E, I>

impl<E: Environment, I: IntegerType> IntegerCore<I> for Integer<E, I>

impl<E: Environment, I: IntegerType> IntegerTrait<I, Integer<E, u8>, Integer<E, u16>, Integer<E, u32>> for Integer<E, I>

impl<E: Environment, I: IntegerType> StructuralPartialEq for Integer<E, I>