Enum snarkvm_wasm::Boolean[−][src]

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

[src]

impl Boolean

[src]

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

[src]

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

[src]

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

Construct a boolean vector from a vector of u8

[src]

pub fn constant(b: bool) -> Boolean

Construct a boolean from a known constant.

[src]

pub fn not(&self) -> Boolean

Return a negated interpretation of this boolean.

[src]

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

Perform OR over two boolean operands.

[src]

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

Perform AND over two boolean operands.

[src]

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

Perform AND over all the given boolean operands.

[src]

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

Asserts that at least one operand is false.

[src]

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

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

[src]

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

Enforces that bits, when interpreted as a integer, is less than F::characteristic(), That is, interpret bits as a little-endian integer, and enforce that this integer is “in the field Z_p”, where p = F::characteristic() .

[src]

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

[src]

pub fn enforce_smaller_or_equal_than_le<F, CS>(
    cs: CS, 
    bits: &[Boolean], 
    element: impl AsRef<[u64]>
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: Field,

[src]

pub fn enforce_smaller_or_equal_than_be<F, CS>(
    cs: CS, 
    bits: &[Boolean], 
    element: impl AsRef<[u64]>
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: Field,

Trait Implementations

[src]

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

[src]

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

[src]

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

[src]

fn alloc_constant<Fn, T, CS>(_cs: CS, _f: Fn) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>,

[src]

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

[src]

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

[src]

impl Clone for Boolean

[src]

pub fn clone(&self) -> Boolean

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

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

[src]

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

[src]

pub fn cost() -> usize

[src]

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

[src]

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

[src]

pub fn cost() -> usize

[src]

impl Debug for Boolean

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

fn is_eq<CS>(&self, _cs: CS, _other: &Self) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>,

Output a Boolean value representing whether self.value() == other.value(). Read more

[src]

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

[src]

fn cost() -> usize

[src]

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

a == b = !(a XOR b)

[src]

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

[src]

impl From<AllocatedBit> for Boolean

[src]

pub fn from(b: AllocatedBit) -> Boolean

Performs the conversion.

[src]

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

[src]

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

[src]

impl PartialEq<Boolean> for Boolean

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

impl SignExtend for Boolean

[src]

pub fn sign_extend(bits: &[Boolean], length: usize) -> Vec<Boolean, Global>

[src]

impl<F> ToBitsBEGadget<F> for Boolean where
    F: Field,

[src]

pub fn to_bits_be<CS>(&self, CS) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,

[src]

pub fn to_bits_be_strict<CS>(
    &self, 
    CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,

Additionally checks if the produced list of booleans is ‘valid’.

[src]

impl<F> ToBitsLEGadget<F> for Boolean where
    F: Field,

[src]

pub fn to_bits_le<CS>(&self, CS) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,

[src]

pub fn to_bits_le_strict<CS>(
    &self, 
    CS
) -> Result<Vec<Boolean, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,

Additionally checks if the produced list of booleans is ‘valid’.

[src]

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

[src]

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

Additionally checks if the produced list of booleans is ‘valid’.

[src]

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

[src]

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

[src]

pub fn to_constraint_field<CS>(
    &self, 
    cs: CS
) -> Result<Vec<FpGadget<F>, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,

Converts self to FpGadget<F> variables.

[src]

impl<F> Xor<F, Boolean> for Boolean where
    F: Field,

[src]

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

[src]

impl Copy for Boolean

[src]

impl Eq for Boolean

Auto Trait Implementations

impl RefUnwindSafe for Boolean

impl Send for Boolean

impl Sync for Boolean

impl Unpin for Boolean

impl UnwindSafe for Boolean

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<F, T> ConditionalOrEqualsGadget<F> for T where
    T: ConditionalEqGadget<F> + CondSelectGadget<F>,
    F: Field,

[src]

pub fn conditional_enforce_equal_or<CS>(
    cs: CS, 
    cond: &Boolean, 
    var: &T, 
    first: &T, 
    second: &T, 
    should_enforce: &Boolean
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>,

[src]

pub fn cost() -> usize

impl<T> Conv for T

fn conv<T>(self) -> T where
    Self: Into<T>,

Converts self into T using Into<T>. Read more

[src]

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

[src]

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

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

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
    Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
    Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
    Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
    Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
    Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
    Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
    Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
    Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<F, T> OrEqualsGadget<F> for T where
    T: ConditionalOrEqualsGadget<F>,
    F: Field,

[src]

pub fn enforce_equal_or<CS>(
    cs: CS, 
    cond: &Boolean, 
    var: &T, 
    first: &T, 
    second: &T
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>,

[src]

pub fn cost() -> usize

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
    R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
    R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
    Self: Borrow<B>,
    B: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut B) -> R
) -> R where
    Self: BorrowMut<B>,
    B: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
    Self: AsRef<U>,
    R: 'a,
    U: 'a + ?Sized,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
    Self: AsMut<U>,
    R: 'a,
    U: 'a + ?Sized,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
    Self: Deref<Target = T>,
    T: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut T) -> R
) -> R where
    Self: DerefMut<Target = T> + Deref,
    T: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub 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> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
    Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V