Struct Circuit

pub struct Circuit { /* private fields */ }

A boolean circuit with named inputs and outputs. Input variables are identified by their name. The gates in the circuit are Gates.

Implementations

impl Circuit

pub fn from_unnamed_outputs(outputs: impl IntoIterator<Item = Gate>) -> Self

Creates a circuit from unnamed outputs. Note that the Gates can share predecessors. Any two input gates in the circuit with the same name are considered identical.

pub fn with_input_order( self, input_names: impl IntoIterator<Item = impl ToString>, ) -> Result<Self, String>

Adds the order of input gates to the circuit, or changes it.

pub fn from_named_outputs( items: impl IntoIterator<Item = (Gate, impl ToString)>, ) -> Self

Creates a circuit from (uniquely) named outputs. Note that the Gates can share predecessors. Any two input gates in the circuit with the same name are considered identical.

The empty string can be used to not name outputs.

Panics if the output names are not unique.

pub fn input_names(&self) -> impl Iterator<Item = &str> + '_

Returns the names of the input gates either in the order given by [with_input_order] or otherwise from a circuit traversal.

pub fn outputs(&self) -> &[Gate]

Returns the output gates.

pub fn output_names(&self) -> &[String]

Returns the names of the output gates, where unnamed output gates use the empty String.

pub fn named_outputs(&self) -> impl Iterator<Item = (&Gate, &String)>

Returns an iterator over the output gates and their names, where unnamed output gates use the empty string.

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

Creates an iterator over the graph (the output gates and all their predecessors) that returns each gate exactly once.

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

Creates an iterator over the graph (the output gates and all their 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.

Trait Implementations

impl Default for Circuit

fn default() -> Circuit

Returns the “default value” for a type.

impl From<Gate> for Circuit

fn from(gate: Gate) -> Self

Converts to this type from the input type.