Struct Node

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

A node or gate in a boolean circuit.

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

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

Implementations

impl Node

pub fn id(&self) -> usize

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

pub fn operation(&self) -> &Operation

Returns the operation of the node.

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

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

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

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

pub fn to_string_as_tree(&self) -> String

Turns the node and its predecessors into a string representation, repeating shared nodes.

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

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

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

Returns the number of variables and gates (nodes 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 &Node

type Output = Node

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for Node

type Output = Node

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for &Node

type Output = Node

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for Node

type Output = Node

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for &Node

type Output = Node

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor for Node

type Output = Node

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl From<&Literal> for Node

fn from(literal: &Literal) -> Node

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

impl From<&str> for Node

fn from(name: &str) -> Node

Constructs a new node representing an input variable.

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

impl From<String> for Node

fn from(name: String) -> Node

Constructs a new node representing an input variable.

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

impl From<bool> for Node

fn from(value: bool) -> Node

Creates a constant node.

impl<'a> IntoIterator for &'a Node

fn into_iter(self) -> Self::IntoIter

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

type Item = &'a Node

The type of the elements being iterated over.

type IntoIter = GraphIterator<'a>

Which kind of iterator are we turning this into?

impl Not for &Node

type Output = Node

The resulting type after applying the ! operator.

fn not(self) -> Node

Performs the unary ! operation.

impl Not for Node

type Output = Node

The resulting type after applying the ! operator.

fn not(self) -> Node

Performs the unary ! operation.