hugr_core::hugr::rewrite::simple_replace

Struct SimpleReplacement

pub struct SimpleReplacement<HostNode = Node> { /* private fields */ }

Expand description

Specification of a simple replacement operation.

§Type parameters

N: The type of nodes in the host hugr.

Implementations§

impl<HostNode: HugrNode> SimpleReplacement<HostNode>

pub fn new( subgraph: SiblingSubgraph<HostNode>, replacement: Hugr, nu_inp: HashMap<(Node, IncomingPort), (HostNode, IncomingPort)>, nu_out: HashMap<(HostNode, IncomingPort), IncomingPort>, ) -> Self

Create a new SimpleReplacement specification.

pub fn replacement(&self) -> &Hugr

The replacement hugr.

pub fn into_replacement(self) -> Hugr

Consume self and return the replacement hugr.

pub fn subgraph(&self) -> &SiblingSubgraph<HostNode>

Subgraph to be replaced.

pub fn is_valid_rewrite( &self, h: &impl HugrView<Node = HostNode>, ) -> Result<(), SimpleReplacementError>

Check if the replacement can be applied to the given hugr.

pub fn get_replacement_io(&self) -> Result<[Node; 2], SimpleReplacementError>

Get the input and output nodes of the replacement hugr.

pub fn incoming_boundary<'a>( &'a self, host: &'a impl HugrView<Node = HostNode>, ) -> impl Iterator<Item = (HostPort<HostNode, OutgoingPort>, ReplacementPort<IncomingPort>)> + 'a

Get all edges that the replacement would add from outgoing ports in host to incoming ports in self.replacement.

The incoming ports returned are always connected to outputs of the OpTag::Input node of self.replacement.

For each pair in the returned vector, the first element is a port in host and the second is a port in self.replacement.

pub fn outgoing_boundary<'a>( &'a self, _host: &'a impl HugrView<Node = HostNode>, ) -> impl Iterator<Item = (ReplacementPort<OutgoingPort>, HostPort<HostNode, IncomingPort>)> + 'a

Get all edges that the replacement would add from outgoing ports in self.replacement to incoming ports in host.

The outgoing ports returned are always connected to inputs of the OpTag::Output node of self.replacement.

For each pair in the returned vector, the first element is a port in self.replacement and the second is a port in host.

This panics if self.replacement is not a DFG.

pub fn host_to_host_boundary<'a>( &'a self, host: &'a impl HugrView<Node = HostNode>, ) -> impl Iterator<Item = (HostPort<HostNode, OutgoingPort>, HostPort<HostNode, IncomingPort>)> + 'a

Get all edges that the replacement would add between ports in host.

These correspond to direct edges between the input and output nodes in the replacement graph.

For each pair in the returned vector, the both ports are in host.

This panics if self.replacement is not a DFG.

pub fn map_host_output( &self, port: impl Into<HostPort<HostNode, IncomingPort>>, ) -> Option<ReplacementPort<IncomingPort>>

Get the incoming port at the output node of self.replacement that corresponds to the given host output port.

This panics if self.replacement is not a DFG.

pub fn map_replacement_input( &self, port: impl Into<ReplacementPort<IncomingPort>>, ) -> Option<HostPort<HostNode, IncomingPort>>

Get the incoming port in subgraph that corresponds to the given replacement input port.

This panics if self.replacement is not a DFG.

pub fn all_boundary_edges<'a>( &'a self, host: &'a impl HugrView<Node = HostNode>, ) -> impl Iterator<Item = (BoundaryPort<HostNode, OutgoingPort>, BoundaryPort<HostNode, IncomingPort>)> + 'a

Get all edges that the replacement would add between host and self.replacement.

This is equivalent to chaining the results of Self::incoming_boundary, Self::outgoing_boundary, and Self::host_to_host_boundary.

This panics if self.replacement is not a DFG.

Trait Implementations§

impl<HostNode: Clone> Clone for SimpleReplacement<HostNode>

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<HostNode: Debug> Debug for SimpleReplacement<HostNode>

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

Formats the value using the given formatter. Read more

impl Rewrite for SimpleReplacement

const UNCHANGED_ON_FAILURE: bool = true

If true, [self.apply]’s of this rewrite guarantee that they do not mutate the Hugr when they return an Err. If false, there is no guarantee; the Hugr should be assumed invalid when Err is returned.

type Error = SimpleReplacementError

The type of Error with which this Rewrite may fail

type ApplyResult = Vec<(Node, OpType)>

The type returned on successful application of the rewrite.

fn verify( &self, h: &impl HugrView<Node = Node>, ) -> Result<(), SimpleReplacementError>

Checks whether the rewrite would succeed on the specified Hugr. If this call succeeds, [self.apply] should also succeed on the same h If this calls fails, [self.apply] would fail with the same error.

fn apply(self, h: &mut impl HugrMut) -> Result<Self::ApplyResult, Self::Error>

Mutate the specified Hugr, or fail with an error. Returns Self::ApplyResult if successful. If [self.unchanged_on_failure] is true, then h must be unchanged if Err is returned. See also [self.verify] Read more

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

Returns a set of nodes referenced by the rewrite. Modifying any of these nodes will invalidate it. Read more

Auto Trait Implementations§

impl<HostNode = Node> !Freeze for SimpleReplacement<HostNode>

impl<HostNode = Node> !RefUnwindSafe for SimpleReplacement<HostNode>

impl<HostNode> Send for SimpleReplacement<HostNode>
where HostNode: Send,

impl<HostNode> Sync for SimpleReplacement<HostNode>
where HostNode: Sync,

impl<HostNode> Unpin for SimpleReplacement<HostNode>
where HostNode: Unpin,

impl<HostNode = Node> !UnwindSafe for SimpleReplacement<HostNode>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.