Add PageRank

.github/workflows/main.yml

@@ -149,7 +149,7 @@ jobs:
       - name: Download grcov
         run: curl -L https://github.com/mozilla/grcov/releases/download/v0.8.7/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar jxf -
       - name: Install deps
-        run: pip install -U setuptools-rust networkx testtools fixtures
+        run: pip install -U setuptools-rust networkx scipy testtools fixtures
       - name: Build retworkx
         run: python setup.py develop
         env:

.github/workflows/wheels.yml

@@ -72,7 +72,7 @@ jobs:
           CIBW_MANYLINUX_I686_IMAGE: quay.io/pypa/manylinux2014_i686:latest
           CIBW_SKIP: cp36-* pp* *win32 *musl*
           CIBW_BEFORE_BUILD: pip install -U setuptools-rust
-          CIBW_TEST_REQUIRES: networkx testtools fixtures
+          CIBW_TEST_REQUIRES: networkx scipy testtools fixtures
           CIBW_TEST_COMMAND: python -m unittest discover {project}/tests/rustworkx_tests
       - uses: actions/upload-artifact@v2
         with:

Cargo.toml

@@ -29,6 +29,7 @@ rayon = "1.6"
 num-traits = "0.2"
 num-bigint = "0.4"
 num-complex = "0.4"
+ndarray-stats = "0.5.1"
 quick-xml = "0.22.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
@@ -50,6 +51,10 @@ features = ["rayon"]
 version = "1.7"
 features = ["rayon"]
 
+[dependencies.sprs]
+version = "^0.11"
+features = ["multi_thread"]
+
 [profile.release]
 lto = 'fat'
 codegen-units = 1

docs/source/api.rst

@@ -56,6 +56,16 @@ Centrality
    rustworkx.betweenness_centrality
    rustworkx.eigenvector_centrality
 
+.. _link-analysis:
+
+Link Analysis
+--------------
+
+.. autosummary::
+   :toctree: apiref
+
+   rustworkx.pagerank
+
 .. _traversal:
 
 Traversal

releasenotes/notes/add-pagerank-bef0de7d46026071.yaml

@@ -0,0 +1,29 @@
+---
+features:
+  - |
+    Added a new function, :func:`~.pagerank()` which is used to
+    compute the PageRank score for all nodes in a given directed graph.
+    For example:
+
+    .. jupyter-execute::
+
+        import rustworkx as rx
+        from rustworkx.visualization import mpl_draw
+
+        graph = rx.generators.directed_hexagonal_lattice_graph(2, 2)
+        ranks = rx.pagerank(graph)
+
+        # Generate a color list
+        colors = []
+        for node in graph.node_indices():
+            pagerank_score = ranks[node]
+            graph[node] = pagerank_score
+            colors.append(pagerank_score)
+        mpl_draw(
+            graph,
+            with_labels=True,
+            node_color=colors,
+            node_size=650,
+            labels=lambda x: "{0:.2f}".format(x)
+        )
+

src/lib.rs

@@ -24,6 +24,7 @@ mod isomorphism;
 mod iterators;
 mod json;
 mod layout;
+mod link_analysis;
 mod matching;
 mod planar;
 mod random_graph;
@@ -46,6 +47,8 @@ use graphml::*;
 use isomorphism::*;
 use json::*;
 use layout::*;
+use link_analysis::*;
+
 use matching::*;
 use planar::*;
 use random_graph::*;
@@ -477,6 +480,7 @@ fn rustworkx(py: Python<'_>, m: &PyModule) -> PyResult<()> {
     m.add_wrapped(wrap_pyfunction!(read_graphml))?;
     m.add_wrapped(wrap_pyfunction!(digraph_node_link_json))?;
     m.add_wrapped(wrap_pyfunction!(graph_node_link_json))?;
+    m.add_wrapped(wrap_pyfunction!(pagerank))?;
     m.add_class::<digraph::PyDiGraph>()?;
     m.add_class::<graph::PyGraph>()?;
     m.add_class::<toposort::TopologicalSorter>()?;