forked from Qiskit/rustworkx
-
Notifications
You must be signed in to change notification settings - Fork 3
/
graph.rs
945 lines (882 loc) · 32.3 KB
/
graph.rs
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations
// under the License.
use std::collections::BTreeMap;
use std::fs::File;
use std::ops::{Index, IndexMut};
use std::str;
use hashbrown::HashMap;
use pyo3::class::PyMappingProtocol;
use pyo3::exceptions::PyIndexError;
use pyo3::prelude::*;
use pyo3::types::{PyDict, PyList, PyLong, PyString, PyTuple};
use pyo3::Python;
use super::dot_utils::build_dot;
use super::NoEdgeBetweenNodes;
use petgraph::graph::{EdgeIndex, NodeIndex};
use petgraph::prelude::*;
use petgraph::stable_graph::StableUnGraph;
use petgraph::visit::{
GetAdjacencyMatrix, GraphBase, GraphProp, IntoEdgeReferences, IntoEdges,
IntoNeighbors, IntoNeighborsDirected, IntoNodeIdentifiers,
IntoNodeReferences, NodeCompactIndexable, NodeCount, NodeIndexable,
Visitable,
};
/// A class for creating undirected graphs.
///
/// The PyGraph class is constructed using the Rust library
/// `petgraph <https://github.com/petgraph/petgraph>`__ around the
/// ``StableGraph`` type. The limitations and quirks with this library and
/// type dictate how this operates. The biggest thing to be aware of when using
/// The PyGraph class is that an integer node and edge index is used for
/// Accessing elements on the graph, it doesn't support associative access via
/// The data/weight of nodes and edges.
#[pyclass(module = "retworkx")]
#[text_signature = "()"]
pub struct PyGraph {
pub graph: StableUnGraph<PyObject, PyObject>,
pub node_removed: bool,
}
pub type Edges<'a, E> =
petgraph::stable_graph::Edges<'a, E, petgraph::Undirected>;
impl GraphBase for PyGraph {
type NodeId = NodeIndex;
type EdgeId = EdgeIndex;
}
impl NodeCount for PyGraph {
fn node_count(&self) -> usize {
self.graph.node_count()
}
}
impl GraphProp for PyGraph {
type EdgeType = petgraph::Undirected;
fn is_directed(&self) -> bool {
false
}
}
impl petgraph::visit::Visitable for PyGraph {
type Map = <StableUnGraph<PyObject, PyObject> as Visitable>::Map;
fn visit_map(&self) -> Self::Map {
self.graph.visit_map()
}
fn reset_map(&self, map: &mut Self::Map) {
self.graph.reset_map(map)
}
}
impl petgraph::visit::Data for PyGraph {
type NodeWeight = PyObject;
type EdgeWeight = PyObject;
}
impl petgraph::data::DataMap for PyGraph {
fn node_weight(&self, id: Self::NodeId) -> Option<&Self::NodeWeight> {
self.graph.node_weight(id)
}
fn edge_weight(&self, id: Self::EdgeId) -> Option<&Self::EdgeWeight> {
self.graph.edge_weight(id)
}
}
impl petgraph::data::DataMapMut for PyGraph {
fn node_weight_mut(
&mut self,
id: Self::NodeId,
) -> Option<&mut Self::NodeWeight> {
self.graph.node_weight_mut(id)
}
fn edge_weight_mut(
&mut self,
id: Self::EdgeId,
) -> Option<&mut Self::EdgeWeight> {
self.graph.edge_weight_mut(id)
}
}
impl<'a> IntoNeighbors for &'a PyGraph {
type Neighbors = petgraph::stable_graph::Neighbors<'a, PyObject>;
fn neighbors(self, n: NodeIndex) -> Self::Neighbors {
self.graph.neighbors(n)
}
}
impl<'a> IntoNeighborsDirected for &'a PyGraph {
type NeighborsDirected = petgraph::stable_graph::Neighbors<'a, PyObject>;
fn neighbors_directed(
self,
n: NodeIndex,
d: petgraph::Direction,
) -> Self::Neighbors {
self.graph.neighbors_directed(n, d)
}
}
impl<'a> IntoEdgeReferences for &'a PyGraph {
type EdgeRef = petgraph::stable_graph::EdgeReference<'a, PyObject>;
type EdgeReferences = petgraph::stable_graph::EdgeReferences<'a, PyObject>;
fn edge_references(self) -> Self::EdgeReferences {
self.graph.edge_references()
}
}
impl<'a> IntoEdges for &'a PyGraph {
type Edges = Edges<'a, PyObject>;
fn edges(self, a: Self::NodeId) -> Self::Edges {
self.graph.edges(a)
}
}
impl<'a> IntoNodeIdentifiers for &'a PyGraph {
type NodeIdentifiers = petgraph::stable_graph::NodeIndices<'a, PyObject>;
fn node_identifiers(self) -> Self::NodeIdentifiers {
self.graph.node_identifiers()
}
}
impl<'a> IntoNodeReferences for &'a PyGraph {
type NodeRef = (NodeIndex, &'a PyObject);
type NodeReferences = petgraph::stable_graph::NodeReferences<'a, PyObject>;
fn node_references(self) -> Self::NodeReferences {
self.graph.node_references()
}
}
impl NodeIndexable for PyGraph {
fn node_bound(&self) -> usize {
self.graph.node_bound()
}
fn to_index(&self, ix: NodeIndex) -> usize {
self.graph.to_index(ix)
}
fn from_index(&self, ix: usize) -> Self::NodeId {
self.graph.from_index(ix)
}
}
impl NodeCompactIndexable for PyGraph {}
impl Index<NodeIndex> for PyGraph {
type Output = PyObject;
fn index(&self, index: NodeIndex) -> &PyObject {
&self.graph[index]
}
}
impl IndexMut<NodeIndex> for PyGraph {
fn index_mut(&mut self, index: NodeIndex) -> &mut PyObject {
&mut self.graph[index]
}
}
impl Index<EdgeIndex> for PyGraph {
type Output = PyObject;
fn index(&self, index: EdgeIndex) -> &PyObject {
&self.graph[index]
}
}
impl IndexMut<EdgeIndex> for PyGraph {
fn index_mut(&mut self, index: EdgeIndex) -> &mut PyObject {
&mut self.graph[index]
}
}
impl GetAdjacencyMatrix for PyGraph {
type AdjMatrix =
<StableUnGraph<PyObject, PyObject> as GetAdjacencyMatrix>::AdjMatrix;
fn adjacency_matrix(&self) -> Self::AdjMatrix {
self.graph.adjacency_matrix()
}
fn is_adjacent(
&self,
matrix: &Self::AdjMatrix,
a: NodeIndex,
b: NodeIndex,
) -> bool {
self.graph.is_adjacent(matrix, a, b)
}
}
#[pymethods]
impl PyGraph {
#[new]
fn new() -> Self {
PyGraph {
graph: StableUnGraph::<PyObject, PyObject>::default(),
node_removed: false,
}
}
fn __getstate__(&self, py: Python) -> PyResult<PyObject> {
let out_dict = PyDict::new(py);
let node_dict = PyDict::new(py);
let mut out_list: Vec<PyObject> = Vec::new();
out_dict.set_item("nodes", node_dict)?;
for node_index in self.graph.node_indices() {
let node_data = self.graph.node_weight(node_index).unwrap();
node_dict.set_item(node_index.index(), node_data)?;
}
for edge in self.graph.edge_indices() {
let edge_w = self.graph.edge_weight(edge);
let endpoints = self.graph.edge_endpoints(edge).unwrap();
let triplet = (endpoints.0.index(), endpoints.1.index(), edge_w)
.to_object(py);
out_list.push(triplet);
}
let py_out_list: PyObject = PyList::new(py, out_list).into();
out_dict.set_item("edges", py_out_list)?;
Ok(out_dict.into())
}
fn __setstate__(&mut self, py: Python, state: PyObject) -> PyResult<()> {
self.graph = StableUnGraph::<PyObject, PyObject>::default();
let dict_state = state.cast_as::<PyDict>(py)?;
let nodes_dict =
dict_state.get_item("nodes").unwrap().downcast::<PyDict>()?;
let edges_list =
dict_state.get_item("edges").unwrap().downcast::<PyList>()?;
let mut index_count = 0;
for raw_index in nodes_dict.keys().iter() {
let tmp_index = raw_index.downcast::<PyLong>()?;
let index: usize = tmp_index.extract()?;
let mut tmp_nodes: Vec<NodeIndex> = Vec::new();
if index > index_count + 1 {
let diff = index - (index_count + 1);
for _ in 0..diff {
let tmp_node = self.graph.add_node(py.None());
tmp_nodes.push(tmp_node);
}
}
let raw_data = nodes_dict.get_item(index).unwrap();
let out_index = self.graph.add_node(raw_data.into());
for tmp_node in tmp_nodes {
self.graph.remove_node(tmp_node);
}
index_count = out_index.index();
}
for raw_edge in edges_list.iter() {
let edge = raw_edge.downcast::<PyTuple>()?;
let raw_p_index = edge.get_item(0).downcast::<PyLong>()?;
let parent: usize = raw_p_index.extract()?;
let p_index = NodeIndex::new(parent);
let raw_c_index = edge.get_item(1).downcast::<PyLong>()?;
let child: usize = raw_c_index.extract()?;
let c_index = NodeIndex::new(child);
let edge_data = edge.get_item(2);
self.graph.add_edge(p_index, c_index, edge_data.into());
}
Ok(())
}
/// Return a list of all edge data.
///
/// :returns: A list of all the edge data objects in the graph
/// :rtype: list
#[text_signature = "()"]
pub fn edges(&self) -> Vec<&PyObject> {
self.graph
.edge_indices()
.map(|edge| self.graph.edge_weight(edge).unwrap())
.collect()
}
/// Return a list of all node data.
///
/// :returns: A list of all the node data objects in the graph
/// :rtype: list
#[text_signature = "()"]
pub fn nodes(&self) -> Vec<&PyObject> {
self.graph
.node_indices()
.map(|node| self.graph.node_weight(node).unwrap())
.collect()
}
/// Return a list of all node indexes.
///
/// :returns: A list of all the node indexes in the graph
/// :rtype: list
#[text_signature = "()"]
pub fn node_indexes(&self) -> Vec<usize> {
self.graph.node_indices().map(|node| node.index()).collect()
}
/// Return True if there is an edge between node_a to node_b.
///
/// :param int node_a: The node index to check for an edge between
/// :param int node_b: The node index to check for an edge between
///
/// :returns: True if there is an edge false if there is no edge
/// :rtype: bool
#[text_signature = "(node_a, node_b, /)"]
pub fn has_edge(&self, node_a: usize, node_b: usize) -> bool {
let index_a = NodeIndex::new(node_a);
let index_b = NodeIndex::new(node_b);
self.graph.find_edge(index_a, index_b).is_some()
}
/// Return the edge data for the edge between 2 nodes.
///
/// Note if there are multiple edges between the nodes only one will be
/// returned. To get all edge data objects use
/// :meth:`~retworkx.PyGraph.get_all_edge_data`
///
/// :param int node_a: The index for the first node
/// :param int node_b: The index for the second node
///
/// :returns: The data object set for the edge
/// :raises NoEdgeBetweenNodes: when there is no edge between the provided
/// nodes
#[text_signature = "(node_a, node_b, /)"]
pub fn get_edge_data(
&self,
node_a: usize,
node_b: usize,
) -> PyResult<&PyObject> {
let index_a = NodeIndex::new(node_a);
let index_b = NodeIndex::new(node_b);
let edge_index = match self.graph.find_edge(index_a, index_b) {
Some(edge_index) => edge_index,
None => {
return Err(NoEdgeBetweenNodes::new_err(
"No edge found between nodes",
))
}
};
let data = self.graph.edge_weight(edge_index).unwrap();
Ok(data)
}
/// Return the node data for a given node index
///
/// :param int node: The index for the node
///
/// :returns: The data object set for that node
/// :raises IndexError: when an invalid node index is provided
#[text_signature = "(node, /)"]
pub fn get_node_data(&self, node: usize) -> PyResult<&PyObject> {
let index = NodeIndex::new(node);
let node = match self.graph.node_weight(index) {
Some(node) => node,
None => {
return Err(PyIndexError::new_err("No node found for index"))
}
};
Ok(node)
}
/// Return the edge data for all the edges between 2 nodes.
///
/// :param int node_a: The index for the first node
/// :param int node_b: The index for the second node
///
/// :returns: A list with all the data objects for the edges between nodes
/// :rtype: list
/// :raises NoEdgeBetweenNodes: When there is no edge between nodes
#[text_signature = "(node_a, node_b, /)"]
pub fn get_all_edge_data(
&self,
node_a: usize,
node_b: usize,
) -> PyResult<Vec<&PyObject>> {
let index_a = NodeIndex::new(node_a);
let index_b = NodeIndex::new(node_b);
let out: Vec<&PyObject> = self
.graph
.edges(index_a)
.filter(|edge| edge.target() == index_b)
.map(|edge| edge.weight())
.collect();
if out.is_empty() {
Err(NoEdgeBetweenNodes::new_err("No edge found between nodes"))
} else {
Ok(out)
}
}
/// Get edge list
///
/// Returns a list of tuples of the form ``(source, target)`` where
/// ``source`` and ``target`` are the node indices.
///
/// :returns: An edge list with weights
/// :rtype: list
pub fn edge_list(&self) -> Vec<(usize, usize)> {
self.edge_references()
.map(|edge| (edge.source().index(), edge.target().index()))
.collect()
}
/// Get edge list with weights
///
/// Returns a list of tuples of the form ``(source, target, weight)`` where
/// ``source`` and ``target`` are the node indices and ``weight`` is the
/// payload of the edge.
///
/// :returns: An edge list with weights
/// :rtype: list
pub fn weighted_edge_list(
&self,
py: Python,
) -> Vec<(usize, usize, PyObject)> {
self.edge_references()
.map(|edge| {
(
edge.source().index(),
edge.target().index(),
edge.weight().clone_ref(py),
)
})
.collect()
}
/// Remove a node from the graph.
///
/// :param int node: The index of the node to remove. If the index is not
/// present in the graph it will be ignored and this function will
/// have no effect.
#[text_signature = "(node, /)"]
pub fn remove_node(&mut self, node: usize) -> PyResult<()> {
let index = NodeIndex::new(node);
self.graph.remove_node(index);
self.node_removed = true;
Ok(())
}
/// Add an edge between 2 nodes.
///
/// :param int parent: Index of the parent node
/// :param int child: Index of the child node
/// :param edge: The object to set as the data for the edge. It can be any
/// python object.
/// :param int parent: Index of the parent node
/// :param int child: Index of the child node
/// :param edge: The object to set as the data for the edge. It can be any
/// python object.
#[text_signature = "(node_a, node_b, edge, /)"]
pub fn add_edge(
&mut self,
node_a: usize,
node_b: usize,
edge: PyObject,
) -> PyResult<usize> {
let p_index = NodeIndex::new(node_a);
let c_index = NodeIndex::new(node_b);
let edge = self.graph.add_edge(p_index, c_index, edge);
Ok(edge.index())
}
/// Add new edges to the graph.
///
/// :param list obj_list: A list of tuples of the form
/// ``(node_a, node_b, obj)`` to attach to the graph. ``node_a`` and
/// ``node_b`` are integer indexes describing where an edge should be
/// added, and ``obj`` is the python object for the edge data.
///
/// :returns: A list of int indices of the newly created edges
/// :rtype: list
#[text_signature = "(obj_list, /)"]
pub fn add_edges_from(
&mut self,
obj_list: Vec<(usize, usize, PyObject)>,
) -> PyResult<Vec<usize>> {
let mut out_list: Vec<usize> = Vec::new();
for obj in obj_list {
let p_index = NodeIndex::new(obj.0);
let c_index = NodeIndex::new(obj.1);
let edge = self.graph.add_edge(p_index, c_index, obj.2);
out_list.push(edge.index());
}
Ok(out_list)
}
/// Add new edges to the graph without python data.
///
/// :param list obj_list: A list of tuples of the form
/// ``(parent, child)`` to attach to the graph. ``parent`` and
/// ``child`` are integer indexes describing where an edge should be
/// added. Unlike :meth:`add_edges_from` there is no data payload and
/// when the edge is created None will be used.
///
/// :returns: A list of int indices of the newly created edges
/// :rtype: list
#[text_signature = "(obj_list, /)"]
pub fn add_edges_from_no_data(
&mut self,
py: Python,
obj_list: Vec<(usize, usize)>,
) -> PyResult<Vec<usize>> {
let mut out_list: Vec<usize> = Vec::new();
for obj in obj_list {
let p_index = NodeIndex::new(obj.0);
let c_index = NodeIndex::new(obj.1);
let edge = self.graph.add_edge(p_index, c_index, py.None());
out_list.push(edge.index());
}
Ok(out_list)
}
/// Remove an edge between 2 nodes.
///
/// Note if there are multiple edges between the specified nodes only one
/// will be removed.
///
/// :param int parent: The index for the parent node.
/// :param int child: The index of the child node.
///
/// :raises NoEdgeBetweenNodes: If there are no edges between the nodes
/// specified
#[text_signature = "(node_a, node_b, /)"]
pub fn remove_edge(
&mut self,
node_a: usize,
node_b: usize,
) -> PyResult<()> {
let p_index = NodeIndex::new(node_a);
let c_index = NodeIndex::new(node_b);
let edge_index = match self.graph.find_edge(p_index, c_index) {
Some(edge_index) => edge_index,
None => {
return Err(NoEdgeBetweenNodes::new_err(
"No edge found between nodes",
))
}
};
self.graph.remove_edge(edge_index);
Ok(())
}
/// Remove an edge identified by the provided index
///
/// :param int edge: The index of the edge to remove
#[text_signature = "(edge, /)"]
pub fn remove_edge_from_index(&mut self, edge: usize) -> PyResult<()> {
let edge_index = EdgeIndex::new(edge);
self.graph.remove_edge(edge_index);
Ok(())
}
/// Add a new node to the graph.
///
/// :param obj: The python object to attach to the node
///
/// :returns: The index of the newly created node
/// :rtype: int
#[text_signature = "(obj, /)"]
pub fn add_node(&mut self, obj: PyObject) -> PyResult<usize> {
let index = self.graph.add_node(obj);
Ok(index.index())
}
/// Add new nodes to the graph.
///
/// :param list obj_list: A list of python object to attach to the graph.
///
/// :returns indices: A list of int indices of the newly created nodes
/// :rtype: list
#[text_signature = "(obj_list, /)"]
pub fn add_nodes_from(&mut self, obj_list: Vec<PyObject>) -> Vec<usize> {
let mut out_list: Vec<usize> = Vec::new();
for obj in obj_list {
let node_index = self.graph.add_node(obj);
out_list.push(node_index.index());
}
out_list
}
/// Remove nodes from the graph.
///
/// If a node index in the list is not present in the graph it will be
/// ignored.
///
/// :param list index_list: A list of node indicies to remove from the
/// the graph
#[text_signature = "(index_list, /)"]
pub fn remove_nodes_from(
&mut self,
index_list: Vec<usize>,
) -> PyResult<()> {
for node in index_list.iter().map(|x| NodeIndex::new(*x)) {
self.graph.remove_node(node);
}
Ok(())
}
/// Get the index and data for the neighbors of a node.
///
/// This will return a dictionary where the keys are the node indexes of
/// the adjacent nodes (inbound or outbound) and the value is the edge data
/// objects between that adjacent node and the provided node. Note, that
/// in the case of multigraphs only a single edge data object will be
/// returned
///
/// :param int node: The index of the node to get the neighbors
///
/// :returns neighbors: A dictionary where the keys are node indexes and
/// the value is the edge data object for all nodes that share an
/// edge with the specified node.
/// :rtype: dict
#[text_signature = "(node, /)"]
pub fn adj(&mut self, node: usize) -> PyResult<HashMap<usize, &PyObject>> {
let index = NodeIndex::new(node);
let neighbors = self.graph.neighbors(index);
let mut out_map: HashMap<usize, &PyObject> = HashMap::new();
for neighbor in neighbors {
let edge = self.graph.find_edge(index, neighbor);
let edge_w = self.graph.edge_weight(edge.unwrap());
out_map.insert(neighbor.index(), edge_w.unwrap());
}
Ok(out_map)
}
/// Get the degree for a node
///
/// :param int node: The index of the node to find the inbound degree of
///
/// :returns degree: The inbound degree for the specified node
/// :rtype: int
#[text_signature = "(node, /)"]
pub fn degree(&self, node: usize) -> usize {
let index = NodeIndex::new(node);
let neighbors = self.graph.edges(index);
neighbors.count()
}
/// Generate a dot file from the graph
///
/// :param node_attr: A callable that will take in a node data object
/// and return a dictionary of attributes to be associated with the
/// node in the dot file. The key and value of this dictionary **must**
/// be a string. If they're not strings retworkx will raise TypeError
/// (unfortunately without an error message because of current
/// limitations in the PyO3 type checking)
/// :param edge_attr: A callable that will take in an edge data object
/// and return a dictionary of attributes to be associated with the
/// node in the dot file. The key and value of this dictionary **must**
/// be a string. If they're not strings retworkx will raise TypeError
/// (unfortunately without an error message because of current
/// limitations in the PyO3 type checking)
/// :param dict graph_attr: An optional dictionary that specifies any graph
/// attributes for the output dot file. The key and value of this
/// dictionary **must** be a string. If they're not strings retworkx
/// will raise TypeError (unfortunately without an error message
/// because of current limitations in the PyO3 type checking)
/// :param str filename: An optional path to write the dot file to
/// if specified there is no return from the function
///
/// :returns: A string with the dot file contents if filename is not
/// specified.
/// :rtype: str
///
/// Using this method enables you to leverage graphviz to visualize a
/// :class:`retworkx.PyGraph` object. For example:
///
/// .. jupyter-execute::
///
/// import os
/// import tempfile
///
/// import pydot
/// from PIL import Image
///
/// import retworkx
///
/// graph = retworkx.undirected_gnp_random_graph(15, .25)
/// dot_str = graph.to_dot(
/// lambda node: dict(
/// color='black', fillcolor='lightblue', style='filled'))
/// dot = pydot.graph_from_dot_data(dot_str)[0]
///
/// with tempfile.TemporaryDirectory() as tmpdirname:
/// tmp_path = os.path.join(tmpdirname, 'dag.png')
/// dot.write_png(tmp_path)
/// image = Image.open(tmp_path)
/// os.remove(tmp_path)
/// image
///
#[text_signature = "(/, node_attr=None, edge_attr=None, graph_attr=None, filename=None)"]
pub fn to_dot(
&self,
py: Python,
node_attr: Option<PyObject>,
edge_attr: Option<PyObject>,
graph_attr: Option<BTreeMap<String, String>>,
filename: Option<String>,
) -> PyResult<Option<PyObject>> {
if filename.is_some() {
let mut file = File::create(filename.unwrap())?;
build_dot(py, self, &mut file, graph_attr, node_attr, edge_attr)?;
Ok(None)
} else {
let mut file = Vec::<u8>::new();
build_dot(py, self, &mut file, graph_attr, node_attr, edge_attr)?;
Ok(Some(
PyString::new(py, str::from_utf8(&file)?).to_object(py),
))
}
}
/// Add another PyGraph object into this PyGraph
///
/// :param PyGraph other: The other PyGraph object to add onto this
/// graph.
/// :param dict node_map: A dictionary mapping node indexes from this
/// PyGraph object to node indexes in the other PyGraph object.
/// The keys are a node index in this graph and the value is a tuple
/// of the node index in the other graph to add an edge to and the
/// weight of that edge. For example::
///
/// {
/// 1: (2, "weight"),
/// 2: (4, "weight2")
/// }
///
/// :param node_map_func: An optional python callable that will take in a
/// single node weight/data object and return a new node weight/data
/// object that will be used when adding an node from other onto this
/// graph.
/// :param edge_map_func: An optional python callabble that will take in a
/// single edge weight/data object and return a new edge weight/data
/// object that will be used when adding an edge from other onto this
/// graph.
///
/// :returns: new_node_ids: A dictionary mapping node index from the other
/// PyGraph to the equivalent node index in this PyDAG after they've
/// been combined
/// :rtype: dict
///
/// For example, start by building a graph:
///
/// .. jupyter-execute::
///
/// import os
/// import tempfile
///
/// import pydot
/// from PIL import Image
///
/// import retworkx
///
/// # Build first graph and visualize:
/// graph = retworkx.PyGraph()
/// node_a, node_b, node_c = graph.add_nodes_from(['A', 'B', 'C'])
/// graph.add_edges_from_no_data([(node_a, node_b), (node_b, node_c)])
/// dot_str = graph.to_dot(
/// lambda node: dict(
/// color='black', fillcolor='lightblue', style='filled'))
/// dot = pydot.graph_from_dot_data(dot_str)[0]
///
/// with tempfile.TemporaryDirectory() as tmpdirname:
/// tmp_path = os.path.join(tmpdirname, 'graph.png')
/// dot.write_png(tmp_path)
/// image = Image.open(tmp_path)
/// os.remove(tmp_path)
/// image
///
/// Then build a second one:
///
/// .. jupyter-execute::
///
/// # Build second graph and visualize:
/// other_graph = retworkx.PyGraph()
/// node_d, node_e = other_graph.add_nodes_from(['D', 'E'])
/// other_graph.add_edge(node_d, node_e, None)
/// dot_str = other_graph.to_dot(
/// lambda node: dict(
/// color='black', fillcolor='lightblue', style='filled'))
/// dot = pydot.graph_from_dot_data(dot_str)[0]
///
/// with tempfile.TemporaryDirectory() as tmpdirname:
/// tmp_path = os.path.join(tmpdirname, 'other_graph.png')
/// dot.write_png(tmp_path)
/// image = Image.open(tmp_path)
/// os.remove(tmp_path)
/// image
///
/// Finally compose the ``other_graph`` onto ``graph``
///
/// .. jupyter-execute::
///
/// node_map = {node_b: (node_d, 'B to D')}
/// graph.compose(other_graph, node_map)
/// dot_str = graph.to_dot(
/// lambda node: dict(
/// color='black', fillcolor='lightblue', style='filled'))
/// dot = pydot.graph_from_dot_data(dot_str)[0]
///
/// with tempfile.TemporaryDirectory() as tmpdirname:
/// tmp_path = os.path.join(tmpdirname, 'combined_graph.png')
/// dot.write_png(tmp_path)
/// image = Image.open(tmp_path)
/// os.remove(tmp_path)
/// image
///
#[text_signature = "(other, node_map, /, node_map_func=None, edge_map_func=None)"]
pub fn compose(
&mut self,
py: Python,
other: &PyGraph,
node_map: HashMap<usize, (usize, PyObject)>,
node_map_func: Option<PyObject>,
edge_map_func: Option<PyObject>,
) -> PyResult<HashMap<usize, usize>> {
let mut new_node_map: HashMap<NodeIndex, NodeIndex> = HashMap::new();
fn node_weight_callable(
py: Python,
node_map: &Option<PyObject>,
node: &PyObject,
) -> PyResult<PyObject> {
match node_map {
Some(node_map) => {
let res = node_map.call1(py, (node,))?;
Ok(res.to_object(py))
}
None => Ok(node.clone_ref(py)),
}
}
// TODO: Reimplement this without looping over the graphs
// Loop over other nodes add add to self graph
for node in other.graph.node_indices() {
let new_index = self.graph.add_node(node_weight_callable(
py,
&node_map_func,
&other.graph[node],
)?);
new_node_map.insert(node, new_index);
}
fn edge_weight_callable(
py: Python,
edge_map: &Option<PyObject>,
edge: &PyObject,
) -> PyResult<PyObject> {
match edge_map {
Some(edge_map) => {
let res = edge_map.call1(py, (edge,))?;
Ok(res.to_object(py))
}
None => Ok(edge.clone_ref(py)),
}
}
// loop over other edges and add to self graph
for edge in other.graph.edge_references() {
let new_p_index = new_node_map.get(&edge.source()).unwrap();
let new_c_index = new_node_map.get(&edge.target()).unwrap();
let weight =
edge_weight_callable(py, &edge_map_func, edge.weight())?;
self.graph.add_edge(*new_p_index, *new_c_index, weight);
}
// Add edges from map
for (this_index, (index, weight)) in node_map.iter() {
let new_index = new_node_map.get(&NodeIndex::new(*index)).unwrap();
self.graph.add_edge(
NodeIndex::new(*this_index),
*new_index,
weight.clone_ref(py),
);
}
let out_dict = PyDict::new(py);
for (orig_node, new_node) in new_node_map.iter() {
out_dict.set_item(orig_node.index(), new_node.index())?;
}
Ok(new_node_map.iter().map(|(old, new)| (old.index(), new.index())).collect())
}
}
#[pyproto]
impl PyMappingProtocol for PyGraph {
/// Return the nmber of nodes in the graph
fn __len__(&self) -> PyResult<usize> {
Ok(self.graph.node_count())
}
fn __getitem__(&'p self, idx: usize) -> PyResult<&'p PyObject> {
match self.graph.node_weight(NodeIndex::new(idx)) {
Some(data) => Ok(data),
None => Err(PyIndexError::new_err("No node found for index")),
}
}
fn __setitem__(&'p mut self, idx: usize, value: PyObject) -> PyResult<()> {
let data = match self
.graph
.node_weight_mut(NodeIndex::new(idx))
{
Some(node_data) => node_data,
None => {
return Err(PyIndexError::new_err("No node found for index"))
}
};
*data = value;
Ok(())
}
fn __delitem__(&'p mut self, idx: usize) -> PyResult<()> {
match self.graph.remove_node(NodeIndex::new(idx as usize)) {
Some(_) => Ok(()),
None => Err(PyIndexError::new_err("No node found for index")),
}
}
}