Move heavy_square_graph generator to rustworkx-core (#778)

* Initial heavy square

* Final tests

* Alphabetic pub use

Co-authored-by: Ivan Carvalho <8753214+IvanIsCoding@users.noreply.github.com>

rustworkx-core/src/generators/heavy_square_graph.rs

@@ -0,0 +1,311 @@
+// 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::hash::Hash;
+
+use petgraph::data::{Build, Create};
+use petgraph::visit::{Data, NodeIndexable};
+
+use super::InvalidInputError;
+
+/// Generate an directed heavy square graph. Fig. 6 of
+/// https://arxiv.org/abs/1907.09528.
+/// An ASCII diagram of the graph is given by:
+///
+/// .. note::
+///
+///    ...       S   ...
+///       \     / \
+///        ... D   D   D ...
+///            |   |   |
+///        ... F-S-F-S-F-...
+///            |   |   |
+///        ... D   D   D ...
+///            |   |   |
+///        ... F-S-F-S-F-...
+///            |   |   |
+///            .........
+///            |   |   |
+///        ... D   D   D ...
+///             \ /     \
+///        ...   S       ...
+///
+/// NOTE: This function generates the four-frequency variant of the heavy square code.
+/// This function implements Fig 10.b left of the `paper <https://arxiv.org/abs/1907.09528>`_.
+/// This function doesn't support the variant Fig 10.b right.
+///
+/// :param int d: distance of the code. If ``d`` is set to ``1`` a
+///     :class:`~rustworkx.PyDiGraph` with a single node will be returned.
+/// :param bool multigraph: When set to False the output
+///     :class:`~rustworkx.PyDiGraph` object will not be not be a multigraph and
+///     won't  allow parallel edges to be added. Instead
+///     calls which would create a parallel edge will update the existing edge.
+///
+/// # Example
+/// ```rust
+/// use rustworkx_core::petgraph;
+/// use rustworkx_core::generators::heavy_square_graph;
+/// use rustworkx_core::petgraph::visit::EdgeRef;
+///
+/// let expected_edge_list = vec![
+///     (0, 15),
+///     (15, 1),
+///     (1, 16),
+///     (16, 2),
+///     (3, 17),
+///     (17, 4),
+///     (4, 18),
+///     (18, 5),
+///     (6, 19),
+///     (19, 7),
+///     (7, 20),
+///     (20, 8),
+///     (2, 11),
+///     (5, 11),
+///     (3, 12),
+///     (6, 12),
+///     (9, 15),
+///     (9, 17),
+///     (10, 16),
+///     (10, 18),
+///     (13, 17),
+///     (13, 19),
+///     (14, 18),
+///     (14, 20),
+/// ];
+/// let d = 3;
+/// let g: petgraph::graph::UnGraph<(), ()> = heavy_square_graph(d, || (), || (), false).unwrap();
+/// assert_eq!(g.node_count(), 3 * d * d - 2 * d);
+/// assert_eq!(g.edge_count(), 2 * d * (d - 1) + 2 * d * (d - 1));
+/// assert_eq!(
+///     expected_edge_list,
+///     g.edge_references()
+///         .map(|edge| (edge.source().index(), edge.target().index()))
+///         .collect::<Vec<(usize, usize)>>(),
+/// )
+/// ```
+pub fn heavy_square_graph<G, T, F, H, M>(
+    d: usize,
+    mut default_node_weight: F,
+    mut default_edge_weight: H,
+    bidirectional: bool,
+) -> Result<G, InvalidInputError>
+where
+    G: Build + Create + Data<NodeWeight = T, EdgeWeight = M> + NodeIndexable,
+    F: FnMut() -> T,
+    H: FnMut() -> M,
+    G::NodeId: Eq + Hash,
+{
+    if d % 2 == 0 {
+        return Err(InvalidInputError {});
+    }
+    let num_nodes = 3 * d * d - 2 * d;
+    let num_edges = 2 * d * (d - 1) + 2 * d * (d - 1);
+    let mut graph = G::with_capacity(num_nodes, num_edges);
+
+    if d == 1 {
+        graph.add_node(default_node_weight());
+        return Ok(graph);
+    }
+    let num_data = d * d;
+    let num_syndrome = d * (d - 1);
+    let num_flag = d * (d - 1);
+
+    let nodes_data: Vec<G::NodeId> = (0..num_data)
+        .map(|_| graph.add_node(default_node_weight()))
+        .collect();
+    let nodes_syndrome: Vec<G::NodeId> = (0..num_syndrome)
+        .map(|_| graph.add_node(default_node_weight()))
+        .collect();
+    let nodes_flag: Vec<G::NodeId> = (0..num_flag)
+        .map(|_| graph.add_node(default_node_weight()))
+        .collect();
+
+    // connect data and flags
+    for (i, flag_chunk) in nodes_flag.chunks(d - 1).enumerate() {
+        for (j, flag) in flag_chunk.iter().enumerate() {
+            graph.add_edge(nodes_data[i * d + j], *flag, default_edge_weight());
+            graph.add_edge(*flag, nodes_data[i * d + j + 1], default_edge_weight());
+            if bidirectional {
+                graph.add_edge(*flag, nodes_data[i * d + j], default_edge_weight());
+                graph.add_edge(nodes_data[i * d + j + 1], *flag, default_edge_weight());
+            }
+        }
+    }
+
+    // connect data and syndromes
+    for (i, syndrome_chunk) in nodes_syndrome.chunks(d).enumerate() {
+        if i % 2 == 0 {
+            graph.add_edge(
+                nodes_data[i * d + (d - 1)],
+                syndrome_chunk[syndrome_chunk.len() - 1],
+                default_edge_weight(),
+            );
+            graph.add_edge(
+                nodes_data[i * d + (2 * d - 1)],
+                syndrome_chunk[syndrome_chunk.len() - 1],
+                default_edge_weight(),
+            );
+            if bidirectional {
+                graph.add_edge(
+                    syndrome_chunk[syndrome_chunk.len() - 1],
+                    nodes_data[i * d + (d - 1)],
+                    default_edge_weight(),
+                );
+                graph.add_edge(
+                    syndrome_chunk[syndrome_chunk.len() - 1],
+                    nodes_data[i * d + (2 * d - 1)],
+                    default_edge_weight(),
+                );
+            }
+        } else if i % 2 == 1 {
+            graph.add_edge(nodes_data[i * d], syndrome_chunk[0], default_edge_weight());
+            graph.add_edge(
+                nodes_data[(i + 1) * d],
+                syndrome_chunk[0],
+                default_edge_weight(),
+            );
+            if bidirectional {
+                graph.add_edge(syndrome_chunk[0], nodes_data[i * d], default_edge_weight());
+                graph.add_edge(
+                    syndrome_chunk[0],
+                    nodes_data[(i + 1) * d],
+                    default_edge_weight(),
+                );
+            }
+        }
+    }
+
+    // connect flag and syndromes
+    for (i, syndrome_chunk) in nodes_syndrome.chunks(d).enumerate() {
+        if i % 2 == 0 {
+            for (j, syndrome) in syndrome_chunk.iter().enumerate() {
+                if j != syndrome_chunk.len() - 1 {
+                    graph.add_edge(
+                        *syndrome,
+                        nodes_flag[i * (d - 1) + j],
+                        default_edge_weight(),
+                    );
+                    graph.add_edge(
+                        *syndrome,
+                        nodes_flag[(i + 1) * (d - 1) + j],
+                        default_edge_weight(),
+                    );
+                    if bidirectional {
+                        graph.add_edge(
+                            nodes_flag[i * (d - 1) + j],
+                            *syndrome,
+                            default_edge_weight(),
+                        );
+                        graph.add_edge(
+                            nodes_flag[(i + 1) * (d - 1) + j],
+                            *syndrome,
+                            default_edge_weight(),
+                        );
+                    }
+                }
+            }
+        } else if i % 2 == 1 {
+            for (j, syndrome) in syndrome_chunk.iter().enumerate() {
+                if j != 0 {
+                    graph.add_edge(
+                        *syndrome,
+                        nodes_flag[i * (d - 1) + j - 1],
+                        default_edge_weight(),
+                    );
+                    graph.add_edge(
+                        *syndrome,
+                        nodes_flag[(i + 1) * (d - 1) + j - 1],
+                        default_edge_weight(),
+                    );
+                    if bidirectional {
+                        graph.add_edge(
+                            nodes_flag[i * (d - 1) + j - 1],
+                            *syndrome,
+                            default_edge_weight(),
+                        );
+                        graph.add_edge(
+                            nodes_flag[(i + 1) * (d - 1) + j - 1],
+                            *syndrome,
+                            default_edge_weight(),
+                        );
+                    }
+                }
+            }
+        }
+    }
+
+    Ok(graph)
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::generators::heavy_square_graph;
+    use crate::generators::InvalidInputError;
+    use crate::petgraph;
+    use crate::petgraph::visit::EdgeRef;
+
+    #[test]
+    fn test_heavy_square_3() {
+        let expected_edge_list = vec![
+            (0, 15),
+            (15, 1),
+            (1, 16),
+            (16, 2),
+            (3, 17),
+            (17, 4),
+            (4, 18),
+            (18, 5),
+            (6, 19),
+            (19, 7),
+            (7, 20),
+            (20, 8),
+            (2, 11),
+            (5, 11),
+            (3, 12),
+            (6, 12),
+            (9, 15),
+            (9, 17),
+            (10, 16),
+            (10, 18),
+            (13, 17),
+            (13, 19),
+            (14, 18),
+            (14, 20),
+        ];
+        let d = 3;
+        let g: petgraph::graph::UnGraph<(), ()> =
+            heavy_square_graph(d, || (), || (), false).unwrap();
+        assert_eq!(g.node_count(), 3 * d * d - 2 * d);
+        assert_eq!(g.edge_count(), 2 * d * (d - 1) + 2 * d * (d - 1));
+        assert_eq!(
+            expected_edge_list,
+            g.edge_references()
+                .map(|edge| (edge.source().index(), edge.target().index()))
+                .collect::<Vec<(usize, usize)>>(),
+        );
+    }
+
+    #[test]
+    fn test_error() {
+        let d = 2;
+        match heavy_square_graph::<petgraph::graph::DiGraph<(), ()>, (), _, _, ()>(
+            d,
+            || (),
+            || (),
+            false,
+        ) {
+            Ok(_) => panic!("Returned a non-error"),
+            Err(e) => assert_eq!(e, InvalidInputError),
+        };
+    }
+}

rustworkx-core/src/generators/mod.rs

@@ -15,6 +15,7 @@
 mod cycle_graph;
 mod grid_graph;
 mod heavy_hex_graph;
+mod heavy_square_graph;
 mod path_graph;
 mod petersen_graph;
 mod star_graph;
@@ -39,6 +40,7 @@ impl fmt::Display for InvalidInputError {
 pub use cycle_graph::cycle_graph;
 pub use grid_graph::grid_graph;
 pub use heavy_hex_graph::heavy_hex_graph;
+pub use heavy_square_graph::heavy_square_graph;
 pub use path_graph::path_graph;
 pub use petersen_graph::petersen_graph;
 pub use star_graph::star_graph;