graph-types 0.0.12

Shared types for graph theory.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

pub mod get_iter;
pub mod indexed;
pub mod mut_iter;
pub mod node_range_visitor;
pub mod node_slice_visitor;

use crate::GraphEngine;
use std::{
    any::type_name,
    fmt::{Debug, Formatter},
    ops::{Bound, Range, RangeBounds},
};

/// used to determine the direction of an edge
pub type NodeID = usize;
/// used to determine the direction of an edge

#[derive(Copy, Clone, Debug)]
pub enum NodeNeighborFilter {
    InComing,
    OutGoing,
    Both,
}

#[derive(Copy, Clone, Debug)]
pub enum NodeDegree {
    Directed {
        /// used to determine the direction of an edge
        in_coming: usize,
        /// used to determine the direction of an edge
        out_going: usize,
    },
    Undirected {
        /// used to determine the direction of an edge
        total: usize,
    },
}

impl NodeDegree {
    /// used to determine the direction of an edge
    pub fn total(&self) -> usize {
        match self {
            NodeDegree::Directed { in_coming, out_going } => in_coming + out_going,
            NodeDegree::Undirected { total } => *total,
        }
    }
}

/// Represents a node in a graph
///
/// ```
/// use graph_theory::GraphEngine;
/// ```
pub trait Node {
    /// The type of the node's index
    type Name: AsRef<str>;
    /// The index of the node, all kinds of nodes must have an index
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_theory::GraphEngine;
    /// ```
    fn index(&self) -> NodeID;
    /// The weight of the node, only weighted graph nodes has a weight
    ///
    /// # Examples
    ///
    /// ```
    /// use graph_theory::GraphEngine;
    /// ```
    fn name(&self) -> Self::Name;
}