Merge pull request #284 from marvin-hansen/main

feat(deep_causality): Added more code examples

Author: marvin-hansen

Cargo.lock

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+
 [workspace]
 resolver = "2"
 members = [

Cargo.toml

@@ -18,28 +18,51 @@ echo "smoking: Simple causal model without  Context"
 echo "--------------------------------"
 echo ""
 
-select opt in  csm starter smoking quit;
+select opt in  cate csm dbn granger starter scm rcm quit;
 do
   case $opt in
 
+    cate)
+      echo "Selected example: CATE (Conditional Average Treatment Effect)"
+      command cargo run --release --bin example-cate
+      break
+      ;;
+
     csm)
       echo "Selected example: CSM (Causal State Machine)"
       command cargo run --release --bin example-csm
       break
       ;;
 
+    dbn)
+      echo "Selected example: DBN (Dynamic Bayesian Network)"
+      command cargo run --release --bin example-dbn
+      break
+      ;;
+
     starter)
       echo "Selected example: Starter (Starter)"
       command cargo run --release --bin example-starter
       break
       ;;
 
-    smoking)
-      echo "Selected example: SMOKING (Smoking)"
-       command cargo run --release --bin example-smoking
+    scm)
+      echo "Selected example: scm (Structured Causal Model)"
+      command cargo run --release --bin example-scm
       break
       ;;
 
+    granger)
+      echo "Selected example: Granger (Granger causality)"
+      command cargo run --release --bin example-granger
+      break
+      ;;
+
+    rcm)
+      echo "Selected example: RCM (Rubin Causal Model)"
+       command cargo run --release --bin example-rcm
+      break
+      ;;
     quit)
       echo "Exiting!"
       exit 0

build/scripts/example.sh

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+
 [package]
 name = "dcl_data_structures"
 version = "0.9.1"

dcl_data_structures/Cargo.toml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+
 [package]
 name = "deep_causality"
 version = "0.8.1"

deep_causality/Cargo.toml

@@ -66,6 +66,9 @@ pub use crate::traits::generatable::generative_processor::GenerativeProcessor;
 // Identifiable Traits
 pub use crate::traits::identifiable::Identifiable;
 // Indexable Traits
+pub use crate::traits::indexable::data_index_current::CurrentDataIndex;
+pub use crate::traits::indexable::data_index_previous::PreviousDataIndex;
+pub use crate::traits::indexable::data_indexable::DataIndexable;
 pub use crate::traits::indexable::time_index_current::CurrentTimeIndex;
 pub use crate::traits::indexable::time_index_previous::PreviousTimeIndex;
 pub use crate::traits::indexable::time_indexable::TimeIndexable;

deep_causality/src/lib.rs

@@ -0,0 +1,34 @@
+/*
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+ */
+use crate::DataIndexable;
+
+const CURRENT_DATA_INDEX_KEY: usize = 1;
+
+pub trait CurrentDataIndex: DataIndexable {
+    /// Get the current data index.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key to look up in the index map
+    ///
+    /// # Returns
+    ///
+    /// The current data index as a `usize`.
+    ///
+    fn get_current_data_index(&self) -> Option<&usize> {
+        self.get_data_index(&CURRENT_DATA_INDEX_KEY, true)
+    }
+
+    /// Set the current data index.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key of the index to place in the index map
+    /// * `index` - The data index to set as a `usize`
+    ///
+    fn set_current_data_index(&mut self, index: usize) {
+        self.set_data_index(CURRENT_DATA_INDEX_KEY, index, true)
+    }
+}

deep_causality/src/traits/indexable/data_index_current.rs

@@ -0,0 +1,34 @@
+/*
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+ */
+use crate::DataIndexable;
+
+const PREVIOUS_DATA_INDEX_KEY: usize = 0;
+
+pub trait PreviousDataIndex: DataIndexable {
+    /// Get the previous data index.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key to look up in the index map
+    ///
+    /// # Returns
+    ///
+    /// The previous data index as a `usize`.
+    ///
+    fn get_previous_data_index(&self) -> Option<&usize> {
+        self.get_data_index(&PREVIOUS_DATA_INDEX_KEY, false)
+    }
+
+    /// Set the current previous index.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key of the previous data index to place in the index map
+    /// * `index` - The previous data index to set as a `usize`
+    ///
+    fn set_previous_data_index(&mut self, index: usize) {
+        self.set_data_index(PREVIOUS_DATA_INDEX_KEY, index, false)
+    }
+}

deep_causality/src/traits/indexable/data_index_previous.rs

@@ -0,0 +1,34 @@
+/*
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
+ */
+
+pub trait DataIndexable {
+    /// Gets the data index for the provided key from either the current or previous
+    /// index map, depending on the value of `current`.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key to look up in the index map
+    /// * `current` - Whether to check the current or previous index map
+    ///
+    /// # Returns
+    ///
+    /// Returns the index for the provided key if it exists, otherwise returns None.
+    ///
+    fn get_data_index(&self, key: &usize, current: bool) -> Option<&usize>;
+
+    /// Sets the  data index for the provided key in either the current or previous
+    /// index map, depending on the value of `current`.
+    ///
+    /// # Parameters
+    ///
+    /// * `key` - The key to insert into the index map
+    /// * `index` - The index value to associate with the key
+    /// * `current` - Whether to insert into the current or previous index map
+    ///
+    /// If the key already exists in the chosen index map, the existing value
+    /// will be overwritten with the provided `index` value.
+    ///
+    fn set_data_index(&mut self, key: usize, index: usize, current: bool);
+}

deep_causality/src/traits/indexable/data_indexable.rs

@@ -2,6 +2,9 @@
  * SPDX-License-Identifier: MIT
  * Copyright (c) "2025" . The DeepCausality Authors and Contributors. All Rights Reserved.
  */
+pub mod data_index_current;
+pub mod data_index_previous;
+pub mod data_indexable;
 pub mod time_index_current;
 pub mod time_index_previous;
 pub mod time_indexable;