Struct AllocatedBool

pub struct AllocatedBool<F: Field> { /* private fields */ }

Represents a variable in the constraint system which is guaranteed to be either zero or one.

In general, one should prefer using Boolean instead of AllocatedBool, as Boolean offers better support for constant values, and implements more traits.

Implementations

impl<F: Field> AllocatedBool<F>

pub fn value(&self) -> Result<bool, SynthesisError>

Get the assigned value for self.

pub fn variable(&self) -> Variable

Get the R1CS variable for self.

pub fn not(&self) -> Result<Self, SynthesisError>

Performs an XOR operation over the two operands, returning an AllocatedBool.

pub fn xor(&self, b: &Self) -> Result<Self, SynthesisError>

Performs an XOR operation over the two operands, returning an AllocatedBool.

pub fn and(&self, b: &Self) -> Result<Self, SynthesisError>

Performs an AND operation over the two operands, returning an AllocatedBool.

pub fn or(&self, b: &Self) -> Result<Self, SynthesisError>

Performs an OR operation over the two operands, returning an AllocatedBool.

pub fn and_not(&self, b: &Self) -> Result<Self, SynthesisError>

Calculates a AND (NOT b).

pub fn nor(&self, b: &Self) -> Result<Self, SynthesisError>

Calculates (NOT a) AND (NOT b).

Trait Implementations

impl<F: Field> AllocVar<bool, F> for AllocatedBool<F>

fn new_variable<T: Borrow<bool>>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, mode: AllocationMode, ) -> Result<Self, SynthesisError>

Produces a new variable of the appropriate kind (instance or witness), with a booleanity check.

N.B.: we could omit the booleanity check when allocating self as a new public input, but that places an additional burden on protocol designers. Better safe than sorry!

fn new_constant( cs: impl Into<Namespace<F>>, t: impl Borrow<V>, ) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T: Borrow<V>>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T: Borrow<V>>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

Allocates a new private witness of type Self in the ConstraintSystem cs.

fn new_variable_with_inferred_mode<T: Borrow<V>>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

Allocates a new constant or private witness of type Self in the ConstraintSystem cs with the allocation mode inferred from cs. A constant is allocated if cs is None, and a private witness is allocated otherwise.

impl<F: Clone + Field> Clone for AllocatedBool<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn conditionally_select( cond: &Boolean<F>, true_val: &Self, false_val: &Self, ) -> Result<Self, SynthesisError>

If cond == &Boolean::TRUE, then this returns true_value; else, returns false_value.

fn conditionally_select_power_of_two_vector( position: &[Boolean<ConstraintF>], values: &[Self], ) -> Result<Self, SynthesisError>

Returns an element of values whose index in represented by position. position is an array of boolean that represents an unsigned integer in big endian order.

impl<F: Debug + Field> Debug for AllocatedBool<F>

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

Formats the value using the given formatter.

impl<F: Field> From<AllocatedBool<F>> for Boolean<F>

fn from(b: AllocatedBool<F>) -> Self

Converts to this type from the input type.

impl<F: PartialEq + Field> PartialEq for AllocatedBool<F>

fn eq(&self, other: &AllocatedBool<F>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Eq + Field> Eq for AllocatedBool<F>

impl<F: Field> StructuralPartialEq for AllocatedBool<F>