Enum Direction 

pub enum Direction {
    Forward,
    Backward,
}

Represents the direction of connections in a graph node.

The Direction enum is used to specify whether a node’s connections follow the normal forward direction or create a backward (recurrent) connection. This is particularly important for creating cyclic graphs and recurrent neural networks.

Variants

• Forward - The default direction for normal graph connections. In a forward connection, data flows from input nodes through intermediate nodes to output nodes.
• Backward - Indicates a recurrent connection where data can flow backwards, creating cycles in the graph. This is used to implement recurrent neural networks and other cyclic graph structures.

Examples

use radiate_gp::collections::{graphs::Direction, GraphNode, NodeType};

let mut node = GraphNode::new(0, NodeType::Vertex, 42);
assert_eq!(node.direction(), Direction::Forward);

// Create a recurrent connection
node.set_direction(Direction::Backward);
assert!(node.is_recurrent());

Usage in Graphs

• By default, graphs are directed acyclic graphs (DAGs) with all connections in the Forward direction
• Setting a node’s direction to Backward allows for cyclic connections
• The Graph::set_cycles method automatically sets appropriate nodes to Backward direction when cycles are detected

Implementation Details

• Implements Debug, Clone, Copy, PartialEq, Eq, and Hash
• When the “serde” feature is enabled, implements Serialize and Deserialize

Variants

Forward

Backward

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl Hash for Direction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Direction

fn eq(&self, other: &Direction) -> 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 Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction