Module snarkvm_circuit::prelude

Re-exports

• pub use super::*;

Modules

• circuit
• eject
• from
• helpers
• inject
• macros
• operators
• to
• to_bits

Macros

• assert_count
  Asserts the count for a given operation and case, and ensure the circuit is satisfied.
• assert_count_fails
  Asserts the count for a given operation and case, and ensure the circuit is NOT satisfied.
• assert_output_mode
  Asserts the output mode for a given operation and case.
• assert_scope
• assert_scope_fails
• count
• output_mode
• print_scope
• rename_selfs
• scope
• witness
  The witness! macro is a closure that takes in a list of circuits, eject the value of each circuit, and uses it in the subsequent code block.
• witness_mode
  The witness_mode! macro returns the expected mode given a list of circuits.

Structs

• Assignment
  A struct that contains public variable assignments, private variable assignments, and constraint assignments.
• AssignmentLC
• Circuit
• Count
  A helper struct for tracking the number of constants, public inputs, private inputs, and constraints.
• LinearCombination
• R1CS

Enums

• AssignmentVariable
• CircuitType
  Helper enum used in the case where a circuit’s output mode or counts are determined by its mode and the actual value of the circuit.
• Measurement
  A Measurement is a quantity that can be measured. The variants of the Measurement defines a condition associated with the measurable quantity.
• Mode
• Variable

Traits

• AbsChecked
  Unary operator for retrieving the absolute value, enforcing an overflow never occurs.
• AbsSaturating
  Unary operator for retrieving the absolute value, bounding the difference to MAX if an overflow occurs.
• AbsWrapped
  Unary operator for retrieving the absolute value, wrapping the result if an overflow occurs.
• AddChecked
  Binary operator for adding two values, enforcing an overflow never occurs.
• AddSaturating
  Binary operator for adding two values, bounding the sum to MAX if an overflow occurs.
• AddWrapped
  Binary operator for adding two values, wrapping the sum if an overflow occurs.
• Adder
  A single-bit binary adder with a carry bit.
• AddressTrait
• BooleanTrait
  Representation of a boolean.
• Compare
  Trait for comparator operations.
• DivChecked
  Binary operator for dividing two values, enforcing an overflow never occurs.
• DivSaturating
  Binary operator for dividing two values, bounding the quotient to MAX or MIN if an overflow occurs.
• DivUnchecked
  Binary operator for dividing two values, without checking specific conditions.
• DivWrapped
  Binary operator for dividing two values, wrapping the quotient if an overflow occurs.
• Double
  Unary operator for retrieving the doubled value.
• Eject
  Operations to eject from a circuit environment into primitive form.
• Environment
• Equal
  Trait for equality comparisons.
• FieldTrait
  Representation of a base field element.
• FromBits
  Unary operator for instantiating from bits.
• FromBoolean
  Unary operator for instantiating from a boolean.
• FromField
  Unary operator for converting from a base field element.
• FromFields
  Unary operator for converting from a list of base elements.
• FromGroup
  Unary operator for converting from an affine group element.
• GroupTrait
  Representation of a group element.
• Inject
  Operations to inject from a primitive form into a circuit environment.
• IntegerCore
• IntegerTrait
  Representation of an integer.
• Inverse
  Unary operator for retrieving the inverse value.
• MSB
  Unary operator for retrieving the most-significant bit.
• Metrics
  Trait for determining the number of constants, public input, private inputs, and constraints for an operation.
• Modulo
  Binary operator for modding two values.
• MulChecked
  Binary operator for multiplying two values, enforcing an overflow never occurs.
• MulSaturating
  Binary operator for multiplying two values, bounding the product to MAX if an overflow occurs.
• MulWrapped
  Binary operator for multiplying two values, wrapping the product if an overflow occurs.
• Nand
  Binary operator for performing NOT (a AND b).
• Nor
  Binary operator for performing (NOT a) AND (NOT b).
• One
  Representation of the one value.
• OutputMode
  Trait for determining the mode of the output of an operation.
• PowChecked
  Binary operator for exponentiating two values, enforcing an overflow never occurs.
• PowWrapped
  Binary operator for exponentiating two values, wrapping the result if an overflow occurs.
• RemChecked
  Binary operator for dividing two values and returning the remainder, enforcing an overflow never occurs.
• RemSaturating
  Binary operator for dividing two values, bounding the remainder to MAX or MIN if an overflow occurs.
• RemWrapped
  Binary operator for dividing two values, wrapping the remainder if an overflow occurs.
• ScalarTrait
  Representation of a scalar field element.
• ShlChecked
  Binary operator for left shifting a value, checking that the rhs is less than the number of bits in self.
• ShlWrapped
  Binary operator for left shifting a value, safely continuing past the number of bits in self.
• ShrChecked
  Binary operator for right shifting a value, checking that the rhs is less than the number of bits in self.
• ShrWrapped
  Binary operator for right shifting a value, safely continuing past the number of bits in self.
• SizeInBits
• SizeInDataBits
• Square
  Unary operator for retrieving the squared value.
• SquareRoot
  Unary operator for retrieving the square root of the value.
• StringTrait
• SubChecked
  Binary operator for subtracting two values, enforcing an underflow never occurs.
• SubSaturating
  Binary operator for subtracting two values, bounding the difference to MIN if an underflow occurs.
• SubWrapped
  Binary operator for subtracting two values, wrapping the difference if an underflow occurs.
• Subtractor
  A single-bit binary subtractor with a borrow bit.
• Ternary
  Trait for ternary operations.
• ToBits
  Unary operator for converting to bits.
• ToField
  Unary operator for converting to a base field.
• ToFields
  Unary operator for converting to a list of base fields.
• ToGroup
  Unary operator for converting to an affine group.
• ToLowerBits
  Unary operator for converting to k number of bits.
• ToUpperBits
  Unary operator for converting to k number of bits.
• Zero
  Representation of the zero value.

Type Definitions

• Constant
• Constraints
• Index
• Private
• Public
• Scope