feat(string): add classes descriptions

francoisbonneau · francoisbonneau · commit 7b254838f727 · 2025-10-08T21:02:12.000+02:00
diff --git a/include/geode/stochastic/sampling/direct/object_set_sampler/object_set_sampler.hpp b/include/geode/stochastic/sampling/direct/object_set_sampler/object_set_sampler.hpp
@@ -32,7 +32,7 @@ namespace geode
     class ObjectSetSampler
     {
     public:
-        ObjectSetSampler( uuid subset_id ) : subset_id_{ subset_id } {}
+        ObjectSetSampler( const uuid& subset_id ) : subset_id_( subset_id ) {}
         virtual ~ObjectSetSampler() = default;
 
         virtual std::pair< Type, uuid > sample(
@@ -60,6 +60,6 @@ namespace geode
         virtual double log_pdf( const Type& obj ) const = 0;
 
     protected:
-        uuid subset_id_;
+        const uuid& subset_id_;
     };
 } // namespace geode
diff --git a/include/geode/stochastic/sampling/direct/object_set_sampler/point_set_sampler.hpp b/include/geode/stochastic/sampling/direct/object_set_sampler/point_set_sampler.hpp
@@ -36,8 +36,8 @@ namespace geode
     {
     public:
         UniformPointSetSampler(
-            const BoundingBox< dimension >& box, uuid subset_id )
-            : ObjectSetSampler< Point< dimension > >{ subset_id }, box_( box )
+            const BoundingBox< dimension >& box, const uuid& subset_id )
+            : ObjectSetSampler< Point< dimension > >( subset_id ), box_( box )
         {
             auto volume = box_.n_volume();
             if( volume != 0. )
@@ -62,12 +62,21 @@ namespace geode
 
             auto new_point =
                 PointUniformSampler::sample< dimension >( engine, ball );
-            while( !box_.contains( new_point ) )
+            constexpr index_t max_try{ 100 };
+            for( const auto try_id : geode::Range{ max_try } )
             {
+                if( box_.contains( new_point ) )
+                {
+                    return { new_point, this->subset_id_ };
+                }
                 new_point =
                     PointUniformSampler::sample< dimension >( engine, ball );
             }
-            return { new_point, this->subset_id_ };
+            OPENGEODE_EXCEPTION( true == false,
+                absl::StrCat(
+                    "[PointSampler] - Cannot find a point in the box: ",
+                    box_.string() ) );
+            return { obj, this->subset_id_ };
         }
 
         double log_pdf( const Point< dimension >& obj ) const override
diff --git a/include/geode/stochastic/sampling/mcmc/metropolis_hasting_sampler.hpp b/include/geode/stochastic/sampling/mcmc/metropolis_hasting_sampler.hpp
@@ -83,7 +83,6 @@ namespace geode
         {
             Proposal< Type > proposal =
                 proposal_kernel_->propose( state, engine );
-
             if( proposal.type == Proposal< Type >::Move::Birth )
             {
                 return birth_step( proposal, state, engine );
diff --git a/include/geode/stochastic/sampling/mcmc/models/components/energy_term.hpp b/include/geode/stochastic/sampling/mcmc/models/components/energy_term.hpp
@@ -76,6 +76,22 @@ namespace geode
 
 namespace geode
 {
+    //    struct EnergyTermDescription
+    //    {
+    //        geode::uuid id;
+    //        std::string name;
+    //        std::string type;
+    //        double parameter_value;
+    //        std::optional< uuid > targeted_subset_id{};
+    //    }
+    //
+    //    struct StatisticalDescription
+    //    {
+    //        std::string label;
+    //        double value;
+    //        std::optional< uuid > targeted_subset_id{};
+    //    };
+
     template < typename ObjectType >
     class EnergyTerm
     {
@@ -138,6 +154,19 @@ namespace geode
         virtual double statistic(
             const ObjectSet< ObjectType >& state ) const = 0;
 
+        std::string string() const
+        {
+            auto message =
+                absl::StrCat( "Term : ", name(), "; uuid: ", id().string(),
+                    " parameter value: ", energy_scale_.parameter() );
+            if( targeted_subset_id_ )
+            {
+                absl::StrAppend( &message, " targetted subset: ",
+                    targeted_subset_id_.value().string() );
+            }
+            return message;
+        }
+
     protected:
         bool is_targeted_subset( const uuid& subset_id ) const
         {
diff --git a/include/geode/stochastic/sampling/mcmc/models/gibbs_energy.hpp b/include/geode/stochastic/sampling/mcmc/models/gibbs_energy.hpp
@@ -31,15 +31,22 @@ namespace geode
     template < typename ObjectType >
     class GibbsEnergy
     {
-        OPENGEODE_DISABLE_COPY_AND_MOVE( GibbsEnergy );
+        OPENGEODE_DISABLE_COPY( GibbsEnergy );
 
     public:
         GibbsEnergy() = default;
+        GibbsEnergy( GibbsEnergy&& other )
+            : energy_terms_( std::move( other.energy_terms_ ) )
+        {
+        }
+
         ~GibbsEnergy() = default;
 
-        void add_energy_term( std::unique_ptr< EnergyTerm< ObjectType > > term )
+        uuid add_energy_term( std::unique_ptr< EnergyTerm< ObjectType > > term )
         {
+            auto id = term->id();
             energy_terms_.emplace( term->id(), std::move( term ) );
+            return id;
         }
         void clear_energy_terms()
         {
@@ -116,6 +123,12 @@ namespace geode
             return log_energy;
         }
 
+        double energy_term_statistic(
+            const ObjectSet< ObjectType >& state, const uuid& energy_term_id )
+        {
+            return energy_terms_.at( energy_term_id )->statistic( state );
+        }
+
         std::vector< double > ordered_energy_term_statistics(
             const ObjectSet< ObjectType >& state ) const
         {
@@ -137,6 +150,20 @@ namespace geode
             return vector_string( stats );
         }
 
+        std::string string() const
+        {
+            auto message = absl::StrCat(
+                "Gibbs Energy: ", energy_terms_.size(), " terms:" );
+            // we should find a way to iterate in a ordered way.
+            for( const auto& energy_term : energy_terms_ )
+            {
+                absl::StrAppend( &message,
+                    "\n\t --> uuid: ", energy_term.first.string(), " - ",
+                    energy_term.second->string() );
+            }
+            return message;
+        }
+
     private:
         std::string vector_string( const std::vector< double >& vector ) const
         {
diff --git a/include/geode/stochastic/sampling/mcmc/proposal/moves.hpp b/include/geode/stochastic/sampling/mcmc/proposal/moves.hpp
@@ -23,6 +23,7 @@
 
 #pragma once
 #include <geode/stochastic/sampling/direct/object_set_sampler/object_set_sampler.hpp>
+#include <geode/stochastic/spatial/object_helpers.hpp>
 #include <geode/stochastic/spatial/object_set.hpp>
 
 namespace geode
@@ -44,6 +45,26 @@ namespace geode
         std::optional< ObjectId > old_object_id; // for death/change
         double log_forward_prob{ 0. };
         double log_backward_prob{ 0. };
+        std::string string() const
+        {
+            auto message = absl::StrCat( "Poposal: Type ", type );
+            if( new_object )
+            {
+                absl::StrAppend( &message, "\n\t - New object: ",
+                    geode::object_bounding_box( new_object->first ).string(),
+                    " subset id ", new_object->second.string() );
+            }
+            if( old_object_id )
+            {
+                absl::StrAppend( &message,
+                    "\n\t - Old object: ", old_object_id->index, " subset id ",
+                    old_object_id->subset.string() );
+            }
+            absl::StrAppend( &message,
+                "\n\t - log_forward_prob: ", log_forward_prob,
+                " log_backward_prob ", log_backward_prob );
+            return message;
+        }
     };
 
     // Move does not hold the sampler... should it?
@@ -55,6 +76,10 @@ namespace geode
             const ObjectSetSampler< ObjectType >& sampler, double probability )
             : sampler_( sampler ), p_move_{ probability }
         {
+            OPENGEODE_EXCEPTION( p_move_ > 0.,
+                "[Move] - the weight factor for a move should be in higher "
+                "than 0. (here = ",
+                p_move_, ")" );
         }
         virtual ~Move() = default;
 
@@ -67,6 +92,11 @@ namespace geode
             return p_move_;
         }
 
+        std::string string() const
+        {
+            return absl::StrCat( "Move proba: ", p_move_ );
+        }
+
     protected:
         const ObjectSetSampler< ObjectType >& sampler_;
         double p_move_{ 1.0 };
@@ -94,10 +124,13 @@ namespace geode
             const ObjectSet< ObjectType >& current,
             RandomEngine& engine ) const override
         {
+            DEBUG( "Birth Death move" );
             if( engine.sample_bernoulli( birth_ratio_ ) )
             {
+                DEBUG( "Birth  move" );
                 return propose_birth_move( current, engine );
             }
+            DEBUG( " Death move" );
             return propose_death_move( current, engine );
         }
 
diff --git a/include/geode/stochastic/sampling/mcmc/proposal/proposal_kernel.hpp b/include/geode/stochastic/sampling/mcmc/proposal/proposal_kernel.hpp
@@ -64,10 +64,27 @@ namespace geode
             compute_cumulative_sum_probs();
         }
 
+        std::string string() const
+        {
+            auto message = absl::StrCat(
+                "Proposal Kernel:", "\n\t - number of moves: ", moves_.size() );
+            for( const auto& move : moves_ )
+            {
+                absl::StrAppend( &message, " \n\t --> ", move->string() );
+            }
+            absl::StrAppend( &message, "\n\t - cumsum :" );
+            for( const auto cumsum : cumulative_probs_ )
+            {
+                absl::StrAppend( &message, " ", cumsum );
+            }
+            return message;
+        }
+
     private:
         void compute_cumulative_sum_probs()
         {
             const auto n = moves_.size();
+            cumulative_probs_.clear();
             cumulative_probs_.resize( n );
             if( n == 1 )
             {
diff --git a/include/geode/stochastic/spatial/object_set.hpp b/include/geode/stochastic/spatial/object_set.hpp
@@ -67,6 +67,7 @@ namespace geode
         index_t nb_objects() const;
 
         void add_subset( const uuid& subset_id );
+        uuid add_subset();
         ObjectId add_object( Type&& object, const uuid& subset_id );
         void update_object( const ObjectId& object_id, Type&& object );
         void remove_object( const ObjectId& object_id );
@@ -79,6 +80,8 @@ namespace geode
         std::vector< ObjectId > neighbors(
             const Type& object, double searching_distance ) const;
 
+        std::string string() const;
+
     private:
         std::vector< Type >& get_subset( const uuid& subset_id );
 
diff --git a/src/geode/stochastic/spatial/object_set.cpp b/src/geode/stochastic/spatial/object_set.cpp
@@ -98,6 +98,16 @@ namespace geode
         OPENGEODE_EXCEPTION( inserted, "[ObjectSet]- group (",
             subset_id.string(), ") already exists." );
     }
+    template < typename Type >
+    uuid ObjectSet< Type >::add_subset()
+    {
+        uuid subset_id{};
+        auto [it, inserted] =
+            groups_.emplace( subset_id, std::vector< Type >{} );
+        OPENGEODE_EXCEPTION( inserted, "[ObjectSet]- group (",
+            subset_id.string(), ") already exists." );
+        return subset_id;
+    }
 
     template < typename Type >
     ObjectId ObjectSet< Type >::add_object(
@@ -197,6 +207,20 @@ namespace geode
             static_cast< const ObjectSet* >( this )->get_subset( subset_id ) );
     }
 
+    template < typename Type >
+    std::string ObjectSet< Type >::string() const
+    {
+        auto message =
+            absl::StrCat( "ObjectSet with ", nb_subsets(), " subsets:" );
+        for( const auto& [subset_id, objs] : groups_ )
+        {
+            absl::StrAppend( &message,
+                "\n\t --> subset uuid: ", subset_id.string(),
+                "; number of objects: ", objs.size() );
+        }
+        return message;
+    }
+
     template class opengeode_stochastic_stochastic_api ObjectSet< Point2D >;
     template class opengeode_stochastic_stochastic_api ObjectSet< Point3D >;
     template class opengeode_stochastic_stochastic_api
diff --git a/tests/stochastic/CMakeLists.txt b/tests/stochastic/CMakeLists.txt
@@ -106,16 +106,15 @@ add_geode_test(
  )
 
 add_geode_test(
-    SOURCE  "sampling/mcmc/test-mh-poisson-statistics-and-convergence.cpp"
-    DEPENDENCIES
-        OpenGeode::basic
-        OpenGeode::geometry
-        ${PROJECT_NAME}::stochastic
-    UNSTABLE
+     SOURCE "sampling/mcmc/test-mh-poisson.cpp"
+     DEPENDENCIES
+         OpenGeode::basic
+         OpenGeode::geometry
+         ${PROJECT_NAME}::stochastic
 )
 
 add_geode_test(
-    SOURCE  "sampling/mcmc/test-mh-strauss-statistics-and-convergence.cpp"
+    SOURCE  "sampling/mcmc/test-mh-strauss.cpp"
     DEPENDENCIES
         OpenGeode::basic
         OpenGeode::geometry
diff --git a/tests/stochastic/sampling/mcmc/test-mh-poisson-statistics-and-convergence.cpp b/tests/stochastic/sampling/mcmc/test-mh-poisson-statistics-and-convergence.cpp
diff --git a/tests/stochastic/sampling/mcmc/test-mh-poisson.cpp b/tests/stochastic/sampling/mcmc/test-mh-poisson.cpp
diff --git a/tests/stochastic/sampling/mcmc/test-mh-strauss.cpp b/tests/stochastic/sampling/mcmc/test-mh-strauss.cpp

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ namespace geode`
`83`	`83`	`{`
`84`	`84`	`Proposal< Type > proposal =`
`85`	`85`	`proposal_kernel_->propose( state, engine );`
`86`		`-`
`87`	`86`	`if( proposal.type == Proposal< Type >::Move::Birth )`
`88`	`87`	`{`
`89`	`88`	`return birth_step( proposal, state, engine );`