X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f8abe8974ac5f49ab6282c4584899333dd9611a6..3f9b311ec56db95ec539001a860ae3c838c48312:/src/xbt/random.cpp

diff --git a/src/xbt/random.cpp b/src/xbt/random.cpp
index 449782a4f6..f63dd2f2d1 100644
--- a/src/xbt/random.cpp
+++ b/src/xbt/random.cpp
@@ -1,123 +1,158 @@
-/* Copyright (c) 2019. The SimGrid Team. All rights reserved.               */
+/* Copyright (c) 2019-2023. The SimGrid Team. All rights reserved.               */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "xbt/random.hpp"
 #include "xbt/asserts.h"
+#include <fstream>
+#include <iostream>
 #include <limits>
-#include <random>
+#include <memory>
+#include <string>
+#include <xbt/log.hpp>
+#include <xbt/random.hpp>
 
-namespace simgrid {
-namespace xbt {
-namespace random {
-std::mt19937 mt19937_gen;
-xbt_random_method current_rng = XBT_RNG_xbt;
+XBT_LOG_EXTERNAL_CATEGORY(xbt);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_random, xbt, "Random");
 
-void use_xbt()
+namespace simgrid::xbt::random {
+
+bool Random::read_state(const std::string& filename)
 {
-  current_rng = XBT_RNG_xbt;
+  std::ifstream file(filename);
+  file >> mt19937_gen;
+  file.close();
+  if (file.fail())
+    XBT_WARN("Could not save the RNG state to file %s.", filename.c_str());
+  return not file.fail();
 }
-void use_std()
+
+bool Random::write_state(const std::string& filename) const
 {
-  current_rng = XBT_RNG_std;
+  std::ofstream file(filename);
+  file << mt19937_gen;
+  file.close();
+  if (file.fail())
+    XBT_WARN("Could not read the RNG state from file %s.", filename.c_str());
+  return not file.fail();
 }
 
-int uniform_int(int min, int max)
+int StdRandom::uniform_int(int min, int max)
 {
-  switch (current_rng) {
-    case XBT_RNG_xbt:
-      return xbt_uniform_int(min, max);
-    case XBT_RNG_std: {
-      std::uniform_int_distribution<> dist(min, max);
-      return dist(mt19937_gen);
-    }
-    default:
-      xbt_assert(false, "The uniform integer distribution is not yet supported for the current RNG.");
-  }
+  std::uniform_int_distribution dist(min, max);
+  return dist(mt19937_gen);
 }
 
-int xbt_uniform_int(int min, int max)
+double StdRandom::uniform_real(double min, double max)
 {
-  unsigned long range  = max - min + 1;
-  xbt_assert(range > 0, "Overflow in the uniform integer distribution, please use a smaller range.");
-  xbt_assert(
-      min <= max,
-      "The maximum value for the uniform integer distribution must be greater than or equal to the minimum value");
-  return min + (int)(range * xbt_uniform_real(0, 1));
+  std::uniform_real_distribution dist(min, max);
+  return dist(mt19937_gen);
 }
 
-double uniform_real(double min, double max)
+double StdRandom::exponential(double lambda)
 {
-  switch (current_rng) {
-    case XBT_RNG_xbt:
-      return xbt_uniform_real(min, max);
-    case XBT_RNG_std: {
-      std::uniform_real_distribution<> dist(min, max);
-      return dist(mt19937_gen);
-    }
-    default:
-      xbt_assert(false, "The uniform real distribution is not yet supported for the current RNG.");
-  }
+  std::exponential_distribution dist(lambda);
+  return dist(mt19937_gen);
 }
 
-double xbt_uniform_real(double min, double max)
+double StdRandom::normal(double mean, double sd)
 {
-  // This reuses Boost's uniform real distribution ideas
-  unsigned long numerator = mt19937_gen() - mt19937_gen.min();
-  unsigned long divisor   = mt19937_gen.max() - mt19937_gen.min();
-  return min + (max - min) * numerator / divisor;
+  std::normal_distribution dist(mean, sd);
+  return dist(mt19937_gen);
 }
 
-double exponential(double lambda)
+int XbtRandom::uniform_int(int min, int max)
 {
-  switch (current_rng) {
-    case XBT_RNG_xbt:
-      return xbt_exponential(lambda);
-    case XBT_RNG_std: {
-      std::exponential_distribution<> dist(lambda);
-      return dist(mt19937_gen);
-    }
-    default:
-      xbt_assert(false, "The exponential distribution is not yet supported for the current RNG.");
-  }
+  // The casts to unsigned are here to ensure that the value of range is correctly calculated, even when greater than
+  // INT_MAX.  See the corresponding unit tests for examples.
+  unsigned long range = static_cast<unsigned>(max) - static_cast<unsigned>(min);
+  xbt_assert(min <= max,
+             "The minimum value for the uniform integer distribution must not be greater than the maximum value");
+  xbt_assert(range <= decltype(mt19937_gen)::max(),
+             "Overflow in the uniform integer distribution, please use a smaller range.");
+  if (range == decltype(mt19937_gen)::max())
+    return static_cast<int>(mt19937_gen() + min);
+
+  ++range;
+  unsigned long limit = decltype(mt19937_gen)::max() - decltype(mt19937_gen)::max() % range;
+  unsigned long value;
+  do {
+    value = mt19937_gen();
+  } while (value >= limit);
+  return static_cast<int>(value % range + min);
 }
 
-double xbt_exponential(double lambda)
+double XbtRandom::uniform_real(double min, double max)
 {
-  return -1 / lambda * log(uniform_real(0, 1));
+  // This reuses Boost's uniform real distribution ideas
+  constexpr unsigned long divisor = decltype(mt19937_gen)::max() - decltype(mt19937_gen)::min();
+  unsigned long numerator;
+  do {
+    numerator = mt19937_gen() - decltype(mt19937_gen)::min();
+  } while (numerator == divisor);
+  return min + (max - min) * static_cast<double>(numerator) / divisor;
 }
 
-double normal(double mean, double sd)
+double XbtRandom::exponential(double lambda)
+{
+  return -1.0 / lambda * log(uniform_real(0.0, 1.0));
+}
+
+double XbtRandom::normal(double mean, double sd)
 {
-  switch (current_rng) {
-    case XBT_RNG_xbt:
-      return xbt_normal(mean, sd);
-    case XBT_RNG_std: {
-      std::normal_distribution<> dist(mean, sd);
-      return dist(mt19937_gen);
-    }
-    default:
-      xbt_assert(false, "The normal distribution is not yet supported for the curent RNG.");
-  }
-}
-
-double xbt_normal(double mean, double sd)
-{
-  double u1 = 0;
-  while (u1 < std::numeric_limits<double>::min()) {
-    u1 = uniform_real(0, 1);
-  }
-  double u2 = uniform_real(0, 1);
-  double z0 = sqrt(-2.0 * log(u1)) * cos(2 * M_PI * u2);
+  double u1;
+  do {
+    u1 = uniform_real(0.0, 1.0);
+  } while (u1 < std::numeric_limits<double>::min());
+  double u2 = uniform_real(0.0, 1.0);
+  double z0 = sqrt(-2.0 * log(u1)) * cos(2.0 * M_PI * u2);
   return z0 * sd + mean;
 }
 
+static std::unique_ptr<Random> default_random = std::make_unique<XbtRandom>();
+
+void set_implem_xbt()
+{
+  default_random = std::make_unique<XbtRandom>();
+}
+void set_implem_std()
+{
+  default_random = std::make_unique<StdRandom>();
+}
+
 void set_mersenne_seed(int seed)
 {
-  mt19937_gen.seed(seed);
+  default_random->set_seed(seed);
+}
+
+bool read_mersenne_state(const std::string& filename)
+{
+  return default_random->read_state(filename);
+}
+
+bool write_mersenne_state(const std::string& filename)
+{
+  return default_random->write_state(filename);
+}
+
+int uniform_int(int min, int max)
+{
+  return default_random->uniform_int(min, max);
+}
+
+double uniform_real(double min, double max)
+{
+  return default_random->uniform_real(min, max);
+}
+
+double exponential(double lambda)
+{
+  return default_random->exponential(lambda);
+}
+
+double normal(double mean, double sd)
+{
+  return default_random->normal(mean, sd);
 }
 
-} // namespace random
-} // namespace xbt
-} // namespace simgrid
+} // namespace simgrid::xbt::random