Struct auto_diff::collection::directed_graph::Graph

source · [−]

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

Expand description

Graph

Implementations

source

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

source

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

Create a graph with defaults

source

pub fn iter_data(&self) -> NodeIterator<'_, TData>ⓘNotable traits for NodeIterator<'a, TNode>`impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;`

iterator over data node.

source

pub fn iter_op(&self) -> NodeIterator<'_, TOp>ⓘNotable traits for NodeIterator<'a, TNode>`impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;`

iterator over op node.

source

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.

source

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.

source

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

Return the list of input given the func.

source

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

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

source

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

Add a data node.

source

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

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

source

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

Add a danglging op node.

source

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.

source

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

Decouple input variable and op

source

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

Decouple op and output variable

source

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

list data node without upstream op node in a set.

source

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

list data node without downstream op node in a set.

source

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

Connect input data, output data and operation

source

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.

source

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.

source

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

Trait Implementations

source

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

source

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

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

source

impl Debug for Graph<GenKey, GenKey>

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Returns the “default value” for a type. Read more

source

impl<'de, TData: Ord, TOp: Ord> Deserialize<'de> for Graph<TData, TOp> where
TData: Deserialize<'de>,
TOp: Deserialize<'de>,

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl<TData: Ord, TOp: Ord> Serialize for Graph<TData, TOp> where
TData: Serialize,
TOp: Serialize,

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

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

Auto Trait Implementations

impl<TData, TOp> RefUnwindSafe for Graph<TData, TOp> where
TData: RefUnwindSafe,
TOp: RefUnwindSafe,

impl<TData, TOp> Send for Graph<TData, TOp> where
TData: Send,
TOp: Send,

impl<TData, TOp> Sync for Graph<TData, TOp> where
TData: Sync,
TOp: Sync,

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

impl<TData, TOp> UnwindSafe for Graph<TData, TOp> where
TData: RefUnwindSafe,
TOp: RefUnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct auto_diff::collection::directed_graph::Graph

Implementations

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

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

pub fn iter_data(&self) -> NodeIterator<'_, TData>ⓘNotable traits for NodeIterator<'a, TNode>impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;

pub fn iter_op(&self) -> NodeIterator<'_, TOp>ⓘNotable traits for NodeIterator<'a, TNode>impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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>

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

impl Debug for Graph<GenKey, GenKey>

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

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

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

impl<'de, TData: Ord, TOp: Ord> Deserialize<'de> for Graph<TData, TOp> where TData: Deserialize<'de>, TOp: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

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

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

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

impl<TData: Ord, TOp: Ord> Serialize for Graph<TData, TOp> where TData: Serialize, TOp: Serialize,

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

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

Auto Trait Implementations

impl<TData, TOp> RefUnwindSafe for Graph<TData, TOp> where TData: RefUnwindSafe, TOp: RefUnwindSafe,

impl<TData, TOp> Send for Graph<TData, TOp> where TData: Send, TOp: Send,

impl<TData, TOp> Sync for Graph<TData, TOp> where TData: Sync, TOp: Sync,

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

impl<TData, TOp> UnwindSafe for Graph<TData, TOp> where TData: RefUnwindSafe, TOp: RefUnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

pub fn iter_data(&self) -> NodeIterator<'_, TData>ⓘNotable traits for NodeIterator<'a, TNode>`impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;`

pub fn iter_op(&self) -> NodeIterator<'_, TOp>ⓘNotable traits for NodeIterator<'a, TNode>`impl<'a, TNode> Iterator for NodeIterator<'a, TNode> type Item = &'a TNode;`

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

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

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

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

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

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

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

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

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

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

impl<'de, TData: Ord, TOp: Ord> Deserialize<'de> for Graph<TData, TOp> where
TData: Deserialize<'de>,
TOp: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

impl<TData: Ord, TOp: Ord> Serialize for Graph<TData, TOp> where
TData: Serialize,
TOp: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<TData, TOp> RefUnwindSafe for Graph<TData, TOp> where
TData: RefUnwindSafe,
TOp: RefUnwindSafe,

impl<TData, TOp> Send for Graph<TData, TOp> where
TData: Send,
TOp: Send,

impl<TData, TOp> Sync for Graph<TData, TOp> where
TData: Sync,
TOp: Sync,

impl<TData, TOp> UnwindSafe for Graph<TData, TOp> where
TData: RefUnwindSafe,
TOp: RefUnwindSafe,

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,