Enum OutputBoundaryMap

pub enum OutputBoundaryMap<HostNode> {
    ByIncoming(HashMap<(HostNode, IncomingPort), IncomingPort>),
    ByOutgoing(HashMap<(HostNode, OutgoingPort), IncomingPort>),
}

A map from edges in a host HUGR to incoming ports.

The edges in the map keys can be specified either as incoming ports, or as outgoing ports (in which case all incoming ports linked to the same outgoing port o map to the image of o under the map).

Variants

ByIncoming(HashMap<(HostNode, IncomingPort), IncomingPort>)

Express map in terms of incoming ports past the output boundary of the subgraph

ByOutgoing(HashMap<(HostNode, OutgoingPort), IncomingPort>)

Express map in terms of outgoing ports on the output boundary of the subgraph

Implementations

impl<N: HugrNode> OutputBoundaryMap<N>

pub fn iter(&self) -> impl Iterator<Item = ((N, Port), IncomingPort)> + '_

Iterate over the boundary map.

The keys’ ports are either incoming or outgoing, depending on the variant of self.

pub fn iter_as_incoming<'a>( &'a self, host: &'a impl HugrView<Node = N>, ) -> impl Iterator<Item = ((N, IncomingPort), IncomingPort)> + 'a

Iterate over the boundary map with keys resolved as incoming ports.

By providing the host HUGR host, all ports in the keys are resolved to incoming ports.

pub fn get<P: Into<Port>>(&self, node: N, port: P) -> Option<IncomingPort>

Get the image of a port under the boundary map.

The port port should be either incoming or outgoing, depending on the variant of self, else None is returned.

pub fn get_as_incoming( &self, node: N, incoming: IncomingPort, host: &impl HugrView<Node = N>, ) -> Option<IncomingPort>

Get the image of an incoming port under the boundary map.

By providing the host HUGR host, all ports in the keys are resolved to incoming ports.

Trait Implementations

impl<HostNode: Clone> Clone for OutputBoundaryMap<HostNode>

fn clone(&self) -> OutputBoundaryMap<HostNode>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<HostNode: Debug> Debug for OutputBoundaryMap<HostNode>

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

Formats the value using the given formatter.

impl<HostNode> From<HashMap<(HostNode, IncomingPort), IncomingPort>> for OutputBoundaryMap<HostNode>

fn from(value: HashMap<(HostNode, IncomingPort), IncomingPort>) -> Self

Converts to this type from the input type.

impl<HostNode> From<HashMap<(HostNode, OutgoingPort), IncomingPort>> for OutputBoundaryMap<HostNode>

fn from(value: HashMap<(HostNode, OutgoingPort), IncomingPort>) -> Self

Converts to this type from the input type.