Struct kimchi::snarky::boolean::Boolean

pub struct Boolean<F: PrimeField>(_);

A boolean variable.

Implementations

impl<F> Boolean<F>where F: PrimeField,

pub fn true_() -> Self

pub fn false_() -> Self

pub fn create_unsafe(x: FieldVar<F>) -> Self

pub fn to_field_var(&self) -> FieldVar<F>

pub fn not(&self) -> Self

pub fn and( &self, other: &Self, cs: &mut RunState<F>, loc: Cow<'static, str> ) -> Self

pub fn or( &self, other: &Self, loc: Cow<'static, str>, cs: &mut RunState<F> ) -> Self

pub fn any( xs: &[&Self], cs: &mut RunState<F>, loc: Cow<'static, str> ) -> SnarkyResult<Self>

pub fn all( xs: &[Self], cs: &mut RunState<F>, loc: Cow<'static, str> ) -> SnarkyResult<Self>

pub fn to_constant(&self) -> Option<bool>

pub fn xor( &self, other: &Self, state: &mut RunState<F>, loc: Cow<'static, str> ) -> SnarkyResult<Self>

Trait Implementations

impl<F: Clone + PrimeField> Clone for Boolean<F>

fn clone(&self) -> Boolean<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + PrimeField> Debug for Boolean<F>

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

Formats the value using the given formatter.

impl<F> SnarkyType<F> for Boolean<F>where F: PrimeField,

type Auxiliary = ()

Some ‘out-of-circuit’ data, which is carried as part of Self. This data isn’t encoded as CVars in the circuit, since the data may be large (e.g. a sparse merkle tree), or may only be used by witness computations / for debugging.

type OutOfCircuit = bool

The equivalent “out-of-circuit” type. For example, the super::boolean::Boolean snarky type has an out-of-circuit type of bool.

const SIZE_IN_FIELD_ELEMENTS: usize = 1usize

The number of field elements that this type takes.

fn to_cvars(&self) -> (Vec<FieldVar<F>>, Self::Auxiliary)

Returns the circuit variables (and auxiliary data) behind this type.

fn from_cvars_unsafe(cvars: Vec<FieldVar<F>>, _aux: Self::Auxiliary) -> Self

Creates a new instance of this type from the given circuit variables (And some auxiliary data).

fn check( &self, cs: &mut RunState<F>, loc: Cow<'static, str> ) -> SnarkyResult<()>

Checks that the circuit variables behind this type are valid. For some definition of valid. For example, a Boolean snarky type would check that the field element representing it is either 0 or 1. The function does this by adding constraints to your constraint system.

fn constraint_system_auxiliary() -> Self::Auxiliary

The “default” value of Self::Auxiliary. This is passed to Self::from_cvars_unsafe when we are not generating a witness, since we have no candidate value to get the auxiliary data from. Note that we use an explicit value here rather than Auxiliary: Default, since the default value for the type may not match the default value we actually want to pass!

fn value_to_field_elements( value: &Self::OutOfCircuit ) -> (Vec<F>, Self::Auxiliary)

Converts an out-of-circuit value

fn value_of_field_elements( fields: Vec<F>, _aux: Self::Auxiliary ) -> Self::OutOfCircuit

fn compute<FUNC>( cs: &mut RunState<F>, loc: Cow<'static, str>, to_compute_value: FUNC ) -> SnarkyResult<Self>where FUNC: Fn(&dyn WitnessGeneration<F>) -> Self::OutOfCircuit,

fn read<G>(&self, g: G) -> Self::OutOfCircuitwhere G: WitnessGeneration<F>,