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
//! Submodule defining a Transposed Monoplex Graph.
//!
//! A transposed monoplex graph is a graph where the edges are of a single type
//! and it is possible to efficiently access the predecessors of a node.
use super::{Edges, MonoplexGraph, TransposedEdges};
use crate::traits::{SizedRowsSparseMatrix2D, SparseBiMatrix2D, SparseMatrix2D};
/// Trait defining a transposed monoplex graph.
///
/// This trait extends `MonoplexGraph` with support for efficiently accessing
/// predecessors of nodes.
pub trait TransposedMonoplexGraph: MonoplexGraph<Edges = Self::TransposedEdges> {
/// The type of edges in the graph, which must support transposed (column)
/// access.
type TransposedEdges: TransposedEdges;
/// Returns the predecessors of the node with the given identifier.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")]
/// # {
/// use geometric_traits::{
/// impls::{CSR2D, GenericBiMatrix2D, SortedVec},
/// naive_structs::{GenericEdgesBuilder, GenericGraph},
/// prelude::*,
/// traits::{EdgesBuilder, VocabularyBuilder},
/// };
///
/// let nodes: Vec<usize> = vec![0, 1, 2];
/// let edges: Vec<(usize, usize)> = vec![(0, 1), (1, 2)];
/// let nodes: SortedVec<usize> = GenericVocabularyBuilder::default()
/// .expected_number_of_symbols(nodes.len())
/// .symbols(nodes.into_iter().enumerate())
/// .build()
/// .unwrap();
/// let edges: CSR2D<usize, usize, usize> =
/// GenericEdgesBuilder::<_, CSR2D<usize, usize, usize>>::default()
/// .expected_number_of_edges(edges.len())
/// .expected_shape((nodes.len(), nodes.len()))
/// .edges(edges.into_iter())
/// .build()
/// .unwrap();
/// let edges: GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>> =
/// GenericBiMatrix2D::new(edges);
/// let graph: GenericGraph<
/// SortedVec<usize>,
/// GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>>,
/// > = GenericGraph::from((nodes, edges));
///
/// let predecessors: Vec<usize> = graph.predecessors(1).collect();
/// assert_eq!(predecessors, vec![0]);
/// # }
/// ```
#[inline]
fn predecessors(
&self,
destination_node_id: <Self::TransposedEdges as Edges>::DestinationNodeId,
) -> <<<Self::TransposedEdges as TransposedEdges>::BiMatrix as SparseBiMatrix2D>::SparseTransposedMatrix as SparseMatrix2D>::SparseRow<'_>{
self.edges().predecessors(destination_node_id)
}
/// Returns whether the given destination node has a predecessor with the
/// given source node identifier.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")]
/// # {
/// use geometric_traits::{
/// impls::{CSR2D, GenericBiMatrix2D, SortedVec},
/// naive_structs::{GenericEdgesBuilder, GenericGraph},
/// prelude::*,
/// traits::{EdgesBuilder, VocabularyBuilder},
/// };
///
/// let nodes: Vec<usize> = vec![0, 1, 2];
/// let edges: Vec<(usize, usize)> = vec![(0, 1), (1, 2)];
/// let nodes: SortedVec<usize> = GenericVocabularyBuilder::default()
/// .expected_number_of_symbols(nodes.len())
/// .symbols(nodes.into_iter().enumerate())
/// .build()
/// .unwrap();
/// let edges: CSR2D<usize, usize, usize> =
/// GenericEdgesBuilder::<_, CSR2D<usize, usize, usize>>::default()
/// .expected_number_of_edges(edges.len())
/// .expected_shape((nodes.len(), nodes.len()))
/// .edges(edges.into_iter())
/// .build()
/// .unwrap();
/// let edges: GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>> =
/// GenericBiMatrix2D::new(edges);
/// let graph: GenericGraph<
/// SortedVec<usize>,
/// GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>>,
/// > = GenericGraph::from((nodes, edges));
///
/// assert!(graph.has_predecessor(1, 0));
/// assert!(!graph.has_predecessor(1, 2));
/// # }
/// ```
#[inline]
fn has_predecessor(
&self,
destination_node_id: <Self::TransposedEdges as Edges>::DestinationNodeId,
source_node_id: <Self::TransposedEdges as Edges>::SourceNodeId,
) -> bool {
self.edges().has_predecessor(destination_node_id, source_node_id)
}
/// Returns whether the given destination node has any predecessor.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")]
/// # {
/// use geometric_traits::{
/// impls::{CSR2D, GenericBiMatrix2D, SortedVec},
/// naive_structs::{GenericEdgesBuilder, GenericGraph},
/// prelude::*,
/// traits::{EdgesBuilder, VocabularyBuilder},
/// };
///
/// let nodes: Vec<usize> = vec![0, 1, 2];
/// let edges: Vec<(usize, usize)> = vec![(0, 1), (1, 2)];
/// let nodes: SortedVec<usize> = GenericVocabularyBuilder::default()
/// .expected_number_of_symbols(nodes.len())
/// .symbols(nodes.into_iter().enumerate())
/// .build()
/// .unwrap();
/// let edges: CSR2D<usize, usize, usize> =
/// GenericEdgesBuilder::<_, CSR2D<usize, usize, usize>>::default()
/// .expected_number_of_edges(edges.len())
/// .expected_shape((nodes.len(), nodes.len()))
/// .edges(edges.into_iter())
/// .build()
/// .unwrap();
/// let edges: GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>> =
/// GenericBiMatrix2D::new(edges);
/// let graph: GenericGraph<
/// SortedVec<usize>,
/// GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>>,
/// > = GenericGraph::from((nodes, edges));
///
/// assert!(graph.has_predecessors(1));
/// assert!(!graph.has_predecessors(0));
/// # }
/// ```
#[inline]
fn has_predecessors(
&self,
destination_node_id: <Self::TransposedEdges as Edges>::DestinationNodeId,
) -> bool {
self.edges().has_predecessors(destination_node_id)
}
/// Returns the inbound degree of the node with the given identifier.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")]
/// # {
/// use geometric_traits::{
/// impls::{CSR2D, GenericBiMatrix2D, SortedVec},
/// naive_structs::{GenericEdgesBuilder, GenericGraph},
/// prelude::*,
/// traits::{EdgesBuilder, VocabularyBuilder},
/// };
///
/// let nodes: Vec<usize> = vec![0, 1, 2];
/// let edges: Vec<(usize, usize)> = vec![(0, 1), (1, 2)];
/// let nodes: SortedVec<usize> = GenericVocabularyBuilder::default()
/// .expected_number_of_symbols(nodes.len())
/// .symbols(nodes.into_iter().enumerate())
/// .build()
/// .unwrap();
/// let edges: CSR2D<usize, usize, usize> =
/// GenericEdgesBuilder::<_, CSR2D<usize, usize, usize>>::default()
/// .expected_number_of_edges(edges.len())
/// .expected_shape((nodes.len(), nodes.len()))
/// .edges(edges.into_iter())
/// .build()
/// .unwrap();
/// let edges: GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>> =
/// GenericBiMatrix2D::new(edges);
/// let graph: GenericGraph<
/// SortedVec<usize>,
/// GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>>,
/// > = GenericGraph::from((nodes, edges));
///
/// assert_eq!(graph.in_degree(1), 1);
/// assert_eq!(graph.in_degree(0), 0);
/// # }
/// ```
#[inline]
fn in_degree(
&self,
destination_node_id: <Self::TransposedEdges as Edges>::DestinationNodeId,
) -> <Self::TransposedEdges as Edges>::SourceNodeId {
self.edges().in_degree(destination_node_id)
}
/// Returns an iterator over the inbound degrees of the nodes.
///
/// # Returns
///
/// An iterator over the inbound degrees of the nodes.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")]
/// # {
/// use geometric_traits::{
/// impls::{CSR2D, GenericBiMatrix2D, SortedVec},
/// naive_structs::{GenericEdgesBuilder, GenericGraph},
/// prelude::*,
/// traits::{EdgesBuilder, VocabularyBuilder},
/// };
///
/// let nodes: Vec<usize> = vec![0, 1, 2];
/// let edges: Vec<(usize, usize)> = vec![(0, 1), (1, 2)];
/// let nodes: SortedVec<usize> = GenericVocabularyBuilder::default()
/// .expected_number_of_symbols(nodes.len())
/// .symbols(nodes.into_iter().enumerate())
/// .build()
/// .unwrap();
/// let edges: CSR2D<usize, usize, usize> =
/// GenericEdgesBuilder::<_, CSR2D<usize, usize, usize>>::default()
/// .expected_number_of_edges(edges.len())
/// .expected_shape((nodes.len(), nodes.len()))
/// .edges(edges.into_iter())
/// .build()
/// .unwrap();
/// let edges: GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>> =
/// GenericBiMatrix2D::new(edges);
/// let graph: GenericGraph<
/// SortedVec<usize>,
/// GenericBiMatrix2D<CSR2D<usize, usize, usize>, CSR2D<usize, usize, usize>>,
/// > = GenericGraph::from((nodes, edges));
///
/// let in_degrees: Vec<usize> = graph.in_degrees().collect();
/// assert_eq!(in_degrees, vec![0, 1, 1]);
/// # }
/// ```
#[inline]
fn in_degrees(
&self
) -> <<<Self::TransposedEdges as TransposedEdges>::BiMatrix as SparseBiMatrix2D>::SparseTransposedMatrix as SizedRowsSparseMatrix2D>::SparseRowSizes<'_>{
self.edges().in_degrees()
}
}
impl<G> TransposedMonoplexGraph for G
where
G: MonoplexGraph,
G::Edges: TransposedEdges,
{
type TransposedEdges = G::Edges;
}