Add token swapper to rustworkx-core

releasenotes/notes/added-token-swapper-bd168eeb5a31bd99.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added a new function, :func:`~.token_swapper()` which performs an
+    approximately optimal Token Swapping algorithm and supports partial
+    mappings (i.e. not-permutations) for graphs with missing tokens.

rustworkx-core/Cargo.toml

@@ -14,6 +14,8 @@ keywords = ["graph"]
 ahash = "0.8.0"
 fixedbitset = "0.4.2"
 petgraph = "0.6.3"
+rand = "0.8.5"
+rand_pcg = "0.3.1"
 rayon = "1.6"
 num-traits = "0.2"
 priority-queue = "1.2"

rustworkx-core/src/lib.rs

@@ -50,6 +50,7 @@
 //! * [`connectivity`](./connectivity/index.html)
 //! * [`max_weight_matching`](./max_weight_matching/index.html)
 //! * [`shortest_path`](./shortest_path/index.html)
+//! * [`token_swapper`](./token_swapper/index.html)
 //! * [`traversal`](./traversal/index.html)
 //! * [`generators`](./generators/index.html)
 //!
@@ -82,6 +83,8 @@ pub mod traversal;
 pub mod dictmap;
 pub mod distancemap;
 mod min_scored;
+/// Module for swapping tokens
+pub mod token_swapper;
 pub mod utils;
 
 // re-export petgraph so there is a consistent version available to users and