Struct snarkvm_circuit::prelude::Circuit

source · [−]

pub struct Circuit;

Trait Implementations

impl Clone for Circuit

fn clone(&self) -> Circuit

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl ConstraintSynthesizer<Fp256<FrParameters>> for Circuit

fn generate_constraints<CS>(&self, cs: &mut CS) -> Result<(), SynthesisError> where
CS: ConstraintSystem<Fp256<FrParameters>>,

Synthesizes the constraints from the environment into a snarkvm_r1cs-compliant constraint system.

impl Debug for Circuit

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

Formats the value using the given formatter. Read more

impl Display for Circuit

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

Formats the value using the given formatter. Read more

impl Environment for Circuit

fn zero() -> LinearCombination<<Circuit as Environment>::BaseField>

Returns the zero constant.

fn one() -> LinearCombination<<Circuit as Environment>::BaseField>

Returns the one constant.

fn new_variable(
mode: Mode,
value: <Circuit as Environment>::BaseField
) -> Variable<<Circuit as Environment>::BaseField>

Returns a new variable of the given mode and value.

fn new_witness<Fn, Output>(mode: Mode, logic: Fn) -> Output where
Fn: FnOnce() -> <Output as Inject>::Primitive,
Output: Inject,

Returns a new witness of the given mode and value.

fn scope<S, Fn, Output>(name: S, logic: Fn) -> Output where
S: Into<String>,
Fn: FnOnce() -> Output,

Enters a new scope for the environment.

fn enforce<Fn, A, B, C>(constraint: Fn) where
    Fn: FnOnce() -> (A, B, C),
    A: Into<LinearCombination<<Circuit as Environment>::BaseField>>,
    B: Into<LinearCombination<<Circuit as Environment>::BaseField>>,
    C: Into<LinearCombination<<Circuit as Environment>::BaseField>>,

Adds one constraint enforcing that (A * B) == C.

fn is_satisfied() -> bool

Returns true if all constraints in the environment are satisfied.

fn is_satisfied_in_scope() -> bool

Returns true if all constraints in the current scope are satisfied.

fn num_constants() -> u64

Returns the number of constants in the entire circuit.

fn num_public() -> u64

Returns the number of public variables in the entire circuit.

fn num_private() -> u64

Returns the number of private variables in the entire circuit.

fn num_constraints() -> u64

Returns the number of constraints in the entire circuit.

fn num_gates() -> u64

Returns the number of gates in the entire circuit.

fn num_constants_in_scope() -> u64

Returns the number of constants for the current scope.

fn num_public_in_scope() -> u64

Returns the number of public variables for the current scope.

fn num_private_in_scope() -> u64

Returns the number of private variables for the current scope.

fn num_constraints_in_scope() -> u64

Returns the number of constraints for the current scope.

fn num_gates_in_scope() -> u64

Returns the number of gates for the current scope.

fn halt<S, T>(message: S) -> T where
S: Into<String>,

Halts the program from further synthesis, evaluation, and execution in the current environment.

fn inject_r1cs(r1cs: R1CS<<Circuit as Environment>::BaseField>)

TODO (howardwu): Abstraction - Refactor this into an appropriate design. Circuits should not have easy access to this during synthesis. Returns the R1CS circuit, resetting the circuit.

fn eject_r1cs_and_reset() -> R1CS<<Circuit as Environment>::BaseField>

TODO (howardwu): Abstraction - Refactor this into an appropriate design. Circuits should not have easy access to this during synthesis. Returns the R1CS circuit, resetting the circuit.

fn eject_assignment_and_reset(
) -> Assignment<<<Circuit as Environment>::Network as Environment>::Field>

TODO (howardwu): Abstraction - Refactor this into an appropriate design. Circuits should not have easy access to this during synthesis. Returns the R1CS assignment of the circuit, resetting the circuit.

fn reset()

Clears the circuit and initializes an empty environment.

type Affine = <Testnet3 as Environment>::Affine

type BaseField = <Testnet3 as Environment>::Field

type Network = Testnet3

type ScalarField = <Testnet3 as Environment>::Scalar

const EDWARDS_A: Self::BaseField = const EDWARDS_A: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_A;

The coefficient A of the twisted Edwards curve.

const EDWARDS_D: Self::BaseField = const EDWARDS_D: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_D;

The coefficient D of the twisted Edwards curve.

const MONTGOMERY_A: Self::BaseField = const MONTGOMERY_A: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_A;

The coefficient A of the Montgomery curve.

const MONTGOMERY_B: Self::BaseField = const MONTGOMERY_B: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_B;

The coefficient B of the Montgomery curve.

const MAX_STRING_BYTES: u32 = const MAX_STRING_BYTES: u32 = <Self::Network as console::Environment>::MAX_STRING_BYTES;

The maximum number of bytes allowed in a string.

fn assert<Boolean>(boolean: Boolean) where
Boolean: Into<LinearCombination<Self::BaseField>>,

Adds one constraint enforcing that the given boolean is true.

fn assert_eq<A, B>(a: A, b: B) where
A: Into<LinearCombination<Self::BaseField>>,
B: Into<LinearCombination<Self::BaseField>>,

Adds one constraint enforcing that the A == B.

fn count() -> (u64, u64, u64, u64, u64)

Returns a tuple containing the number of constants, public variables, private variables, constraints, and gates in the entire environment.

fn count_in_scope() -> (u64, u64, u64, u64, u64)

Returns a tuple containing the number of constants, public variables, private variables, constraints, and gates for the current scope.

impl Hash for Circuit

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Circuit> for Circuit

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl Copy for Circuit

impl Eq for Circuit

impl StructuralEq for Circuit

impl StructuralPartialEq for Circuit

Auto Trait Implementations

impl RefUnwindSafe for Circuit

impl Send for Circuit

impl Sync for Circuit

impl Unpin for Circuit

impl UnwindSafe for Circuit

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V