Struct ConvexChecker 

pub struct ConvexChecker<'g, Base: HugrView, Checker> { /* private fields */ }

Precompute convexity information for a HUGR.

This can be used when constructing multiple sibling subgraphs to speed up convexity checking.

This type is generic over the convexity checker used. If checking convexity for circuit-like graphs, use LineConvexChecker, otherwise use TopoConvexChecker.

Implementations

impl<'g, Base: HugrView, Checker> ConvexChecker<'g, Base, Checker>

pub fn new(base: &'g Base, region_parent: Base::Node) -> Self

Create a new convexity checker.

pub fn from_entrypoint(base: &'g Base) -> Self

Create a new convexity checker for the region of the entrypoint.

pub fn hugr(&self) -> &'g Base

The base HUGR to check convexity on.

impl<'g, Base: HugrView> ConvexChecker<'g, Base, LineConvexChecker<FlatRegion<'g, <Base as HugrInternals>::RegionPortgraph<'g>>>>

pub fn get_intervals_from_nodes( &self, nodes: impl IntoIterator<Item = Base::Node>, ) -> Option<LineIntervals>

Return the line intervals occupied by the given nodes in the region.

pub fn get_intervals_from_boundary_ports( &self, ports: impl IntoIterator<Item = (Base::Node, Port)>, ) -> Option<LineIntervals>

Return the line intervals defined by the given boundary ports in the region.

Incoming ports correspond to boundary inputs, outgoing ports correspond to boundary outputs.

pub fn nodes_in_intervals<'a>( &'a self, intervals: &'a LineIntervals, ) -> impl Iterator<Item = Base::Node> + 'a

Return the nodes that are within the given line intervals.

pub fn lines_at_port( &self, node: Base::Node, port: impl Into<Port>, ) -> &[LineIndex]

Get the lines passing through the given port.

pub fn try_extend_intervals( &self, intervals: &mut LineIntervals, node: Base::Node, ) -> bool

Extend the given intervals to include the given node.

Return whether the interval was successfully extended to contain node, i.e. whether adding node to the subgraph represented by the intervals results in another subgraph that can be expressed as line intervals.

If false is returned, the intervals are left unchanged.

pub fn get_position(&self, node: Base::Node) -> Position

Get the position of a node on its lines.

Trait Implementations

impl<'g, Base: HugrView, Checker: Clone> Clone for ConvexChecker<'g, Base, Checker>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'g, Base, Checker> ConvexChecker for ConvexChecker<'g, Base, Checker>

where Base: HugrView, Checker: CreateConvexChecker<FlatRegion<'g, <Base as HugrInternals>::RegionPortgraph<'g>>>,

fn is_convex( &self, nodes: impl IntoIterator<Item = NodeIndex>, inputs: impl IntoIterator<Item = PortIndex>, outputs: impl IntoIterator<Item = PortIndex>, ) -> bool

Returns true if the subgraph is convex.

impl<'a, 'c, G: HugrView, Checker: Clone> From<&'a ConvexChecker<'c, G, Checker>> for Cow<'a, ConvexChecker<'c, G, Checker>>

fn from(value: &'a ConvexChecker<'c, G, Checker>) -> Self

Converts to this type from the input type.