Merge remote-tracking branch 'origin/HEAD' into energy_term_refactoring

Author: francoisbonneau

.vscode/settings.json

@@ -1,8 +1,9 @@
 {
-    "C_Cpp.default.cppStandard": "c++11",
+    "C_Cpp.default.cppStandard": "c++17",
     "C_Cpp.default.includePath": [
         "${workspaceFolder}/include",
         "${workspaceFolder}/build/include",
+        "${workspaceFolder:OpenGeode}/include",
         "${workspaceFolder:OpenGeode}/build/opengeode/include",
         "${workspaceFolder:OpenGeode}/build/third_party/abseil/install/include",
         "${workspaceFolder:OpenGeode}/build/third_party/bitsery/install/include",
@@ -14,6 +15,7 @@
         "${workspaceFolder}/include",
         "${workspaceFolder}/src",
         "${workspaceFolder}/build/include",
+        "${workspaceFolder:OpenGeode}/include",
         "${workspaceFolder:OpenGeode}/build/opengeode/include",
         "${workspaceFolder:OpenGeode}/build/third_party/abseil/install/include",
         "${workspaceFolder:OpenGeode}/build/third_party/bitsery/install/include",

CMakeLists.txt

@@ -31,6 +31,12 @@ option(OPENGEODE_STOCHASTIC_WITH_PYTHON "Compile Python bindings" OFF)
 # Get MyModule dependencies
 find_package(OpenGeode REQUIRED CONFIG)
 
+install(
+    FILES include/geode/stochastic/project.hpp
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/geode/stochastic
+    COMPONENT public
+)
+
 # ------------------------------------------------------------------------------------------------
 # Configure the OpenGeode-Stochastic libraries
 add_subdirectory(src/geode/stochastic)

bindings/python/src/stochastic/stochastic.cpp

@@ -38,8 +38,10 @@
 PYBIND11_MODULE( opengeode_stochastic_py_stochastic, module )
 {
     module.doc() = "OpenGeode-Stochastic Python binding";
-    pybind11::class_< geode::StochasticLibrary >( module, "StochasticLibrary" )
-        .def( "initialize", &geode::StochasticLibrary::initialize );
+    pybind11::class_< geode::OpenGeodeStochasticStochasticLibrary >(
+        module, "OpenGeodeStochasticStochasticLibrary" )
+        .def( "initialize",
+            &geode::OpenGeodeStochasticStochasticLibrary::initialize );
 
     geode::define_spatial_domain( module );
 

bindings/python/stochastic.py

@@ -22,4 +22,4 @@
 
 from opengeode_stochastic_py_stochastic import *
 
-StochasticLibrary.initialize()
+OpenGeodeStochasticStochasticLibrary.initialize()

commitlint.config.js

@@ -14,6 +14,7 @@ const Configuration = {
     "type-empty": [0],
     "type-enum": [2, "always", ["feat", "fix", "perf"]],
   },
-}
+  defaultIgnores: false,
+};
 
-export default Configuration
+export default Configuration;

include/geode/stochastic/common.hpp

@@ -23,15 +23,19 @@
 
 #pragma once
 
+#include <limits>
+
 #include <geode/basic/common.hpp>
 #include <geode/basic/library.hpp>
 #include <geode/basic/logger.hpp>
 
 #include <geode/stochastic/opengeode_stochastic_stochastic_export.hpp>
+#include <geode/stochastic/project.hpp>
 
 namespace geode
 {
-    OPENGEODE_LIBRARY( opengeode_stochastic_stochastic_api, Stochastic );
+    OPENGEODE_LIBRARY(
+        opengeode_stochastic_stochastic_api, OpenGeodeStochastic, Stochastic );
 
     static constexpr double LOG_PROB_INVALID =
         -std::numeric_limits< double >::infinity();

include/geode/stochastic/models/energy_terms/energy_term.hpp

@@ -40,9 +40,10 @@ namespace geode::detail
     {
         explicit EnergyScale( double param )
         {
-            OPENGEODE_EXCEPTION( param >= 0.,
-                "[Gibbs energy term] - The model parameter "
-                "cannot be negative." );
+            OpenGeodeStochasticStochasticException::check_exception(
+                param >= 0., nullptr, OpenGeodeException::TYPE::data,
+                "[Gibbs energy term] - The model parameter cannot be "
+                "negative." );
 
             if( param >= geode::GLOBAL_EPSILON )
             {

include/geode/stochastic/project.hpp

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2019 - 2026 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <geode/basic/assert.hpp>
+
+namespace geode
+{
+    class OpenGeodeStochasticException : public OpenGeodeException
+    {
+    protected:
+        using OpenGeodeException::OpenGeodeException;
+    };
+} // namespace geode

include/geode/stochastic/sampling/direct/object_set_sampler/point_set_sampler.hpp

@@ -40,12 +40,14 @@ namespace geode
             : ObjectSetSampler< Point< dimension > >{}, domain_( domain )
         {
             auto volume = domain_.extended_n_volume();
-            OPENGEODE_EXCEPTION( volume != 0.,
+            OpenGeodeStochasticStochasticException::check_exception(
+                volume != 0., nullptr, OpenGeodeException::TYPE::data,
                 "[PointSetSampler] - Undefined Extended Bounding "
                 "Box (volume ==0)." );
             this->log_pdf_ = -std::log( volume );
             step_move_ = define_step_for_move();
-            OPENGEODE_EXCEPTION( step_move_ > 0.,
+            OpenGeodeStochasticStochasticException::check_exception(
+                step_move_ > 0., nullptr, OpenGeodeException::TYPE::data,
                 "[PointSetSampler] - Undefined step length for move (value == ",
                 step_move_, ")." );
         }
@@ -73,10 +75,10 @@ namespace geode
                 new_point =
                     PointUniformSampler::sample< dimension >( engine, ball );
             }
-            throw OpenGeodeException(
-                absl::StrCat( "[PointSampler] - Cannot find a point in the "
-                              "extended domain" ) );
-            return obj;
+            throw OpenGeodeStochasticStochasticException{ nullptr,
+                OpenGeodeException::TYPE::internal,
+                "[PointSampler] - Cannot find a point in the "
+                "extended domain" };
         }
 
     private:

include/geode/stochastic/sampling/direct/object_set_sampler/segment_set_sampler.hpp

@@ -45,7 +45,8 @@ namespace geode
               azimuth_{ azimuth }
         {
             auto volume = domain_.extended_n_volume();
-            OPENGEODE_EXCEPTION( volume != 0.,
+            OpenGeodeStochasticStochasticException::check_exception(
+                volume != 0., nullptr, OpenGeodeException::TYPE::data,
                 "[SegmentSetSampler] - Undefined Extended Bounding "
                 "Box (volume ==0)." );
             this->log_pdf_ = -std::log( volume );
@@ -83,8 +84,9 @@ namespace geode
                 }
                 new_point = PointUniformSampler::sample< 2 >( engine, ball );
             }
-            throw OpenGeodeException( absl::StrCat(
-                "[SegmentSetSampler] - Cannot find a point in the box" ) );
+            throw OpenGeodeStochasticStochasticException{ nullptr,
+                OpenGeodeException::TYPE::internal,
+                "[SegmentSetSampler] - Cannot find a point in the box" };
             return obj;
         }