Add create functions that accept arguments of type BitDecomposableSta…

…tisticVector to the class IDecomposableRuleEvaluationFactory.
mrapp-ke · Aug 30, 2024 · 7eb512b · 7eb512b
1 parent d7fb124
commit 7eb512b
Show file tree

Hide file tree

Showing 15 changed files with 183 additions and 0 deletions.
diff --git a/...bprojects/boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable.hpp b/...bprojects/boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable.hpp
@@ -3,6 +3,7 @@
  */
 #pragma once
 
+#include "mlrl/boosting/data/vector_statistic_decomposable_bit.hpp"
 #include "mlrl/boosting/data/vector_statistic_decomposable_dense.hpp"
 #include "mlrl/boosting/rule_evaluation/rule_evaluation.hpp"
 #include "mlrl/common/indices/index_vector_complete.hpp"
@@ -52,6 +53,36 @@ namespace boosting {
              */
             virtual std::unique_ptr<IRuleEvaluation<DenseDecomposableStatisticVector>> create(
               const DenseDecomposableStatisticVector& statisticVector, const PartialIndexVector& indexVector) const = 0;
+
+            /**
+             * Creates a new instance of the class `IRuleEvaluation` that allows to calculate the predictions of rules
+             * that predict for all available outputs, based on the gradients and Hessians that are stored by a
+             * `BitDecomposableStatisticVector`.
+             *
+             * @param statisticVector   A reference to an object of type `BitDecomposableStatisticVector`. This vector
+             *                          is only used to identify the function that is able to deal with this particular
+             *                          type of vector via function overloading
+             * @param indexVector       A reference to an object of the type `CompleteIndexVector` that provides access
+             *                          to the indices of the outputs for which the rules may predict
+             * @return                  An unique pointer to an object of type `IRuleEvaluation` that has been created
+             */
+            virtual std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector, const CompleteIndexVector& indexVector) const = 0;
+
+            /**
+             * Creates a new instance of the class `IRuleEvaluation` that allows to calculate the predictions of rules
+             * that predict for a subset of the available outputs, based on the gradients and Hessians that are stored
+             * by a `BitDecomposableStatisticVector`.
+             *
+             * @param statisticVector   A reference to an object of type `BitDecomposableStatisticVector`. This vector
+             *                          is only used to identify the function that is able to deal with this particular
+             *                          type of vector via function overloading
+             * @param indexVector       A reference to an object of the type `PartialIndexVector` that provides access
+             *                          to the indices of the outputs for which the rules may predict
+             * @return                  An unique pointer to an object of type `IRuleEvaluation` that has been created
+             */
+            virtual std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector, const PartialIndexVector& indexVector) const = 0;
     };
 
 }
diff --git a/.../boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete.hpp b/.../boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete.hpp
@@ -37,6 +37,14 @@ namespace boosting {
             std::unique_ptr<IRuleEvaluation<DenseDecomposableStatisticVector>> create(
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
     };
 
 }
diff --git a/...ng/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete_binned.hpp b/...ng/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete_binned.hpp
@@ -44,6 +44,14 @@ namespace boosting {
             std::unique_ptr<IRuleEvaluation<DenseDecomposableStatisticVector>> create(
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
     };
 
 }
diff --git a/...ng/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic.hpp b/...ng/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic.hpp
@@ -55,6 +55,14 @@ namespace boosting {
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
 
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
+
             std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>> create(
               const SparseDecomposableStatisticVector& statisticVector,
               const CompleteIndexVector& indexVector) const override;

diff --git a/...ude/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic_binned.hpp b/...ude/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic_binned.hpp
@@ -62,6 +62,14 @@ namespace boosting {
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
 
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
+
             std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>> create(
               const SparseDecomposableStatisticVector& statisticVector,
               const CompleteIndexVector& indexVector) const override;

diff --git a/...ting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed.hpp b/...ting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed.hpp
@@ -55,6 +55,14 @@ namespace boosting {
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
 
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
+
             std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>> create(
               const SparseDecomposableStatisticVector& statisticVector,
               const CompleteIndexVector& indexVector) const override;

diff --git a/...clude/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed_binned.hpp b/...clude/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed_binned.hpp
@@ -61,6 +61,14 @@ namespace boosting {
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
 
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
+
             std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>> create(
               const SparseDecomposableStatisticVector& statisticVector,
               const CompleteIndexVector& indexVector) const override;

diff --git a/...ts/boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_single.hpp b/...ts/boosting/include/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_single.hpp
@@ -39,6 +39,14 @@ namespace boosting {
               const DenseDecomposableStatisticVector& statisticVector,
               const PartialIndexVector& indexVector) const override;
 
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const CompleteIndexVector& indexVector) const override;
+
+            std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> create(
+              const BitDecomposableStatisticVector& statisticVector,
+              const PartialIndexVector& indexVector) const override;
+
             std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>> create(
               const SparseDecomposableStatisticVector& statisticVector,
               const CompleteIndexVector& indexVector) const override;

diff --git a/...ects/boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete.cpp b/...ects/boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete.cpp
@@ -24,4 +24,16 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_);
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> DecomposableCompleteRuleEvaluationFactory::create(
+      const BitDecomposableStatisticVector& statisticVector, const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>> DecomposableCompleteRuleEvaluationFactory::create(
+      const BitDecomposableStatisticVector& statisticVector, const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
 }
diff --git a/...osting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete_binned.cpp b/...osting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_complete_binned.cpp
@@ -28,4 +28,18 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_, std::move(labelBinningPtr));
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableCompleteBinnedRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                              const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableCompleteBinnedRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                              const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
 }
diff --git a/...osting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic.cpp b/...osting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic.cpp
@@ -107,6 +107,20 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_);
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableDynamicPartialRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                              const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableDynamicPartialRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                              const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
     std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>>
       DecomposableDynamicPartialRuleEvaluationFactory::create(const SparseDecomposableStatisticVector& statisticVector,
                                                               const CompleteIndexVector& indexVector) const {

diff --git a/...src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic_binned.cpp b/...src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_dynamic_binned.cpp
@@ -115,6 +115,20 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_, std::move(labelBinningPtr));
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableDynamicPartialBinnedRuleEvaluationFactory::create(
+        const BitDecomposableStatisticVector& statisticVector, const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableDynamicPartialBinnedRuleEvaluationFactory::create(
+        const BitDecomposableStatisticVector& statisticVector, const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
     std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>>
       DecomposableDynamicPartialBinnedRuleEvaluationFactory::create(
         const SparseDecomposableStatisticVector& statisticVector, const CompleteIndexVector& indexVector) const {

diff --git a/...boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed.cpp b/...boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed.cpp
@@ -99,6 +99,20 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_);
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableFixedPartialRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                            const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableFixedPartialRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                            const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
     std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>>
       DecomposableFixedPartialRuleEvaluationFactory::create(const SparseDecomposableStatisticVector& statisticVector,
                                                             const CompleteIndexVector& indexVector) const {

diff --git a/...g/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed_binned.cpp b/...g/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_partial_fixed_binned.cpp
@@ -99,6 +99,20 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_, std::move(labelBinningPtr));
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableFixedPartialBinnedRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                                  const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableFixedPartialBinnedRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                                  const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
     std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>>
       DecomposableFixedPartialBinnedRuleEvaluationFactory::create(
         const SparseDecomposableStatisticVector& statisticVector, const CompleteIndexVector& indexVector) const {

diff --git a/...ojects/boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_single.cpp b/...ojects/boosting/src/mlrl/boosting/rule_evaluation/rule_evaluation_decomposable_single.cpp
@@ -91,6 +91,20 @@ namespace boosting {
           indexVector, l1RegularizationWeight_, l2RegularizationWeight_);
     }
 
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableSingleOutputRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                            const CompleteIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
+    std::unique_ptr<IRuleEvaluation<BitDecomposableStatisticVector>>
+      DecomposableSingleOutputRuleEvaluationFactory::create(const BitDecomposableStatisticVector& statisticVector,
+                                                            const PartialIndexVector& indexVector) const {
+        // TODO Implement
+        return nullptr;
+    }
+
     std::unique_ptr<IRuleEvaluation<SparseDecomposableStatisticVector>>
       DecomposableSingleOutputRuleEvaluationFactory::create(const SparseDecomposableStatisticVector& statisticVector,
                                                             const CompleteIndexVector& indexVector) const {