Struct auto_diff::collection::graph::Graph

pub struct Graph<TData, TOp> { /* 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.

let mut g = Graph::<NetIndex, NetIndex>::new();
let data1 = NetIndex::new(0,0);
let data2 = NetIndex::new(1,0);
g.add_data(&data1);
g.add_data(&data2);

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<(), ()>

Decouple input variable and op

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

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.

pub fn append(
    &self,
    other: &mut Self,
    boundary: &[TData],
    other_boundary: &[TData]
) -> Result<(), &str>

Move all the graph/network structure to this graph, with the boundary for both the this and other graph are specified.

Trait Implementations

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.