commit 180fbd8f1f0d92a496bf1f245b659095cf8392b5
author Jean-Marie Comets <jean.marie.comets@gmail.com> Sat Sep 14 14:50:16 2019 +0200
committer Jean-Marie Comets <jean.marie.comets@gmail.com> Sat Sep 28 13:03:02 2019 +0200
tree e49b7f91442a15dede1bf45beac08729698d0f92
parent b9ee0838681ff5648f572a442053f11730bd9f99

MatrixGraph: rename `with_nodes()` to `with_capacity()`

benches/matrix_graph.rs

diff --git a/benches/matrix_graph.rs b/benches/matrix_graph.rs
index a8ebdb6..ef81733 100644
--- a/benches/matrix_graph.rs
+++ b/benches/matrix_graph.rs
@@ -12,7 +12,7 @@
 #[bench]
 fn add_100_nodes(b: &mut test::Bencher) {
     b.iter(|| {
-        let mut g = MatrixGraph::<(), ()>::with_nodes(100);
+        let mut g = MatrixGraph::<(), ()>::with_capacity(100);
 
         for _ in 0..100 {
             let _ = g.add_node(());
@@ -22,7 +22,7 @@
 
 #[bench]
 fn add_100_edges_to_self(b: &mut test::Bencher) {
-    let mut g = MatrixGraph::<(), ()>::with_nodes(100);
+    let mut g = MatrixGraph::<(), ()>::with_capacity(100);
     let nodes: Vec<_> = (0..100).map(|_| g.add_node(())).collect();
     let g = g;
 
@@ -37,7 +37,7 @@
 
 #[bench]
 fn add_5_edges_for_each_of_100_nodes(b: &mut test::Bencher) {
-    let mut g = MatrixGraph::<(), ()>::with_nodes(100);
+    let mut g = MatrixGraph::<(), ()>::with_capacity(100);
     let nodes: Vec<_> = (0..100).map(|_| g.add_node(())).collect();
     let g = g;
 

src/matrix_graph.rs

diff --git a/src/matrix_graph.rs b/src/matrix_graph.rs
index 1e57e56..8d70a03 100644
--- a/src/matrix_graph.rs
+++ b/src/matrix_graph.rs
@@ -225,18 +225,18 @@
 
 impl<N, E, Ty: EdgeType, Null: Nullable<Wrapped=E>, Ix: IndexType> MatrixGraph<N, E, Ty, Null, Ix> {
     /// Create a new `MatrixGraph` with estimated capacity for nodes.
-    pub fn with_nodes(nodes: usize) -> Self {
+    pub fn with_capacity(node_capacity: usize) -> Self {
         let mut m = Self {
             node_adjacencies: vec![],
             node_capacity: 0,
-            nodes: IdStorage::with_capacity(nodes),
+            nodes: IdStorage::with_capacity(node_capacity),
             nb_edges: 0,
             ty: PhantomData,
             ix: PhantomData,
         };
 
-        debug_assert!(nodes <= <Ix as IndexType>::max().index());
-        m.extend_capacity_for_node(NodeIndex::new(nodes));
+        debug_assert!(node_capacity <= <Ix as IndexType>::max().index());
+        m.extend_capacity_for_node(NodeIndex::new(node_capacity));
 
         m
     }
@@ -934,14 +934,14 @@
 /// Create a new empty `MatrixGraph`.
 impl<N, E, Ty: EdgeType, Null: Nullable<Wrapped=E>, Ix: IndexType> Default for MatrixGraph<N, E, Ty, Null, Ix> {
     fn default() -> Self {
-        Self::with_nodes(0)
+        Self::with_capacity(0)
     }
 }
 
 impl<N, E> MatrixGraph<N, E, Directed> {
     /// Create a new `MatrixGraph` with directed edges.
     ///
-    /// This is a convenience method. Use `MatrixGraph::with_nodes` or `MatrixGraph::default` for
+    /// This is a convenience method. Use `MatrixGraph::with_capacity` or `MatrixGraph::default` for
     /// a constructor that is generic in all the type parameters of `MatrixGraph`.
     pub fn new() -> Self {
         MatrixGraph::default()
@@ -951,7 +951,7 @@
 impl<N, E> MatrixGraph<N, E, Undirected> {
     /// Create a new `MatrixGraph` with undirected edges.
     ///
-    /// This is a convenience method. Use `MatrixGraph::with_nodes` or `MatrixGraph::default` for
+    /// This is a convenience method. Use `MatrixGraph::with_capacity` or `MatrixGraph::default` for
     /// a constructor that is generic in all the type parameters of `MatrixGraph`.
     pub fn new_undirected() -> Self {
         MatrixGraph::default()
@@ -1150,8 +1150,8 @@
     }
 
     #[test]
-    fn test_with_nodes() {
-        let g = MatrixGraph::<i32, i32>::with_nodes(10);
+    fn test_with_capacity() {
+        let g = MatrixGraph::<i32, i32>::with_capacity(10);
         assert_eq!(g.node_count(), 0);
         assert_eq!(g.edge_count(), 0);
     }