ENH: Add MersenneTwisterRandomVariateGenerator::ResetNextSeed()

Allows generating a reproducible sequence of pseudo-random numbers.
N-Dekker · Oct 2, 2023 · 2119f76 · 2119f76
1 parent 75b9967
commit 2119f76
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/Modules/Core/Common/include/itkMersenneTwisterRandomVariateGenerator.h b/Modules/Core/Common/include/itkMersenneTwisterRandomVariateGenerator.h
@@ -160,6 +160,11 @@ class ITKCommon_EXPORT MersenneTwisterRandomVariateGenerator : public RandomVari
   static Pointer
   GetInstance();
 
+  /** Resets the internal data that is used to calculate the next seed. (Does not reset the initial seed.) Allows
+   * generating a reproducible sequence of pseudo-random numbers. */
+  static void
+  ResetNextSeed();
+
   /** Length of state vector */
   static constexpr IntegerType StateVectorLength = 624;
 

diff --git a/Modules/Core/Common/src/itkMersenneTwisterRandomVariateGenerator.cxx b/Modules/Core/Common/src/itkMersenneTwisterRandomVariateGenerator.cxx
@@ -81,6 +81,16 @@ MersenneTwisterRandomVariateGenerator::GetInstance()
   return m_PimplGlobals->m_StaticInstance;
 }
 
+
+void
+MersenneTwisterRandomVariateGenerator::ResetNextSeed()
+{
+  itkInitGlobalsMacro(PimplGlobals);
+  const std::lock_guard<std::recursive_mutex> lockGuard(m_PimplGlobals->m_StaticInstanceLock);
+  m_PimplGlobals->m_StaticDiffer = 0;
+}
+
+
 MersenneTwisterRandomVariateGenerator::MersenneTwisterRandomVariateGenerator()
 {
   SetSeed(121212);

diff --git a/Modules/Core/Common/test/itkMersenneTwisterRandomVariateGeneratorGTest.cxx b/Modules/Core/Common/test/itkMersenneTwisterRandomVariateGeneratorGTest.cxx
@@ -59,3 +59,18 @@ TEST(MersenneTwisterRandomVariateGenerator, GetIntegerVariateReturnsSameAsStdMt1
     EXPECT_EQ(generator->GetIntegerVariate(), stdMt19937());
   }
 }
+
+
+TEST(MersenneTwisterRandomVariateGenerator, ResetNextSeed)
+{
+  using GeneratorType = itk::Statistics::MersenneTwisterRandomVariateGenerator;
+
+  const auto globalGenerator = GeneratorType::GetInstance();
+  ASSERT_NE(globalGenerator, nullptr);
+
+  GeneratorType::ResetNextSeed();
+  const auto nextSeed = globalGenerator->GetNextSeed();
+
+  GeneratorType::ResetNextSeed();
+  EXPECT_EQ(globalGenerator->GetNextSeed(), nextSeed);
+}