Struct snarkvm_circuit::boolean::Boolean

pub struct Boolean<E>(_)
where
    E: Environment;

Methods from Deref<Target = LinearCombination<<E as Environment>::BaseField>>

pub fn is_constant(&self) -> bool

Returns true if there are no terms in the linear combination.

pub fn is_public(&self) -> bool

Returns true if there is exactly one term with a coefficient of one, and the term contains a public variable.

pub fn is_private(&self) -> bool

Returns true if the linear combination is not constant or public.

pub fn mode(&self) -> Mode

Returns the mode of this linear combination.

pub fn value(&self) -> F

Returns the computed value of the linear combination.

pub fn is_boolean_type(&self) -> bool

Returns true if the linear combination represents a Boolean type, and is well-formed.

Properties:

1. Either constant or terms is utilized, however never both.
2. Every individual variable in the linear combination must always be either 0 or 1.
3. The value of the linear combination must always be either 0 or 1.

Trait Implementations

impl<E> Adder for Boolean<E>where
    E: Environment,

fn adder(
    &self,
    other: &Boolean<E>,
    carry: &Boolean<E>
) -> (<Boolean<E> as Adder>::Sum, <Boolean<E> as Adder>::Carry)

Returns the sum of self and other as a sum bit and carry bit.

type Carry = Boolean<E>

type Sum = Boolean<E>

impl<E> BitAnd<&Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitand(
    self,
    other: &Boolean<E>
) -> <&Boolean<E> as BitAnd<&Boolean<E>>>::Output

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAnd<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitand(
    self,
    other: &Boolean<E>
) -> <Boolean<E> as BitAnd<&Boolean<E>>>::Output

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAnd<Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitand(self, other: Boolean<E>) -> <&Boolean<E> as BitAnd<Boolean<E>>>::Output

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAnd<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitand(self, other: Boolean<E>) -> <Boolean<E> as BitAnd<Boolean<E>>>::Output

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAndAssign<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitand_assign(&mut self, other: &Boolean<E>)

Sets self as (self AND other).

impl<E> BitAndAssign<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitand_assign(&mut self, other: Boolean<E>)

Sets self as (self AND other).

impl<E> BitOr<&Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitor(self, other: &Boolean<E>) -> <&Boolean<E> as BitOr<&Boolean<E>>>::Output

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOr<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitor(self, other: &Boolean<E>) -> <Boolean<E> as BitOr<&Boolean<E>>>::Output

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOr<Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitor(self, other: Boolean<E>) -> <&Boolean<E> as BitOr<Boolean<E>>>::Output

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOr<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitor(self, other: Boolean<E>) -> <Boolean<E> as BitOr<Boolean<E>>>::Output

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOrAssign<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitor_assign(&mut self, other: &Boolean<E>)

Sets self as (self OR other).

impl<E> BitOrAssign<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitor_assign(&mut self, other: Boolean<E>)

Sets self as (self OR other).

impl<E> BitXor<&Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitxor(
    self,
    other: &Boolean<E>
) -> <&Boolean<E> as BitXor<&Boolean<E>>>::Output

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXor<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitxor(
    self,
    other: &Boolean<E>
) -> <Boolean<E> as BitXor<&Boolean<E>>>::Output

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXor<Boolean<E>> for &Boolean<E>where
    E: Environment,

fn bitxor(self, other: Boolean<E>) -> <&Boolean<E> as BitXor<Boolean<E>>>::Output

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXor<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitxor(self, other: Boolean<E>) -> <Boolean<E> as BitXor<Boolean<E>>>::Output

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXorAssign<&Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitxor_assign(&mut self, other: &Boolean<E>)

Sets self as (self != other).

impl<E> BitXorAssign<Boolean<E>> for Boolean<E>where
    E: Environment,

fn bitxor_assign(&mut self, other: Boolean<E>)

Sets self as (self != other).

impl<E> Clone for Boolean<E>where
    E: Clone + Environment,
    <E as Environment>::BaseField: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> Debug for Boolean<E>where
    E: Environment,

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

Formats the value using the given formatter.

impl<E> Deref for Boolean<E>where
    E: Environment,

type Target = LinearCombination<<E as Environment>::BaseField>

The resulting type after dereferencing.

fn deref(&self) -> &<Boolean<E> as Deref>::Target

Dereferences the value.

impl<E> Display for Boolean<E>where
    E: Environment,

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

Formats the value using the given formatter.

impl<E> Eject for Boolean<E>where
    E: Environment,

fn eject_mode(&self) -> Mode

Ejects the mode of the boolean.

fn eject_value(&self) -> <Boolean<E> as Eject>::Primitive

Ejects the boolean as a constant boolean value.

type Primitive = bool

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

impl<E> Equal<Boolean<E>> for Boolean<E>where
    E: Environment,

fn is_equal(
    &self,
    other: &Boolean<E>
) -> <Boolean<E> as Equal<Boolean<E>>>::Output

Returns true if self and other are equal.

fn is_not_equal(
    &self,
    other: &Boolean<E>
) -> <Boolean<E> as Equal<Boolean<E>>>::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

impl<E> From<&Boolean<E>> for LinearCombination<<E as Environment>::BaseField>where
    E: Environment,

fn from(
    boolean: &Boolean<E>
) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<Boolean<E>> for LinearCombination<<E as Environment>::BaseField>where
    E: Environment,

fn from(boolean: Boolean<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> FromBits for Boolean<E>where
    E: Environment,

fn from_bits_le(bits_le: &[<Boolean<E> as FromBits>::Boolean]) -> Boolean<E>

Returns a boolean circuit given a mode and single boolean.

fn from_bits_be(bits_be: &[<Boolean<E> as FromBits>::Boolean]) -> Boolean<E>

Returns a boolean circuit given a mode and single boolean.

type Boolean = Boolean<E>

impl<E> FromStr for Boolean<E>where
    E: Environment,

fn from_str(string: &str) -> Result<Boolean<E>, Error>

Parses a string into a boolean.

type Err = Error

The associated error which can be returned from parsing.

impl<E> Inject for Boolean<E>where
    E: Environment,

fn new(mode: Mode, value: <Boolean<E> as Inject>::Primitive) -> Boolean<E>

Initializes a new instance of a boolean from a primitive boolean value.

fn constant(value: <Boolean<E> as Inject>::Primitive) -> Boolean<E>

Initializes a constant boolean circuit from a primitive boolean value.

type Primitive = bool

impl<E> Metrics<dyn Nor<Boolean<E>, Output = Boolean<E>> + 'static> for Boolean<E>where
    E: Environment,

type Case = (Mode, Mode)

fn count(
    case: &<Boolean<E> as Metrics<dyn Nor<Boolean<E>, Output = Boolean<E>> + 'static>>::Case
) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E> Metrics<dyn Not<Output = Boolean<E>> + 'static> for Boolean<E>where
    E: Environment,

type Case = Mode

fn count(
    _case: &<Boolean<E> as Metrics<dyn Not<Output = Boolean<E>> + 'static>>::Case
) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E> Nand<Boolean<E>> for Boolean<E>where
    E: Environment,

fn nand(&self, other: &Boolean<E>) -> <Boolean<E> as Nand<Boolean<E>>>::Output

Returns NOT (a AND b).

type Output = Boolean<E>

impl<E> Nor<Boolean<E>> for Boolean<E>where
    E: Environment,

fn nor(&self, other: &Boolean<E>) -> <Boolean<E> as Nor<Boolean<E>>>::Output

Returns (NOT a) AND (NOT b).

type Output = Boolean<E>

impl<E> Not for &Boolean<E>where
    E: Environment,

fn not(self) -> <&Boolean<E> as Not>::Output

Returns (NOT a).

type Output = Boolean<E>

The resulting type after applying the ! operator.

impl<E> Not for Boolean<E>where
    E: Environment,

fn not(self) -> <Boolean<E> as Not>::Output

Returns (NOT a).

type Output = Boolean<E>

The resulting type after applying the ! operator.

impl<E> OutputMode<dyn Nor<Boolean<E>, Output = Boolean<E>> + 'static> for Boolean<E>where
    E: Environment,

type Case = (CircuitType<Boolean<E>>, CircuitType<Boolean<E>>)

fn output_mode(
    case: &<Boolean<E> as OutputMode<dyn Nor<Boolean<E>, Output = Boolean<E>> + 'static>>::Case
) -> Mode

Returns the mode of the output.

impl<E> OutputMode<dyn Not<Output = Boolean<E>> + 'static> for Boolean<E>where
    E: Environment,

type Case = Mode

fn output_mode(
    case: &<Boolean<E> as OutputMode<dyn Not<Output = Boolean<E>> + 'static>>::Case
) -> Mode

Returns the mode of the output.

impl<E> Parser for Boolean<E>where
    E: Environment,

fn parse(string: &str) -> Result<(&str, Boolean<E>), Err<VerboseError<&str>>>

Parses a string into a boolean circuit.

impl<E> Subtractor for Boolean<E>where
    E: Environment,

fn subtractor(
    &self,
    other: &Boolean<E>,
    borrow: &Boolean<E>
) -> (<Boolean<E> as Subtractor>::Difference, <Boolean<E> as Subtractor>::Borrow)

Returns the difference of self and other as a difference bit and borrow bit.

type Borrow = Boolean<E>

type Difference = Boolean<E>

impl<E> Ternary for Boolean<E>where
    E: Environment,

fn ternary(
    condition: &<Boolean<E> as Ternary>::Boolean,
    first: &Boolean<E>,
    second: &Boolean<E>
) -> <Boolean<E> as Ternary>::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Boolean<E>

impl<E> ToBits for &Boolean<E>where
    E: Environment,

fn to_bits_le(&self) -> Vec<<&Boolean<E> as ToBits>::Boolean, Global>

Outputs self as a single-element vector.

fn to_bits_be(&self) -> Vec<<&Boolean<E> as ToBits>::Boolean, Global>

Outputs self as a single-element vector.

type Boolean = Boolean<E>

impl<E> ToBits for Boolean<E>where
    E: Environment,

fn to_bits_le(&self) -> Vec<<Boolean<E> as ToBits>::Boolean, Global>

Outputs self as a single-element vector.

fn to_bits_be(&self) -> Vec<<Boolean<E> as ToBits>::Boolean, Global>

Outputs self as a single-element vector.

type Boolean = Boolean<E>

impl<E> TypeName for Boolean<E>where
    E: Environment,

fn type_name() -> &'static str

Returns the type name of the circuit as a string.

impl<E> BooleanTrait for Boolean<E>where
    E: Environment,