Struct RootChecked 

pub struct RootChecked<H, Handle = Node>(/* private fields */);

A wrapper over a Hugr that ensures the entrypoint optype is of the required OpTag.

Implementations

impl<H: HugrMut> RootChecked<H, DataflowParentID<H::Node>>

pub fn get_io(&self) -> [H::Node; 2]

Get the input and output nodes of the DFG at the entrypoint node.

pub fn map_function_type( &mut self, new_inputs: &[usize], new_outputs: &[usize], ) -> Result<(), InvalidSignature>

Rewire the inputs and outputs of the nested DFG to modify its signature.

Reorder the outgoing resp. incoming wires at the input resp. output node of the DFG to modify the signature of the DFG HUGR. This will recursively update the signatures of all ancestors of the entrypoint.

Arguments

• new_inputs: The new input signature. After the map, the i-th input wire will be connected to the ports connected to the new_inputs[i]-th input of the old DFG.
• new_outputs: The new output signature. After the map, the i-th output wire will be connected to the ports connected to the new_outputs[i]-th output of the old DFG.

Returns an InvalidSignature error if the new_inputs and new_outputs map are not valid signatures.

Panics

Panics if the DFG is not trivially nested, i.e. if there is an ancestor DFG of the entrypoint that has more than one inner DFG.

pub fn extend_inputs<'a>( &mut self, new_inputs: impl IntoIterator<Item = &'a Type>, ) -> Result<(), InvalidSignature>

Add copyable inputs to the DFG to modify its signature.

Append new inputs to the DFG. These will not be connected to any op and must be copyable. This will recursively update the signatures of all ancestors of the entrypoint.

Arguments

• new_inputs: The new input types to append to the signature.

Returns an InvalidSignature error if the new_input types are not copyable.

Panics

Panics if the DFG is not trivially nested, i.e. if there is an ancestor DFG of the entrypoint that has more than one inner DFG.

impl<H: HugrMut> RootChecked<H, DfgID<H::Node>>

pub fn get_io(&self) -> [H::Node; 2]

Get the input and output nodes of the DFG at the entrypoint node.

pub fn map_function_type( &mut self, new_inputs: &[usize], new_outputs: &[usize], ) -> Result<(), InvalidSignature>

Rewire the inputs and outputs of the nested DFG to modify its signature.

Reorder the outgoing resp. incoming wires at the input resp. output node of the DFG to modify the signature of the DFG HUGR. This will recursively update the signatures of all ancestors of the entrypoint.

Arguments

• new_inputs: The new input signature. After the map, the i-th input wire will be connected to the ports connected to the new_inputs[i]-th input of the old DFG.
• new_outputs: The new output signature. After the map, the i-th output wire will be connected to the ports connected to the new_outputs[i]-th output of the old DFG.

Returns an InvalidSignature error if the new_inputs and new_outputs map are not valid signatures.

Panics

Panics if the DFG is not trivially nested, i.e. if there is an ancestor DFG of the entrypoint that has more than one inner DFG.

pub fn extend_inputs<'a>( &mut self, new_inputs: impl IntoIterator<Item = &'a Type>, ) -> Result<(), InvalidSignature>

Add copyable inputs to the DFG to modify its signature.

Append new inputs to the DFG. These will not be connected to any op and must be copyable. This will recursively update the signatures of all ancestors of the entrypoint.

Arguments

• new_inputs: The new input types to append to the signature.

Returns an InvalidSignature error if the new_input types are not copyable.

Panics

Panics if the DFG is not trivially nested, i.e. if there is an ancestor DFG of the entrypoint that has more than one inner DFG.

impl<H: HugrView, Handle: NodeHandle<H::Node>> RootChecked<H, Handle>

pub fn tag(&self) -> OpTag

Returns the most specific tag that can be applied to the entrypoint node.

pub fn try_new(hugr: H) -> Result<Self, HugrError>

Create a hierarchical view of a whole HUGR

Errors

Returns HugrError::InvalidTag if the entrypoint isn’t a node of the required OpTag

pub fn check(hugr: &H) -> Result<(), HugrError>

Check if a Hugr is valid for the given OpTag.

To check arbitrary nodes, use check_tag.

pub fn hugr(&self) -> &H

Returns a reference to the underlying Hugr.

pub fn into_hugr(self) -> H

Extracts the underlying Hugr

pub fn as_ref(&self) -> RootChecked<&H, Handle>

Returns a wrapper over a reference to the underlying Hugr.

Trait Implementations

impl<H: AsRef<Hugr>, Handle> AsRef<Hugr> for RootChecked<H, Handle>

fn as_ref(&self) -> &Hugr

Converts this type into a shared reference of the (usually inferred) input type.

impl<H: Clone, Handle: Clone> Clone for RootChecked<H, Handle>

fn clone(&self) -> RootChecked<H, Handle>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: HugrView, Handle: NodeHandle<H::Node>> RootCheckable<H, Handle> for RootChecked<H, Handle>

fn try_into_checked(self) -> Result<RootChecked<H, Handle>, HugrError>

Wrap the Hugr in a RootChecked if it is valid for the required OpTag.