Struct Graph

pub struct Graph<TData: Ord, TOp: Ord> { /* private fields */ }

Graph

Implementations

impl<TData: Clone + Copy + Ord, TOp: Clone + Copy + Ord> Graph<TData, TOp>

pub fn new() -> Graph<TData, TOp>

Create a graph with defaults

pub fn iter_data(&self) -> NodeIterator<'_, TData>

iterator over data node.

pub fn iter_op(&self) -> NodeIterator<'_, TOp>

iterator over op node.

pub fn iter_op_given_input( &self, var: &TData, ) -> Result<NodeIterator<'_, TOp>, &str>

Return the list of ops that the given variable is the input of the func.

pub fn iter_op_given_output( &self, var: &TData, ) -> Result<NodeIterator<'_, TOp>, &str>

Return the list of ops that the given variable is the output.

pub fn iter_input_given_op( &self, func: &TOp, ) -> Result<NodeIterator<'_, TData>, &str>

Return the list of input given the func.

pub fn iter_output_given_op( &self, func: &TOp, ) -> Result<NodeIterator<'_, TData>, &str>

Return a list of data as the output of the op.

pub fn add_data(&mut self, id: &TData) -> Result<TData, &str>

Add a data node.

pub fn drop_data(&mut self, id: &TData) -> Result<TData, &str>

Remove a data node, op node and downstream data/op node are removed.

pub fn add_op(&mut self, id: &TOp) -> Result<TOp, &str>

Add a danglging op node.

pub fn drop_op(&mut self, id: &TOp) -> Result<TOp, &str>

Remvoe an op node, input data node and downstream data/op node are removed.

pub fn decouple_data_func( &mut self, var: &TData, func: &TOp, ) -> Result<(), AutoDiffError>

Decouple input variable and op

pub fn decouple_func_data( &mut self, func: &TOp, var: &TData, ) -> Result<(), AutoDiffError>

Decouple op and output variable

pub fn get_input_edge_data(&self) -> BTreeSet<TData>

list data node without upstream op node in a set.

pub fn get_output_edge_data(&self) -> BTreeSet<TData>

list data node without downstream op node in a set.

pub fn connect( &mut self, dti: &[TData], dto: &[TData], op: &TOp, ) -> Result<TOp, &str>

Connect input data, output data and operation

pub fn connect_aux( &mut self, input_data: &[TData], output_data: &[TData], op: &TOp, ) -> Result<TOp, &str>

Auxilary connect, This allows the graph to support loop.

pub fn walk<F>( &self, start_set: &[TData], forward: bool, closure: F, ) -> Result<(), BTreeSet<TData>>

where F: Fn(&[TData], &[TData], &TOp),

Walk through the graph with a starting set of data nodes. Go through backwards if forward is false. The closure call provides the side-effect.

This Walk() guarantee the input of visiting op is already visited or it’s an input.

pub fn append( &mut self, other: &Self, data_key_map: BTreeMap<TData, TData>, op_key_map: BTreeMap<TOp, TOp>, ) -> Result<(), AutoDiffError>

Trait Implementations

impl<TData: Clone + Ord, TOp: Clone + Ord> Clone for Graph<TData, TOp>

fn clone(&self) -> Graph<TData, TOp>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Graph<GenKey, GenKey>

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

Formats the value using the given formatter.

impl<TData: Clone + Copy + Ord, TOp: Clone + Copy + Ord> Default for Graph<TData, TOp>

fn default() -> Graph<TData, TOp>

Returns the “default value” for a type.

impl<'de, TData, TOp> Deserialize<'de> for Graph<TData, TOp>

where TData: Deserialize<'de> + Ord, TOp: Deserialize<'de> + Ord,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T1: Ord, T2: Ord> PartialEq for Graph<T1, T2>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TData, TOp> Serialize for Graph<TData, TOp>

where TData: Serialize + Ord, TOp: Serialize + Ord,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T1: Ord, T2: Ord> Eq for Graph<T1, T2>