Struct Scalar

pub struct Scalar<E: Environment> { /* private fields */ }

Implementations

impl<E: Environment> Scalar<E>

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

Casts a scalar from a base field, with lossy truncation.

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

Trait Implementations

impl<E: Environment> Add<&Scalar<E>> for &Scalar<E>

type Output = Scalar<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> Add<&Scalar<E>> for Scalar<E>

type Output = Scalar<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> Add<Scalar<E>> for &Scalar<E>

type Output = Scalar<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> Add for Scalar<E>

type Output = Scalar<E>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E: Environment> AddAssign<&Scalar<E>> for Scalar<E>

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

Performs the += operation.

impl<E: Environment> AddAssign for Scalar<E>

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

Performs the += operation.

impl<E: Clone + Environment> Clone for Scalar<E>

fn clone(&self) -> Scalar<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Environment> Compare for Scalar<E>

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> Debug for Scalar<E>

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

Formats the value using the given formatter.

impl<E: Environment> Display for Scalar<E>

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

Formats the value using the given formatter.

impl<E: Environment> Eject for Scalar<E>

fn eject_mode(&self) -> Mode

Ejects the mode of the scalar.

fn eject_value(&self) -> Self::Primitive

Ejects the scalar circuit as a console scalar.

type Primitive = Scalar<<E as Environment>::Network>

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

impl<E: Environment> Equal for Scalar<E>

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> From<&Scalar<E>> for LinearCombination<E::BaseField>

fn from(scalar: &Scalar<E>) -> Self

Converts to this type from the input type.

impl<E: Environment> From<Scalar<E>> for LinearCombination<E::BaseField>

fn from(scalar: Scalar<E>) -> Self

Converts to this type from the input type.

impl<E: Environment> FromBits for Scalar<E>

fn from_bits_le(bits_le: &[Self::Boolean]) -> Self

Initializes a new scalar field element from a list of little-endian bits.

• If bits_le is longer than E::ScalarField::size_in_bits(), the excess bits are enforced to be 0s.
• If bits_le is shorter than E::ScalarField::size_in_bits(), it is padded with 0s up to scalar field size.

fn from_bits_be(bits_be: &[Self::Boolean]) -> Self

Initializes a new scalar field element from a list of big-endian bits without leading zeros.

type Boolean = Boolean<E>

impl<E: Environment> FromField for Scalar<E>

fn from_field(field: Self::Field) -> Self

Casts a scalar from a base field element.

This method guarantees the following:

1. If the field element is larger than the scalar field modulus, then the operation will fail.
2. If the field element is smaller than the scalar field modulus, then the operation will succeed.
   • This is particularly useful for the case where a user called, Scalar::from_field(scalar.to_field()), and the scalar bit representation is between size_in_data_bits < bits.len() < size_in_bits.

type Field = Field<E>

impl<E: Environment> FromStr for Scalar<E>

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

Parses a string into a scalar circuit.

type Err = Error

The associated error which can be returned from parsing.

impl<E: Environment> Inject for Scalar<E>

fn new(mode: Mode, scalar: Self::Primitive) -> Self

Initializes a scalar circuit from a console scalar.

type Primitive = Scalar<<E as Environment>::Network>

fn constant(value: Self::Primitive) -> Self

where Self: Sized,

Initializes a constant of the given primitive value.

impl<E: Environment> Metrics<dyn Add<Scalar<E>, Output = Scalar<E>>> for Scalar<E>

type Case = (Mode, Mode)

fn count(case: &Self::Case) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E: Environment> One for Scalar<E>

type Boolean = Boolean<E>

fn one() -> Self

Returns a new one constant.

fn is_one(&self) -> Self::Boolean

Returns true if self is one.

impl<E: Environment> OutputMode<dyn Add<Scalar<E>, Output = Scalar<E>>> for Scalar<E>

type Case = (Mode, Mode)

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> Parser for Scalar<E>

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

Parses a string into a scalar circuit.

impl<E: Environment> Ternary for Scalar<E>

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 = Scalar<E>

impl<E: Environment> ToBits for &Scalar<E>

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

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

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

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

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

impl<E: Environment> ToBits for Scalar<E>

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

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

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

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

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

impl<E: Environment> ToField for Scalar<E>

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

Casts a scalar field element into a base field element.

type Field = Field<E>

impl<E: Environment> ToFields for Scalar<E>

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

Casts a scalar into a list of base fields.

type Field = Field<E>

impl<E: Environment> TypeName for Scalar<E>

fn type_name() -> &'static str

Returns the type name of the circuit as a string.

impl<E: Environment> Zero for Scalar<E>

type Boolean = Boolean<E>

fn zero() -> Self

Returns a new zero constant.

fn is_zero(&self) -> Self::Boolean

Returns true if self is zero.

impl<E: Environment> ScalarTrait for Scalar<E>