Struct Boolean

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

Implementations

impl<E> Boolean<E>

where E: Environment,

pub fn from_variable(var: Variable<<E as Environment>::BaseField>) -> Boolean<E>

Initializes a boolean from a variable.

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

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 for Boolean<E>

where E: Environment,

fn bitand(self, other: Boolean<E>) -> <Boolean<E> as BitAnd>::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 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 for Boolean<E>

where E: Environment,

fn bitor(self, other: Boolean<E>) -> <Boolean<E> as BitOr>::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 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 for Boolean<E>

where E: Environment,

fn bitxor(self, other: Boolean<E>) -> <Boolean<E> as BitXor>::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 for Boolean<E>

where E: Environment,

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

Sets self as (self != other).

impl<E> Cast<Address<E>> for Boolean<E>

where E: Environment,

fn cast(&self) -> Address<E>

Casts a Boolean to an Address.

impl<E> Cast<Boolean<E>> for Field<E>

where E: Environment,

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

Casts a Field to a Boolean, if the field is zero or one.

To cast arbitrary field elements to booleans, use Field::cast_lossy.

impl<E, I> Cast<Boolean<E>> for Integer<E, I>

where E: Environment, I: IntegerType,

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

Casts an Integer to a Boolean, if the integer is zero or one.

To cast arbitrary integers to booleans, use Integer::cast_lossy.

impl<E> Cast<Boolean<E>> for Scalar<E>

where E: Environment,

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

Casts a Scalar to a Boolean, if the scalar is zero or one.

To cast arbitrary scalars to booleans, use Scalar::cast_lossy.

impl<E> Cast<Field<E>> for Boolean<E>

where E: Environment,

fn cast(&self) -> Field<E>

Casts a Boolean to a Field.

impl<E> Cast<Group<E>> for Boolean<E>

where E: Environment,

fn cast(&self) -> Group<E>

Casts a Boolean to a Group.

impl<E, I> Cast<Integer<E, I>> for Boolean<E>

where E: Environment, I: IntegerType,

fn cast(&self) -> Integer<E, I>

Casts a Boolean to an Integer.

impl<E> Cast<Scalar<E>> for Boolean<E>

where E: Environment,

fn cast(&self) -> Scalar<E>

Casts a Boolean to a Scalar.

impl<E> Cast for Boolean<E>

where E: Environment,

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

Casts a Boolean to a Boolean.

impl<E> CastLossy<Address<E>> for Boolean<E>

where E: Environment,

fn cast_lossy(&self) -> Address<E>

Casts a Boolean to an Address. This is safe because casting from a boolean to any other type is always lossless.

If the boolean is true, the address is the generator of the prime-order subgroup. If the boolean is false, the address is the zero group element.

impl<E> CastLossy<Boolean<E>> for Field<E>

where E: Environment,

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

Casts a Field to a Boolean, with lossy truncation. This operation returns the least significant bit of the field.

impl<E, I> CastLossy<Boolean<E>> for Integer<E, I>

where E: Environment, I: IntegerType,

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

Casts an Integer to a Boolean, with lossy truncation. This operation returns the least significant bit of the field.

impl<E> CastLossy<Boolean<E>> for Scalar<E>

where E: Environment,

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

Casts a Scalar to a Boolean, with lossy truncation. This operation returns the least significant bit of the scalar.

impl<E> CastLossy<Field<E>> for Boolean<E>

where E: Environment,

fn cast_lossy(&self) -> Field<E>

Casts a Boolean to a Field. This is safe because casting from a boolean to any other type is always lossless.

impl<E> CastLossy<Group<E>> for Boolean<E>

where E: Environment,

fn cast_lossy(&self) -> Group<E>

Casts a Boolean to a Group. This is safe because casting from a boolean to any other type is always lossless.

If the boolean is true, the group element is the generator of the prime-order subgroup. If the boolean is false, the group element is the zero group element.

impl<E, I> CastLossy<Integer<E, I>> for Boolean<E>

where E: Environment, I: IntegerType,

fn cast_lossy(&self) -> Integer<E, I>

Casts a Boolean to an Integer.

impl<E> CastLossy<Scalar<E>> for Boolean<E>

where E: Environment,

fn cast_lossy(&self) -> Scalar<E>

Casts a Boolean to a Scalar. This is safe because casting from a boolean to any other type is always lossless.

impl<E> CastLossy for Boolean<E>

where E: Environment,

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

Casts a Boolean to a Boolean. This is an identity cast, so it is always lossless.

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 for Boolean<E>

where E: Environment,

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

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Boolean<E>) -> <Boolean<E> as Equal>::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>>> for Boolean<E>

where E: Environment,

type Case = (Mode, Mode)

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

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

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

where E: Environment,

type Case = Mode

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

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

impl<E> Nand for Boolean<E>

where E: Environment,

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

Returns NOT (a AND b).

type Output = Boolean<E>

impl<E> Nor for Boolean<E>

where E: Environment,

fn nor(&self, other: &Boolean<E>) -> <Boolean<E> as Nor>::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>>> 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>>>>::Case, ) -> Mode

Returns the mode of the output.

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

where E: Environment,

type Case = Mode

fn output_mode( case: &<Boolean<E> as OutputMode<dyn Not<Output = Boolean<E>>>>::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 write_bits_le(&self, vec: &mut Vec<<&Boolean<E> as ToBits>::Boolean>)

Outputs self as a single-element vector.

fn write_bits_be(&self, vec: &mut Vec<<&Boolean<E> as ToBits>::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> ToBits for Boolean<E>

where E: Environment,

fn write_bits_le(&self, vec: &mut Vec<<Boolean<E> as ToBits>::Boolean>)

Outputs self as a single-element vector.

fn write_bits_be(&self, vec: &mut Vec<<Boolean<E> as ToBits>::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> 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,