sdd: children of SddOr stored in BTreeSet instead of Vec

jsfpdn · Mar 2, 2024 · 29d82e7 · 29d82e7
1 parent ef01de2
commit 29d82e7
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 18 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -2,4 +2,6 @@ pub mod literal;
 pub mod manager;
 pub mod options;
 pub mod sdd;
+#[macro_use]
+pub mod util;
 pub mod vtree;
diff --git a/src/manager.rs b/src/manager.rs
@@ -14,7 +14,9 @@ pub struct SddManager {
 
     var_label_manager: VarLabelManager,
 
-    nodes: HashMap<u64, Node>,
+    // Unique table holding all the decision nodes.
+    // More details can be found in [Algorithms and Data Structures in VLSI Design](https://link.springer.com/book/10.1007/978-3-642-58940-9).
+    unqiue_table: HashMap<u64, Node>,
 }
 
 impl SddManager {
@@ -24,7 +26,7 @@ impl SddManager {
             options,
             vtree_manager: VTreeManager::new(),
             var_label_manager: VarLabelManager::new(),
-            nodes: HashMap::new(),
+            unqiue_table: HashMap::new(),
         }
     }
 
@@ -34,13 +36,13 @@ impl SddManager {
             options,
             vtree_manager: VTreeManager::new(),
             var_label_manager: VarLabelManager::new(),
-            nodes,
+            unqiue_table: nodes,
         }
     }
 
     #[must_use]
     pub fn get_node(&self, id: &u64) -> Option<&Node> {
-        self.nodes.get(id)
+        self.unqiue_table.get(id)
     }
 
     pub fn conjoin(&self, _fst: &Sdd, _snd: &Sdd) {}

diff --git a/src/sdd.rs b/src/sdd.rs
@@ -1,4 +1,4 @@
-use std::collections::HashSet;
+use std::collections::{BTreeSet, HashSet};
 use std::hash::Hash;
 
 use crate::literal::Literal;
@@ -10,14 +10,13 @@ mod sdd_test;
 
 type NodeIndex = u64;
 
-#[derive(PartialEq, Eq, Clone)]
-// TODO: Implement custom hashing scheme.
+#[derive(PartialEq, Eq, Clone, Hash)]
 pub struct Node {
     sdd: Sdd,
 
     // Index of the parent node in the SDDManager.nodes vector.
     parent: Option<NodeIndex>,
-    index: NodeIndex,
+    index: NodeIndex, // index == sdd::hash
 }
 
 impl Node {
@@ -123,7 +122,7 @@ impl Sdd {
 #[derive(Hash, PartialEq, Eq, Clone)]
 #[allow(clippy::module_name_repetitions)]
 pub struct SddOr {
-    elements: Vec<NodeIndex>,
+    elements: BTreeSet<NodeIndex>,
 }
 
 impl SddOr {

diff --git a/src/sdd_test.rs b/src/sdd_test.rs
@@ -1,10 +1,12 @@
-mod tests {
+#[allow(clippy::module_inception)]
+mod sdd_test {
     use std::collections::HashMap;
 
     use crate::{
         literal::{Literal, VarLabel},
         options::SddOptions,
         sdd::{Node, Sdd, SddAnd, SddManager, SddOr},
+        util::btreeset,
     };
 
     #[test]
@@ -25,7 +27,13 @@ mod tests {
                 // Decomposition `{(true, false)}`.
                 (
                     3_u64,
-                    Node::new(Sdd::Decision(SddOr { elements: vec![2] }), None, 3),
+                    Node::new(
+                        Sdd::Decision(SddOr {
+                            elements: btreeset!(2),
+                        }),
+                        None,
+                        3,
+                    ),
                 ),
             ]),
         );
@@ -59,7 +67,13 @@ mod tests {
                 // Decomposition `{(true, A)}`.
                 (
                     3_u64,
-                    Node::new(Sdd::Decision(SddOr { elements: vec![2] }), None, 3),
+                    Node::new(
+                        Sdd::Decision(SddOr {
+                            elements: btreeset!(2),
+                        }),
+                        None,
+                        3,
+                    ),
                 ),
             ]),
         );
@@ -111,7 +125,7 @@ mod tests {
                     6_u64,
                     Node::new(
                         Sdd::Decision(SddOr {
-                            elements: vec![4, 5],
+                            elements: btreeset!(4, 5),
                         }),
                         Some(42),
                         6,
@@ -158,7 +172,13 @@ mod tests {
                 // Decomposition `{(true, !B)}`. This is where the SDD stops being trimmed.
                 (
                     4_u64,
-                    Node::new(Sdd::Decision(SddOr { elements: vec![3] }), Some(42), 4),
+                    Node::new(
+                        Sdd::Decision(SddOr {
+                            elements: btreeset!(3),
+                        }),
+                        Some(42),
+                        4,
+                    ),
                 ),
                 // Element `(A, true)`.
                 (
@@ -177,7 +197,7 @@ mod tests {
                     8_u64,
                     Node::new(
                         Sdd::Decision(SddOr {
-                            elements: vec![4, 7],
+                            elements: btreeset!(4, 7),
                         }),
                         Some(42),
                         8,
@@ -251,7 +271,7 @@ mod tests {
                     6_u64,
                     Node::new(
                         Sdd::Decision(SddOr {
-                            elements: vec![3, 5],
+                            elements: btreeset!(3, 5),
                         }),
                         None,
                         6,
@@ -305,7 +325,13 @@ mod tests {
                 // Decomposition `{(!B, true)}`.
                 (
                     6_u64,
-                    Node::new(Sdd::Decision(SddOr { elements: vec![4] }), Some(42), 6),
+                    Node::new(
+                        Sdd::Decision(SddOr {
+                            elements: btreeset!(4),
+                        }),
+                        Some(42),
+                        6,
+                    ),
                 ),
                 // Element `(ptr, false)` where ptr is `{(!B, true)}`.
                 (
@@ -317,7 +343,7 @@ mod tests {
                     8_u64,
                     Node::new(
                         Sdd::Decision(SddOr {
-                            elements: vec![5, 7],
+                            elements: btreeset!(5, 7),
                         }),
                         Some(42),
                         8,

diff --git a/src/util.rs b/src/util.rs
@@ -0,0 +1,16 @@
+#[allow(unused_macros)]
+macro_rules! btreeset {
+    ( $( $x:expr ),* ) => {
+        {
+            use std::collections::BTreeSet;
+            let mut temp_btreeset = BTreeSet::new();
+            $(
+                temp_btreeset.insert($x);
+            )*
+            temp_btreeset
+        }
+    };
+}
+
+#[allow(unused_imports)]
+pub(crate) use btreeset;