Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rely on template argument deduction (sonar, c++17).
[simgrid.git] / src / xbt / random.cpp
index 8439dea..af2cfd4 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2019-2020. The SimGrid Team. All rights reserved.               */
+/* Copyright (c) 2019-2022. 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. */
@@ -29,7 +29,7 @@ bool Random::read_state(const std::string& filename)
   return not file.fail();
 }
 
-bool Random::write_state(const std::string& filename)
+bool Random::write_state(const std::string& filename) const
 {
   std::ofstream file(filename);
   file << mt19937_gen;
@@ -41,39 +41,47 @@ bool Random::write_state(const std::string& filename)
 
 int StdRandom::uniform_int(int min, int max)
 {
-  std::uniform_int_distribution<> dist(min, max);
+  std::uniform_int_distribution dist(min, max);
   return dist(mt19937_gen);
 }
 
 double StdRandom::uniform_real(double min, double max)
 {
-  std::uniform_real_distribution<> dist(min, max);
+  std::uniform_real_distribution dist(min, max);
   return dist(mt19937_gen);
 }
 
 double StdRandom::exponential(double lambda)
 {
-  std::exponential_distribution<> dist(lambda);
+  std::exponential_distribution dist(lambda);
   return dist(mt19937_gen);
 }
 
 double StdRandom::normal(double mean, double sd)
 {
-  std::normal_distribution<> dist(mean, sd);
+  std::normal_distribution dist(mean, sd);
   return dist(mt19937_gen);
 }
 
 int XbtRandom::uniform_int(int min, int max)
 {
-  unsigned long range  = max - min + 1;
+  // 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 > 0, "Overflow in the uniform integer distribution, please use a smaller range.");
+  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 >= decltype(mt19937_gen)::max() - decltype(mt19937_gen)::max() % range);
-  return value % range + min;
+  } while (value >= limit);
+  return static_cast<int>(value % range + min);
 }
 
 double XbtRandom::uniform_real(double min, double max)
@@ -84,7 +92,7 @@ double XbtRandom::uniform_real(double min, double max)
   do {
     numerator = mt19937_gen() - decltype(mt19937_gen)::min();
   } while (numerator == divisor);
-  return min + (max - min) * numerator / divisor;
+  return min + (max - min) * static_cast<double>(numerator) / divisor;
 }
 
 double XbtRandom::exponential(double lambda)
@@ -103,15 +111,15 @@ double XbtRandom::normal(double mean, double sd)
   return z0 * sd + mean;
 }
 
-static std::unique_ptr<Random> default_random(new XbtRandom);
+static std::unique_ptr<Random> default_random = std::make_unique<XbtRandom>();
 
 void set_implem_xbt()
 {
-  default_random.reset(new XbtRandom);
+  default_random = std::make_unique<XbtRandom>();
 }
 void set_implem_std()
 {
-  default_random.reset(new StdRandom);
+  default_random = std::make_unique<StdRandom>();
 }
 
 void set_mersenne_seed(int seed)