Enum snarkvm_models::gadgets::utilities::boolean::Boolean

pub enum Boolean {
    Is(AllocatedBit),
    Not(AllocatedBit),
    Constant(bool),
}

This is a boolean value which may be either a constant or an interpretation of an AllocatedBit.

Variants

Is(AllocatedBit)

Existential view of the boolean variable

Not(AllocatedBit)

Negated view of the boolean variable

Constant(bool)

Constant (not an allocated variable)

Implementations

impl Boolean

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

pub fn lc<F: Field>(&self, one: Variable, coeff: F) -> LinearCombination<F>

pub fn constant_u8_vec<F: Field, CS: ConstraintSystem<F>>(
    cs: &mut CS,
    values: &[u8]
) -> Vec<Self>

Construct a boolean vector from a vector of u8

pub fn constant(b: bool) -> Self

Construct a boolean from a known constant.

pub fn not(&self) -> Self

Return a negated interpretation of this boolean.

pub fn xor<'a, F, CS>(
    cs: CS,
    a: &'a Self,
    b: &'a Self
) -> Result<Self, SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>, 

Perform XOR over two boolean operands.

pub fn or<'a, F, CS>(
    cs: CS,
    a: &'a Self,
    b: &'a Self
) -> Result<Self, SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>, 

Perform OR over two boolean operands.

pub fn and<'a, F: Field, CS: ConstraintSystem<F>>(
    cs: CS,
    a: &'a Self,
    b: &'a Self
) -> Result<Self, SynthesisError>

Perform AND over two boolean operands.

pub fn kary_and<F, CS>(cs: CS, bits: &[Self]) -> Result<Self, SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>, 

Perform AND over all the given boolean operands.

pub fn enforce_nand<F, CS>(cs: CS, bits: &[Self]) -> Result<(), SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>, 

Asserts that at least one operand is false.

pub fn enforce_in_field<F, CS, NativeF: PrimeField>(
    cs: CS,
    bits: &[Self]
) -> Result<(), SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>, 

Asserts that this bit_gadget representation is "in the field" when interpreted in big endian.

Trait Implementations

impl<F: Field> AllocGadget<bool, F> for Boolean

pub fn alloc<Fn, T, CS: ConstraintSystem<F>>(
    cs: CS,
    value_gen: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    T: Borrow<bool>, 

pub fn alloc_input<Fn, T, CS: ConstraintSystem<F>>(
    cs: CS,
    value_gen: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    T: Borrow<bool>, 

pub fn alloc_checked<Fn: FnOnce() -> Result<T, SynthesisError>, T: Borrow<V>, CS: ConstraintSystem<F>>(
    cs: CS,
    f: Fn
) -> Result<Self, SynthesisError>

pub fn alloc_input_checked<Fn: FnOnce() -> Result<T, SynthesisError>, T: Borrow<V>, CS: ConstraintSystem<F>>(
    cs: CS,
    f: Fn
) -> Result<Self, SynthesisError>

impl Clone for Boolean

pub fn clone(&self) -> Boolean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PrimeField> CondSelectGadget<F> for Boolean

pub fn conditionally_select<CS>(
    cs: CS,
    cond: &Self,
    first: &Self,
    second: &Self
) -> Result<Self, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl<F: Field> ConditionalEqGadget<F> for Boolean

pub fn conditional_enforce_equal<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self,
    condition: &Boolean
) -> Result<(), SynthesisError>

pub fn cost() -> usize

impl Copy for Boolean

impl Debug for Boolean

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

Formats the value using the given formatter.

impl Eq for Boolean

impl<F: Field> EqGadget<F> for Boolean

pub fn enforce_equal<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<(), SynthesisError>

pub fn cost() -> usize

impl<F: PrimeField> EvaluateEqGadget<F> for Boolean

a == b = !(a XOR b)

pub fn evaluate_equal<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError>

impl From<AllocatedBit> for Boolean

pub fn from(b: AllocatedBit) -> Boolean

Performs the conversion.

impl<'a, F: Field> FullAdder<'a, F> for Boolean

pub fn add<CS: ConstraintSystem<F>>(
    cs: CS,
    a: &'a Self,
    b: &'a Self,
    carry: &'a Self
) -> Result<(Self, Self), SynthesisError>

impl PartialEq<Boolean> for Boolean

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F: Field> ToBitsGadget<F> for Boolean

pub fn to_bits<CS: ConstraintSystem<F>>(
    &self,
    _: CS
) -> Result<Vec<Boolean>, SynthesisError>

pub fn to_bits_strict<CS: ConstraintSystem<F>>(
    &self,
    _: CS
) -> Result<Vec<Boolean>, SynthesisError>

Additionally checks if the produced list of booleans is 'valid'.

impl<F: Field> ToBytesGadget<F> for Boolean

pub fn to_bytes<CS: ConstraintSystem<F>>(
    &self,
    _cs: CS
) -> Result<Vec<UInt8>, SynthesisError>

pub fn to_bytes_strict<CS: ConstraintSystem<F>>(
    &self,
    cs: CS
) -> Result<Vec<UInt8>, SynthesisError>

Additionally checks if the produced list of booleans is 'valid'.