geometric-traits 0.2.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Submodule providing a naively implemented generic Monoparted Graph.

use num_traits::AsPrimitive;

use crate::traits::{
    BidirectionalVocabulary, Edges, Graph, MonopartiteGraph, MonoplexGraph, PositiveInteger,
    TryFromUsize,
};

#[cfg(feature = "arbitrary")]
mod arbitrary_impl;

#[cfg_attr(feature = "mem_size", derive(mem_dbg::MemSize))]
#[cfg_attr(feature = "mem_size", mem_size(rec))]
#[cfg_attr(feature = "mem_dbg", derive(mem_dbg::MemDbg))]
#[derive(Clone, PartialEq, Eq, Hash)]
/// Struct representing a generic graph.
pub struct GenericGraph<Nodes, Edges> {
    /// The nodes of the graph.
    nodes: Nodes,
    /// The edges of the graph.
    edges: Edges,
}

impl<Nodes, Edges> Default for GenericGraph<Nodes, Edges>
where
    Nodes: Default,
    Edges: Default,
{
    #[inline]
    fn default() -> Self {
        Self { nodes: Nodes::default(), edges: Edges::default() }
    }
}

impl<Nodes, Edges> core::fmt::Debug for GenericGraph<Nodes, Edges>
where
    Nodes: core::fmt::Debug,
    Edges: core::fmt::Debug,
{
    #[inline]
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("GenericGraph")
            .field("nodes", &self.nodes)
            .field("edges", &self.edges)
            .finish()
    }
}

impl<Nodes, Edges> From<(Nodes, Edges)> for GenericGraph<Nodes, Edges> {
    #[inline]
    fn from((nodes, edges): (Nodes, Edges)) -> Self {
        Self { nodes, edges }
    }
}

impl<Nodes, E> Graph for GenericGraph<Nodes, E>
where
    Nodes: BidirectionalVocabulary,
    Nodes::SourceSymbol: PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    E: Edges<SourceNodeId = Nodes::SourceSymbol, DestinationNodeId = Nodes::SourceSymbol>,
{
    #[inline]
    fn has_edges(&self) -> bool {
        self.edges.has_edges()
    }

    #[inline]
    fn has_nodes(&self) -> bool {
        !self.nodes.is_empty()
    }
}

impl<Nodes, E> MonopartiteGraph for GenericGraph<Nodes, E>
where
    Nodes: BidirectionalVocabulary,
    Nodes::SourceSymbol: PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    E: Edges<SourceNodeId = Nodes::SourceSymbol, DestinationNodeId = Nodes::SourceSymbol>,
{
    type NodeId = Nodes::SourceSymbol;
    type NodeSymbol = Nodes::DestinationSymbol;
    type Nodes = Nodes;

    #[inline]
    fn nodes_vocabulary(&self) -> &Self::Nodes {
        &self.nodes
    }
}

impl<Nodes, E> MonoplexGraph for GenericGraph<Nodes, E>
where
    Nodes: BidirectionalVocabulary,
    Nodes::SourceSymbol: PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    E: Edges<SourceNodeId = Nodes::SourceSymbol, DestinationNodeId = Nodes::SourceSymbol>,
{
    type Edge = E::Edge;
    type Edges = E;

    #[inline]
    fn edges(&self) -> &Self::Edges {
        &self.edges
    }
}