Struct orkhon::prelude::prelude::Graph [−][src]
Main model class
Parameterized by a Fact class.
Fields
nodes: Vec<Node<F, O>, Global>all nodes in the model
inputs: Vec<OutletId, Global>model inputs
outputs: Vec<OutletId, Global>model outputs
outlet_labels: HashMap<OutletId, String, RandomState>outlet labels
properties: HashMap<String, Arc<Tensor>, RandomState>model properties
Implementations
impl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
Graph<F, O>: SpecialOps<F, O>, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
Graph<F, O>: SpecialOps<F, O>,
impl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
pub fn add_node(
&mut self,
name: impl Into<String>,
op: impl Into<O>,
output_facts: SmallVec<[F; 4]>
) -> Result<usize, Error>[src]
&mut self,
name: impl Into<String>,
op: impl Into<O>,
output_facts: SmallVec<[F; 4]>
) -> Result<usize, Error>
pub fn add_edge(
&mut self,
outlet: OutletId,
inlet: InletId
) -> Result<(), Error>[src]
&mut self,
outlet: OutletId,
inlet: InletId
) -> Result<(), Error>
Connect a node outlet to a node inlet.
pub fn input_outlets(&self) -> Result<&[OutletId], Error>[src]
Get model inputs.
pub fn set_input_outlets(&mut self, inputs: &[OutletId]) -> Result<(), Error>[src]
Change model inputs.
pub fn with_input_outlets(
self,
inputs: &[OutletId]
) -> Result<Graph<F, O>, Error>[src]
self,
inputs: &[OutletId]
) -> Result<Graph<F, O>, Error>
Change model inputs and return self.
pub fn set_input_names(
&mut self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>[src]
&mut self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>
Set model inputs by the node name.
pub fn with_input_names(
self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>[src]
self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>
Set model inputs by the node name and return self.
pub fn input_fact(&self, ix: usize) -> Result<&F, Error>[src]
Get the ix-th input tensor type information.
pub fn input_fact_mut(&mut self, ix: usize) -> Result<&mut F, Error>[src]
Get the ix-th input tensor type information, mutably.
pub fn set_input_fact(&mut self, input: usize, fact: F) -> Result<(), Error>[src]
Set the ix-th input tensor type information.
pub fn with_input_fact(
self,
input: usize,
fact: F
) -> Result<Graph<F, O>, Error>[src]
self,
input: usize,
fact: F
) -> Result<Graph<F, O>, Error>
Set the ix-th input tensor type information and return self.
pub fn output_outlets(&self) -> Result<&[OutletId], Error>[src]
Get model outputs.
pub fn auto_outputs(&mut self) -> Result<(), Error>[src]
Guess outputs from the topology: node or nodes with no successors.
pub fn set_output_outlets(&mut self, outputs: &[OutletId]) -> Result<(), Error>[src]
Change model outputs.
pub fn with_output_outlets(
self,
outputs: &[OutletId]
) -> Result<Graph<F, O>, Error>[src]
self,
outputs: &[OutletId]
) -> Result<Graph<F, O>, Error>
Change model outputs and return self.
pub fn set_output_names(
&mut self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>[src]
&mut self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>
Set model outputs by node names.
pub fn with_output_names(
self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>[src]
self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>
Set model outputs by node names and return self.
pub fn output_fact(&self, ix: usize) -> Result<&F, Error>[src]
Get the ix-th input tensor type information.
pub fn output_fact_mut(&mut self, ix: usize) -> Result<&mut F, Error>[src]
Get the ix-th input tensor type information, mutably.
pub fn set_output_fact(&mut self, output: usize, fact: F) -> Result<(), Error>[src]
Set the ix-th output tensor type information.
pub fn with_output_fact(
self,
output: usize,
fact: F
) -> Result<Graph<F, O>, Error>[src]
self,
output: usize,
fact: F
) -> Result<Graph<F, O>, Error>
Set the ix-th output tensor type information and return self.
pub fn node_names(&self) -> impl Iterator<Item = &str>[src]
Iterate over all node names.
pub fn node_id_by_name(&self, name: &str) -> Result<usize, Error>[src]
pub fn node_by_name(&self, name: impl AsRef<str>) -> Result<&Node<F, O>, Error>[src]
Find a node by its name.
pub fn node_by_name_mut(
&mut self,
name: impl AsRef<str>
) -> Result<&mut Node<F, O>, Error>[src]
&mut self,
name: impl AsRef<str>
) -> Result<&mut Node<F, O>, Error>
Borrow mutably a node by its name.
pub fn rename_node(&mut self, id: usize, name: &str) -> Result<(), Error>[src]
pub fn node(&self, id: usize) -> &Node<F, O>[src]
Find a node by its id.
pub fn node_mut(&mut self, id: usize) -> &mut Node<F, O>[src]
Find a node by its id.
pub fn nodes(&self) -> &[Node<F, O>]ⓘ[src]
Access the nodes table.
pub fn nodes_mut(&mut self) -> &mut [Node<F, O>]ⓘ[src]
Access the nodes table.
pub fn node_facts(
&self,
id: usize
) -> Result<(SmallVec<[&F; 4]>, SmallVec<[&F; 4]>), Error>[src]
&self,
id: usize
) -> Result<(SmallVec<[&F; 4]>, SmallVec<[&F; 4]>), Error>
Get input and output tensor information for a node.
pub fn node_input_facts(
&self,
node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>[src]
&self,
node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>
Get input tensor information for a node.
pub fn node_output_facts(
&self,
node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>[src]
&self,
node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>
Get output tensor information for a node.
pub fn outlet_fact(&self, outlet: OutletId) -> Result<&F, Error>[src]
Get tensor information for a single outlet.
pub fn outlet_fact_mut(&mut self, outlet: OutletId) -> Result<&mut F, Error>[src]
Get tensor information for a single outlet.
pub fn outlets_fact_mut(
&mut self,
outlets: &[OutletId]
) -> Result<SmallVec<[&mut F; 4]>, Error>[src]
&mut self,
outlets: &[OutletId]
) -> Result<SmallVec<[&mut F; 4]>, Error>
Get multiple mutable tensor information for outlets.
pub fn set_outlet_fact(
&mut self,
outlet: OutletId,
fact: F
) -> Result<(), Error>[src]
&mut self,
outlet: OutletId,
fact: F
) -> Result<(), Error>
Set tensor information for a single outlet.
pub fn with_outlet_fact(
self,
outlet: OutletId,
fact: F
) -> Result<Graph<F, O>, Error>[src]
self,
outlet: OutletId,
fact: F
) -> Result<Graph<F, O>, Error>
Set tensor information for a single outlet and return self.
pub fn outlet_label(&self, outlet: OutletId) -> Option<&str>[src]
Get label for an outlet.
pub fn set_outlet_label(
&mut self,
outlet: OutletId,
label: String
) -> Result<(), Error>[src]
&mut self,
outlet: OutletId,
label: String
) -> Result<(), Error>
Set label for an outlet.
pub fn with_outlet_label(
self,
outlet: OutletId,
label: String
) -> Result<Graph<F, O>, Error>[src]
self,
outlet: OutletId,
label: String
) -> Result<Graph<F, O>, Error>
Set label for an outlet and return self.
pub fn find_outlet_label(&self, label: &str) -> Option<OutletId>[src]
Find outlet by label.
pub fn eval_order(&self) -> Result<Vec<usize, Global>, Error>[src]
Computes an evalutation order for the graph inputs and outputs
pub fn check_edges(&self) -> Result<(), Error>[src]
Performs a sanity check on network connections.
pub fn into_runnable(self) -> Result<SimplePlan<F, O, Graph<F, O>>, Error>[src]
Converts the model into a RunnableModel which fixes the inputs and outputs and allows passing data through the model.
pub fn single_prec(&self, id: usize) -> Result<Option<&Node<F, O>>, Error>[src]
pub fn single_prec_at(
&self,
id: usize,
count: usize
) -> Result<Option<&Node<F, O>>, Error>[src]
&self,
id: usize,
count: usize
) -> Result<Option<&Node<F, O>>, Error>
pub fn single_succ_at(
&self,
id: usize,
count: usize
) -> Result<Option<&Node<F, O>>, Error>[src]
&self,
id: usize,
count: usize
) -> Result<Option<&Node<F, O>>, Error>
pub fn single_succ(&self, id: usize) -> Result<Option<&Node<F, O>>, Error>[src]
pub fn outlet_successors(&self, outlet: OutletId) -> &[InletId]ⓘ[src]
impl<F, O> Graph<F, O> where
F: 'static + Fact + Clone + From<Arc<Tensor>> + Hash,
O: Debug + Display + From<Const> + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + Hash + 'static, [src]
F: 'static + Fact + Clone + From<Arc<Tensor>> + Hash,
O: Debug + Display + From<Const> + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + Hash + 'static,
pub fn add_const(
&mut self,
name: impl Into<String>,
v: impl IntoArcTensor
) -> Result<OutletId, Error>[src]
&mut self,
name: impl Into<String>,
v: impl IntoArcTensor
) -> Result<OutletId, Error>
impl<F, O> Graph<F, O> where
F: Fact + Clone + 'static + Hash + for<'a> From<&'a F>,
O: Display + Debug + Clone + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash + for<'a> From<&'a O>,
Graph<F, O>: SpecialOps<F, O>, [src]
F: Fact + Clone + 'static + Hash + for<'a> From<&'a F>,
O: Display + Debug + Clone + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash + for<'a> From<&'a O>,
Graph<F, O>: SpecialOps<F, O>,
pub fn check_compact(&self) -> Result<(), Error>[src]
pub fn compact(&self) -> Result<Graph<F, O>, Error>[src]
impl Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>[src]
pub fn signature(&self) -> u64[src]
pub fn into_optimized(
self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]
self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>
pub fn declutter(
&self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]
&self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>
Perform declutter passes on the network.
pub fn concretize_dims(
&self,
values: &SymbolValues
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]
&self,
values: &SymbolValues
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>
pub fn optimize(
self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]
self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>
Translate the graph to locally optimized operators (LIR or MIR ops).
pub fn invariants(&self) -> Result<Invariants, Error>[src]
Trait Implementations
impl<F, O> Clone for Graph<F, O> where
F: Clone + Fact + Hash + 'static,
O: Clone + Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash, [src]
F: Clone + Fact + Hash + 'static,
O: Clone + Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash,
impl<F, O> Debug for Graph<F, O> where
F: Debug + Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Debug + Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
impl<F, O> Default for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
impl<F, O> Display for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
impl<F, O> DynHash for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
impl<F, O> Hash for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, [src]
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
pub fn hash<H>(&self, state: &mut H) where
H: Hasher, [src]
H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
impl SpecialOps<TypedFact, Box<dyn TypedOp + 'static, Global>> for Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>[src]
pub fn is_source(op: &Box<dyn TypedOp + 'static, Global>) -> bool[src]
pub fn create_dummy(&self) -> Box<dyn TypedOp + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;[src]
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;pub fn create_source(
&self,
fact: TypedFact
) -> Box<dyn TypedOp + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;[src]
&self,
fact: TypedFact
) -> Box<dyn TypedOp + 'static, Global>ⓘ
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;pub fn wire_node(
&mut self,
name: impl Into<String>,
op: impl Into<Box<dyn TypedOp + 'static, Global>>,
inputs: &[OutletId]
) -> Result<SmallVec<[OutletId; 4]>, Error>[src]
&mut self,
name: impl Into<String>,
op: impl Into<Box<dyn TypedOp + 'static, Global>>,
inputs: &[OutletId]
) -> Result<SmallVec<[OutletId; 4]>, Error>
Auto Trait Implementations
impl<F, O> RefUnwindSafe for Graph<F, O> where
F: RefUnwindSafe,
O: RefUnwindSafe, [src]
F: RefUnwindSafe,
O: RefUnwindSafe,
impl<F, O> Send for Graph<F, O> where
O: Send, [src]
O: Send,
impl<F, O> Sync for Graph<F, O> where
O: Sync, [src]
O: Sync,
impl<F, O> Unpin for Graph<F, O> where
F: Unpin,
O: Unpin, [src]
F: Unpin,
O: Unpin,
impl<F, O> UnwindSafe for Graph<F, O> where
F: RefUnwindSafe + UnwindSafe,
O: UnwindSafe, [src]
F: RefUnwindSafe + UnwindSafe,
O: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> DowncastSync for T where
T: Send + Sync + Any,
T: Send + Sync + Any,
impl<T> DynClone for T where
T: Clone, [src]
T: Clone,
pub fn __clone_box(&self, Private) -> *mut ()[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,