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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
use crate::{Edge, EdgeID, EdgeInsertID, EdgeQuery, GraphKind, NodeID};
pub mod weighted;
use crate::{edges::typed_edges::IndeterminateEdge, errors::GraphError, vertexes::NodeDegree};
use std::{
mem::size_of,
ops::{Deref, DerefMut},
};
pub mod named;
/// Represent a graph storage, with a set of nodes and edges.
///
/// # Examples
///
/// ```
/// use graph_theory::GraphEngine;
/// ```
#[allow(unused_variables)]
pub trait GraphEngine
where
Self: Sized,
{
/// According to a given vertex, find all neighbor nodes.
/// See more in [Self::all_neighbors], [Self::all_incoming], [Self::all_outgoing].
type NeighborIterator<'a>: DoubleEndedIterator<Item = NodeID>
where
Self: 'a;
/// An iterator over the edges.
type BridgeIterator<'a>: DoubleEndedIterator<Item = IndeterminateEdge>
where
Self: 'a;
/// Traverse all nodes in the graph,
/// note that this traversal is neither BFS nor DFS, but the most friendly traversal to the data structure.
/// See more in [Self::all_nodes].
type NodeTraverser<'a>: DoubleEndedIterator<Item = NodeID>
where
Self: 'a;
/// An iterator over the edges.
type EdgeTraverser<'a>: DoubleEndedIterator<Item = EdgeID>
where
Self: 'a;
/// An iterator over the edges.
type BridgeTraverser<'a>: DoubleEndedIterator<Item = IndeterminateEdge>
where
Self: 'a;
/// Check the graph kind, it can be directed or undirected.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
/// assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
/// ```
fn graph_kind(&self) -> GraphKind;
/// Check if the node exists, return the node id if exists.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
/// assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
/// ```
fn get_node(&self, node: NodeID) -> Result<NodeID, GraphError>;
/// Traverse all nodes in the entire graph in the most friendly way to the data structure, and the order of this traversal is arbitrary.
///
///
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// let mut graph = CompleteGraph::one_way(5);
/// assert_eq!(graph.all_nodes().count(), 20)
/// ```
fn all_nodes<'a>(&'a self) -> Self::NodeTraverser<'a>;
/// Count the number of nodes in the graph.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
/// ```
fn count_nodes<'a>(&'a self) -> usize {
self.all_nodes().count()
}
/// Given a vertex, return all adjacent nodes.
///
///
/// Return [None] if the node does not exist.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::UnGraphAND, GraphEngine};
/// let graph = UnGraphAND::default();
/// assert_eq!(graph.all_neighbors(5).count(), 5);
/// ```
fn all_neighbors<'a>(&'a self, node: NodeID) -> Self::NeighborIterator<'a>;
/// Given a vertex as the starting point, return the ids corresponding to all ending points.
///
/// In an undirected graph, it is equivalent to calling [Self::all_neighbors].
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::UnGraphAND, GraphEngine};
/// let graph = UnGraphAND::default();
/// assert_eq!(graph.all_outgoing(5).count(), 5);
/// ```
fn all_outgoing<'a>(&'a self, node: NodeID) -> Self::NeighborIterator<'a> {
debug_assert!(self.graph_kind() == GraphKind::Undirected);
self.all_neighbors(node)
}
/// Given a vertex as the ending point, return the ids corresponding to all starting points.
///
/// In an undirected graph, it is equivalent to calling [Self::all_neighbors].
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::UnGraphAND, GraphEngine};
/// let graph = UnGraphAND::default();
/// assert_eq!(graph.all_incoming(5).count(), 5);
/// ```
fn all_incoming<'a>(&'a self, node: NodeID) -> Self::NeighborIterator<'a> {
debug_assert!(self.graph_kind() == GraphKind::Undirected);
self.all_neighbors(node)
}
/// Check if the node exists, return the node id if exists.
///
/// Return [None] if the node does not exist.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
/// ```
fn count_degree<'a>(&'a self, node: NodeID) -> NodeDegree {
match self.graph_kind() {
GraphKind::Directed => {
NodeDegree::Directed { in_coming: self.all_incoming(node).count(), out_going: self.all_outgoing(node).count() }
}
GraphKind::Undirected => NodeDegree::Undirected { total: self.all_neighbors(node).count() },
}
}
/// Check if the edge exists, return the node id if exists.
///
/// At most one element will be returned, even if there are multiple edges with the same starting point and ending point.
///
/// If you need to return all eligible edges, use [Self::get_bridges].
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
/// assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
/// ```
fn get_edge(&self, edge: EdgeID) -> Result<EdgeID, GraphError>;
/// Traverse all edges in the entire graph in the most friendly way to the data structure, the order of traversal is arbitrary.
///
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// let mut graph = CompleteGraph::one_way(5);
/// assert_eq!(graph.all_nodes().count(), 20)
/// ```
fn all_edges<'a>(&'a self) -> Self::EdgeTraverser<'a>;
/// Count the number of edges in the graph.
///
/// # Examples
///
/// ```
/// # use graph_theory::{GraphEngine};
/// # use graph_theory::graph_engines::{CycleGraph, StarGraph, CompleteGraph};
/// assert_eq!(CycleGraph::one_way(5).count_edges(), 5);
/// assert_eq!(CycleGraph::two_way(5).count_edges(), 10);
/// assert_eq!(StarGraph::one_way(5).count_edges(), 5);
/// assert_eq!(StarGraph::two_way(5).count_edges(), 10);
/// assert_eq!(CompleteGraph::one_way(5).count_edges(), 5);
/// assert_eq!(CompleteGraph::one_way(5).count_edges(), 10);
/// ```
fn count_edges<'a>(&'a self) -> usize {
self.all_edges().count()
}
fn get_bridge(&self, edge: EdgeID) -> Result<IndeterminateEdge, GraphError>;
/// Give all edges matching the start and end points
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
/// assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
/// ```
fn get_bridges<'a>(&'a self, from: NodeID, goto: NodeID) -> Self::BridgeIterator<'a>;
/// Get the edges of the graph.
///
///
/// ```
/// use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
/// let mut graph = CompleteGraph::one_way(5);
/// assert_eq!(graph.all_nodes().count(), 20)
/// ```
fn all_bridges<'a>(&'a self) -> Self::BridgeTraverser<'a>;
/// Query the total space occupied by the structure, return 0 if failed to query
///
/// Note that this volume contains garbage data, call [GraphEngine::shrink] at the right time to perform garbage collection.
fn size_hint(&self) -> usize {
size_of::<Self>()
}
}
/// Mark a graph engine that can add and delete edges or points
pub trait MutableGraph: GraphEngine {
/// Insert a node without any neighbors (edges).
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::AdjacencyNodeDict, GraphEngine};
/// let mut graph = AdjacencyNodeDict::default();
/// assert_eq!(graph.count_nodes(), 0);
/// graph.insert_node(5);
/// assert_eq!(graph.count_nodes(), 1);
/// ```
fn insert_node(&mut self, node_id: usize) -> bool;
/// Insert a node without any neighbors (edges).
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::AdjacencyNodeDict, GraphEngine};
/// let mut graph = AdjacencyNodeDict::default();
/// assert_eq!(graph.count_nodes(), 0);
/// graph.insert_node(5);
/// assert_eq!(graph.count_nodes(), 1);
/// ```
fn create_node(&mut self) -> usize;
/// Remove the given node.
///
/// # Undefined Behavior
///
/// - If the node has any edges, the behavior is undefined.
///
/// It is recommended to remove all edges before removing the node, see [`GraphEngine::remove_node_with_edges`].
///
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::AdjacencyNodeDict, GraphEngine};
/// let mut graph = AdjacencyNodeDict::default();
/// assert_eq!(graph.count_nodes(), 0);
/// graph.insert_node(5);
/// assert_eq!(graph.count_nodes(), 1);
/// ```
fn remove_node(&mut self, node_id: usize) {
self.remove_node_with_edges(node_id)
}
/// Remove the given node and all edges connected to it.
///
/// # Examples
///
/// ```
/// use graph_theory::{graph_engines::AdjacencyNodeDict, GraphEngine};
/// let mut graph = AdjacencyNodeDict::default();
/// assert_eq!(graph.count_nodes(), 0);
/// graph.insert_node(5);
/// assert_eq!(graph.count_nodes(), 1);
/// ```
fn remove_node_with_edges(&mut self, node_id: usize);
/// Insert a edge between two nodes.
///
/// # Undefined Behaviors
///
/// - If the nodes does not exist, the behavior is undefined.
///
/// It is recommended to check the existence of the nodes before inserting the edge, see [`GraphEngine::insert_edge_with_nodes`].
///
/// - Insert undirected edge to directed graph.
///
/// Two edges will be inserted, but only return last edge's id.
///
/// # Panics
///
/// - No such ability
///
/// Not all graph engine supports insert edge.
///
/// - Insert disconnected edge
///
/// Meaningless, don't do that.
///
/// # Examples
///
/// ```
/// use graph_theory::GraphEngine;
/// ```
fn insert_edge<E: Edge>(&mut self, edge: E) -> EdgeInsertID {
self.insert_edge_with_nodes(edge)
}
/// Insert edge to graph, if the nodes does not exist, also insert them.
///
/// # Panics
///
/// - No such ability
///
/// Not all graph engine supports insert edge.
///
/// # Examples
///
/// ```
/// use graph_theory::GraphEngine;
/// ```
fn insert_edge_with_nodes<E: Edge>(&mut self, edge: E) -> EdgeInsertID;
/// Remove edge by given edge-id or start and end node-id.
///
/// # Panics
///
/// - No such ability
///
/// Not all graph engine supports insert edge.
///
/// # Examples
///
/// ```
/// use graph_theory::GraphEngine;
/// ```
fn remove_edge<E>(&mut self, edge: E)
where
E: Into<EdgeQuery>;
/// Remove invalid edges and nodes to improve the efficiency of subsequent queries.
fn shrink(&mut self) {}
}