Struct Gate

pub struct Gate(/* private fields */);

A gate in a boolean circuit.

The inputs of the circuit are variables identified by their name. Other types of gates are constant gates or operations that have predecessors.

The clone operation only performs a shallow clone and thus allows sharing of gates.

Implementations

impl Gate

pub fn id(&self) -> usize

Returns an identifier for the gate which is unique in the circuit but not stable across program reloads.

pub fn operation(&self) -> &Operation

Returns the operation of the gate.

pub fn iter(&self) -> impl Iterator<Item = &Gate>

Creates an iterator over the graph (the gate itself and all its predecessors) that returns each gate exactly once.

pub fn post_visit_iter(&self) -> impl Iterator<Item = &Gate>

Creates an iterator over the graph (the gate itself and all its predecessors) with post-visit order, visiting each gate exactly once. This means that the predecessors of each gate are always visited before the gate itself.

pub fn to_string_as_tree(&self) -> String

Turns the gate and its predecessors into a string representation, repeating shared gates.

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

Returns the value of the gate if it is a constant input gate.

pub fn gate_count(&self) -> (usize, usize)

Returns the number of variables and inner gates (gates not counting variables or constants) in the circuit.

This depends on how the circuit was constructed, i.e. it does not deduplicate sub-circuits, but it does deduplicate variables with the same name.

Trait Implementations

impl BitAnd for &Gate

type Output = Gate

The resulting type after applying the & operator.

fn bitand(self, other: &Gate) -> Gate

Performs the & operation.

impl BitAnd for Gate

type Output = Gate

The resulting type after applying the & operator.

fn bitand(self, other: Gate) -> Gate

Performs the & operation.

impl BitOr for &Gate

type Output = Gate

The resulting type after applying the | operator.

fn bitor(self, other: &Gate) -> Gate

Performs the | operation.

impl BitOr for Gate

type Output = Gate

The resulting type after applying the | operator.

fn bitor(self, other: Gate) -> Gate

Performs the | operation.

impl BitXor for &Gate

type Output = Gate

The resulting type after applying the ^ operator.

fn bitxor(self, other: &Gate) -> Gate

Performs the ^ operation.

impl BitXor for Gate

type Output = Gate

The resulting type after applying the ^ operator.

fn bitxor(self, other: Gate) -> Gate

Performs the ^ operation.

impl Clone for Gate

fn clone(&self) -> Gate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.

impl From<&Literal> for Gate

fn from(literal: &Literal) -> Gate

Converts a literal to either a variable or a gate that is the negation of a variable.

impl From<&str> for Gate

fn from(name: &str) -> Gate

Constructs a new gate representing an input variable.

Two variables with the same name are considered equal, even if they are different {Gate} instances.

impl From<Gate> for Circuit

fn from(gate: Gate) -> Self

Converts to this type from the input type.

impl From<String> for Gate

fn from(name: String) -> Gate

Constructs a new gate representing an input variable.

Two variables with the same name are considered equal, even if they are different gate instances.

impl From<bool> for Gate

fn from(value: bool) -> Gate

Creates a constant gate.

impl<'a> IntoIterator for &'a Gate

fn into_iter(self) -> Self::IntoIter

Creates an iterator over the graph that returns each gate exactly once.

type Item = &'a Gate

The type of the elements being iterated over.

type IntoIter = GraphIterator<'a>

Which kind of iterator are we turning this into?

impl Not for &Gate

type Output = Gate

The resulting type after applying the ! operator.

fn not(self) -> Gate

Performs the unary ! operation.

impl Not for Gate

type Output = Gate

The resulting type after applying the ! operator.

fn not(self) -> Gate

Performs the unary ! operation.