franklin_crypto::plonk::circuit::boolean

Enum Boolean

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

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§

Source§

impl Boolean

Source

pub fn is_constant(&self) -> bool

Source

pub fn zero() -> Self

Source

pub fn get_variable(&self) -> Option<&AllocatedBit>

Source

pub fn alloc<E: Engine, CS: ConstraintSystem<E>>( cs: &mut CS, witness: Option<bool>, ) -> Result<Self, SynthesisError>

Source

pub fn enforce_equal<E, CS>( cs: &mut CS, a: &Self, b: &Self, ) -> Result<(), SynthesisError>
where E: Engine, CS: ConstraintSystem<E>,

Source

pub fn get_constant_value(&self) -> bool

Source

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

Source

pub fn get_value_in_field<E: Engine>(&self) -> Option<E::Fr>

Source

pub fn lc<E: Engine>(&self, coeff: E::Fr) -> LinearCombination<E>

Source

pub fn constant(b: bool) -> Self

Construct a boolean from a known constant

Source

pub fn not(&self) -> Self

Return a negated interpretation of this boolean.

Source

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

Perform XOR over two boolean operands

Source

pub fn and<'a, E, CS>( cs: &mut CS, a: &'a Self, b: &'a Self, ) -> Result<Self, SynthesisError>
where E: Engine, CS: ConstraintSystem<E>,

Perform AND over two boolean operands

Source

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

Perform OR over two boolean operands

Source

pub fn conditionally_select<E: Engine, CS: ConstraintSystem<E>>( cs: &mut CS, flag: &Self, a: &Self, b: &Self, ) -> Result<Self, SynthesisError>

Source

pub fn sha256_ch<'a, E, CS>( cs: &mut CS, a: &'a Self, b: &'a Self, c: &'a Self, ) -> Result<Self, SynthesisError>
where E: Engine, CS: ConstraintSystem<E>,

Computes (a and b) xor ((not a) and c)

Source

pub fn sha256_maj<'a, E, CS>( cs: &mut CS, a: &'a Self, b: &'a Self, c: &'a Self, ) -> Result<Self, SynthesisError>
where E: Engine, CS: ConstraintSystem<E>,

Computes (a and b) xor (a and c) xor (b and c)

Source

pub fn alloc_multiple<E: Engine, CS: ConstraintSystem<E>, const N: usize>( cs: &mut CS, witness: Option<[bool; N]>, ) -> Result<[Self; N], SynthesisError>

Source

pub fn get_value_multiple<const N: usize>(els: &[Self; N]) -> Option<[bool; N]>

Source

pub fn conditionally_select_multiple<E: Engine, CS: ConstraintSystem<E>, const N: usize>( cs: &mut CS, flag: &Boolean, a: &[Self; N], b: &[Self; N], ) -> Result<[Self; N], SynthesisError>

Trait Implementations§

Source§

impl Clone for Boolean

Source§

fn clone(&self) -> Boolean

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
Source§

impl Debug for Boolean

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Boolean

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<AllocatedBit> for Boolean

Source§

fn from(b: AllocatedBit) -> Boolean

Converts to this type from the input type.
Source§

impl<E: Engine> From<Boolean> for Num<E>

Source§

fn from(b: Boolean) -> Num<E>

Converts to this type from the input type.
Source§

impl<E: Engine> IntoBytes<E> for Boolean

Source§

impl Copy for Boolean

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PipeOp<T> for T

Source§

fn to<F, U>(self, f: F) -> U
where F: FnOnce(T) -> U,

Source§

fn op<F>(self, f: F) -> T
where F: FnOnce(&mut T),

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V