Struct Boolean

pub struct Boolean<E: Environment>(/* private fields */);

Implementations

impl<E: Environment> Boolean<E>

pub fn from_variable(var: Variable<E::BaseField>) -> Self

Initializes a boolean from a variable.

Note: This method does not check the booleanity of the variable.

Methods from Deref<Target = LinearCombination<E::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: Environment> Adder for Boolean<E>

fn adder(&self, other: &Self, carry: &Self) -> (Self::Sum, Self::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: Environment> BitAnd<&Boolean<E>> for &Boolean<E>

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

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

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

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

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

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

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

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

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

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

Returns (self AND other).

type Output = Boolean<E>

The resulting type after applying the & operator.

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

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

Sets self as (self AND other).

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

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

Sets self as (self AND other).

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

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

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

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

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

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

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

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

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

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

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

Returns (self OR other).

type Output = Boolean<E>

The resulting type after applying the | operator.

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

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

Sets self as (self OR other).

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

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

Sets self as (self OR other).

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

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

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

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

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

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

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

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

Returns (self != other).

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

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

Sets self as (self != other).

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

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

Sets self as (self != other).

impl<E: Clone + Environment> Clone for Boolean<E>

where E::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: Environment> Debug for Boolean<E>

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

Formats the value using the given formatter.

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

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

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn eject_mode(&self) -> Mode

Ejects the mode of the boolean.

fn eject_value(&self) -> Self::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: Environment> Equal for Boolean<E>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

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

fn from(boolean: &Boolean<E>) -> Self

Converts to this type from the input type.

impl<E: Environment> From<Boolean<E>> for LinearCombination<E::BaseField>

fn from(boolean: Boolean<E>) -> Self

Converts to this type from the input type.

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

fn from_bits_le(bits_le: &[Self::Boolean]) -> Self

Returns a boolean circuit given a mode and single boolean.

fn from_bits_be(bits_be: &[Self::Boolean]) -> Self

Returns a boolean circuit given a mode and single boolean.

type Boolean = Boolean<E>

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

fn from_str(string: &str) -> Result<Self>

Parses a string into a boolean.

type Err = Error

The associated error which can be returned from parsing.

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

fn new(mode: Mode, value: Self::Primitive) -> Self

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

fn constant(value: Self::Primitive) -> Self

Initializes a constant boolean circuit from a primitive boolean value.

type Primitive = bool

impl<E: Environment> Metrics<dyn Nor<Boolean<E>, Output = Boolean<E>>> for Boolean<E>

type Case = (Mode, Mode)

fn count(case: &Self::Case) -> Count

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

impl<E: Environment> Metrics<dyn Not<Output = Boolean<E>>> for Boolean<E>

type Case = Mode

fn count(_case: &Self::Case) -> Count

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

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

fn nand(&self, other: &Self) -> Self::Output

Returns NOT (a AND b).

type Output = Boolean<E>

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

fn nor(&self, other: &Self) -> Self::Output

Returns (NOT a) AND (NOT b).

type Output = Boolean<E>

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

fn not(self) -> Self::Output

Returns (NOT a).

type Output = Boolean<E>

The resulting type after applying the ! operator.

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

fn not(self) -> Self::Output

Returns (NOT a).

type Output = Boolean<E>

The resulting type after applying the ! operator.

impl<E: Environment> OutputMode<dyn Nor<Boolean<E>, Output = Boolean<E>>> for Boolean<E>

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

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

impl<E: Environment> OutputMode<dyn Not<Output = Boolean<E>>> for Boolean<E>

type Case = Mode

fn output_mode(case: &Self::Case) -> Mode

Returns the mode of the output.

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

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a boolean circuit.

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

fn subtractor( &self, other: &Self, borrow: &Self, ) -> (Self::Difference, Self::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: Environment> Ternary for Boolean<E>

fn ternary( condition: &Self::Boolean, first: &Self, second: &Self, ) -> Self::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Boolean<E>

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

fn write_bits_le(&self, vec: &mut Vec<Self::Boolean>)

Outputs self as a single-element vector.

fn write_bits_be(&self, vec: &mut Vec<Self::Boolean>)

Outputs self as a single-element vector.

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

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

fn write_bits_le(&self, vec: &mut Vec<Self::Boolean>)

Outputs self as a single-element vector.

fn write_bits_be(&self, vec: &mut Vec<Self::Boolean>)

Outputs self as a single-element vector.

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

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

fn type_name() -> &'static str

Returns the type name of the circuit as a string.

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