Struct CommitStateSpace

pub struct CommitStateSpace { /* private fields */ }

A set of commits with directed (acyclic) dependencies between them.

Vertices in the CommitStateSpace are Commits and there is an edge from a commit c1 to a commit c2 if c1 must be applied before c2: in other words, if c2 deletes nodes that are introduced in c1. We say c2 depends on (or is a child of) c1.

A CommitStateSpace always has a unique base commit (the root of the graph). All other commits are PersistentReplacements that apply on top of it. Commits are stored as RelRcs: they are reference-counted pointers to the patch data that also maintain strong references to the commit’s parents. This means that commits can be cloned cheaply and dropped freely; the memory of a commit will be released whenever no other commit in scope depends on it.

Commits in a CommitStateSpace DO NOT represent a valid history in the general case: pairs of commits may be mutually exclusive if they modify the same subgraph. Use Self::try_extract_hugr to get a PersistentHugr with a set of compatible commits.

Implementations

impl CommitStateSpace

pub fn with_base(hugr: Hugr) -> Self

Create a new commit state space with a single base commit.

pub fn try_from_commits( commits: impl IntoIterator<Item = Commit>, ) -> Result<Self, InvalidCommit>

Create a new commit state space from a set of commits.

Return a InvalidCommit::NonUniqueBase error if the commits do not share a unique common ancestor base commit.

pub fn try_add_replacement( &mut self, replacement: PersistentReplacement, ) -> Result<CommitId, InvalidCommit>

Add a replacement commit to the graph.

Return an InvalidCommit::EmptyReplacement error if the replacement is empty.

pub fn extend(&mut self, commits: impl IntoIterator<Item = Commit>)

Add a set of commits to the state space.

Commits must be valid replacement commits or coincide with the existing base commit.

pub fn try_add_commit( &mut self, commit: Commit, ) -> Result<CommitId, InvalidCommit>

Add a commit (and all its ancestors) to the state space.

Returns an InvalidCommit::NonUniqueBase error if the commit is a base commit and does not coincide with the existing base commit.

pub fn contains(&self, commit: &Commit) -> bool

Check if commit is in the commit state space.

pub fn contains_id(&self, commit_id: CommitId) -> bool

Check if commit_id is in the commit state space.

pub fn try_extract_hugr( &self, commits: impl IntoIterator<Item = CommitId>, ) -> Result<PersistentHugr, InvalidCommit>

Extract a PersistentHugr from this state space, consisting of commits and their ancestors.

All commits in the resulting PersistentHugr are guaranteed to be compatible. If the selected commits would include two commits which are incompatible, a InvalidCommit::IncompatibleHistory error is returned. If commits is empty, a InvalidCommit::NonUniqueBase error is returned.

pub fn base(&self) -> CommitId

Get the base commit ID.

pub fn base_hugr(&self) -> &Hugr

Get the base Hugr.

pub fn base_commit(&self) -> &Commit

Get the base commit.

pub fn get_commit(&self, commit_id: CommitId) -> &Commit

Get the commit with ID commit_id.

pub fn all_commit_ids(&self) -> impl Iterator<Item = CommitId> + Clone + '_

Get an iterator over all commit IDs in the state space.

pub fn inserted_nodes( &self, commit_id: CommitId, ) -> impl Iterator<Item = PatchNode> + '_

Get an iterator over all nodes inserted by commit_id.

All nodes will be PatchNodes with commit ID commit_id.

pub fn invalidation_set( &self, commit_id: CommitId, parent: CommitId, ) -> impl Iterator<Item = Node> + '_

Get the set of nodes invalidated by commit_id in parent.

pub fn parents( &self, commit_id: CommitId, ) -> impl Iterator<Item = CommitId> + '_

Get the parents of commit_id

pub fn children( &self, commit_id: CommitId, ) -> impl Iterator<Item = CommitId> + '_

Get the children of commit_id

pub fn is_boundary_edge( &self, node: PatchNode, port: impl Into<Port>, child: CommitId, ) -> bool

Whether the edge at (node, port) is a boundary edge of child.

Check if (node, port) is outside of the subgraph of the patch of child and at least one opposite node is inside the subgraph.

impl CommitStateSpace

pub fn get_optype(&self, PatchNode: PatchNode) -> &OpType

Get the type of the operation at node.

pub fn num_ports(&self, PatchNode: PatchNode, dir: Direction) -> usize

Get the number of ports of node in dir.

pub fn node_outputs( &self, node: PatchNode, ) -> impl Iterator<Item = OutgoingPort> + Clone + '_

Iterator over output ports of node. Like CommitStateSpace::node_ports(node, Direction::Outgoing)` but preserves knowledge that the ports are OutgoingPorts.

pub fn node_inputs( &self, node: PatchNode, ) -> impl Iterator<Item = IncomingPort> + Clone + '_

Iterator over inputs ports of node. Like CommitStateSpace::node_ports(node, Direction::Incoming)` but preserves knowledge that the ports are IncomingPorts.

pub fn node_ports( &self, PatchNode: PatchNode, dir: Direction, ) -> impl Iterator<Item = Port> + Clone + '_

Get an iterator over the ports of node in dir.

pub fn all_node_ports( &self, PatchNode: PatchNode, ) -> impl Iterator<Item = Port> + Clone + '_

Get an iterator over all ports of node.

pub fn node_metadata_map(&self, PatchNode: PatchNode) -> &NodeMetadataMap

Get the metadata map of node.

Trait Implementations

impl Clone for CommitStateSpace

fn clone(&self) -> CommitStateSpace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitStateSpace

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

Formats the value using the given formatter.

impl<'a> From<&'a CommitStateSpace> for Cow<'a, CommitStateSpace>

fn from(value: &'a CommitStateSpace) -> Self

Converts to this type from the input type.

impl From<CommitStateSpace> for Cow<'_, CommitStateSpace>

fn from(value: CommitStateSpace) -> Self

Converts to this type from the input type.