Remove deprecated MLCG (#3189)

neuronsimulator · Nov 9, 2024 · a5d0015 · a5d0015
1 parent 7f6d710
commit a5d0015
Show file tree

Hide file tree

Showing 9 changed files with 2 additions and 262 deletions.
diff --git a/docs/hoc/programming/math/random.rst b/docs/hoc/programming/math/random.rst
@@ -96,27 +96,6 @@ Random Class
 
 
 
-.. hoc:method:: Random.MLCG
-
-
-    Syntax:
-        ``r.MLCG()``
-
-        ``r.MLCG(seed1)``
-
-        ``r.MLCG(seed1, seed2)``
-
-
-    Description:
-        Use a Multiplicative Linear Congruential Generator.  Not as high 
-        quality as the ACG.  It uses only 8 bytes. 
-
-
-
-----
-
-
-
 .. hoc:method:: Random.MCellRan4
 
 

diff --git a/docs/python/programming/math/random.rst b/docs/python/programming/math/random.rst
@@ -99,27 +99,6 @@ Random Class
 
 
 
-.. method:: Random.MLCG
-
-
-    Syntax:
-        ``r.MLCG()``
-
-        ``r.MLCG(seed1)``
-
-        ``r.MLCG(seed1, seed2)``
-
-
-    Description:
-        Use a Multiplicative Linear Congruential Generator.  Not as high 
-        quality as the ACG.  It uses only 8 bytes. 
-
-
-
-----
-
-
-
 .. method:: Random.MCellRan4
 
 

diff --git a/share/lib/helpdict b/share/lib/helpdict
@@ -496,7 +496,6 @@ min Vector classes general neuron.exe Reference 160 neuron/general/classes/vecto
 min_ind Vector classes general neuron.exe Reference 160 neuron/general/classes/vector/vect2.html#min_ind
 Miscellaneous Tools NEURONMainMenu GUI Reference 418 neuron/stdrun/0stdrun.html#Miscellaneous
 mktemp File classes general neuron.exe Reference 29 neuron/general/classes/file.html#mktemp
-MLCG Random classes general neuron.exe Reference 97 neuron/general/classes/random.html#MLCG
 ModelDescriptionIssues CVode classes neuron neuron.exe Reference 257 neuron/neuron/classes/cvode.html#ModelDescriptionIssues
 ModelDescriptionLanguage NMODL Reference 388 neuron/nmodl/nmodl.html#ModelDescriptionLanguage
 MoveText Graph LookAndFeel GUI Reference 18 neuron/agui/gui.html#MoveText

diff --git a/src/gnu/CMakeLists.txt b/src/gnu/CMakeLists.txt
@@ -11,7 +11,6 @@ add_library(
   LogNorm.cpp
   MCellRan4RNG.cpp
   mcran4.cpp
-  MLCG.cpp
   NegExp.cpp
   Normal.cpp
   nrnisaac.cpp

diff --git a/src/gnu/MLCG.cpp b/src/gnu/MLCG.cpp
diff --git a/src/gnu/MLCG.h b/src/gnu/MLCG.h
diff --git a/src/gnu/RNG.h b/src/gnu/RNG.h
@@ -35,7 +35,7 @@ union PrivateRNGDoubleType {		   	// used to access doubles as unsigneds
 };
 
 //
-// Base class for Random Number Generators. See ACG and MLCG for instances.
+// Base class for Random Number Generators. See ACG for instances.
 //
 class RNG {
     static PrivateRNGSingleType singleMantissa;	// mantissa bit vector

diff --git a/src/gnu/Rand.hpp b/src/gnu/Rand.hpp
@@ -7,7 +7,7 @@ struct Object;
 
 /* type_:
  * 0: ACG
- * 1: MLCG
+ * 1: unused
  * 2: MCellRan4
  * 3: Isaac64
  * 4: Random123

diff --git a/src/ivoc/ivocrand.cpp b/src/ivoc/ivocrand.cpp
@@ -18,7 +18,6 @@
 #include <nrnran123.h>
 
 #include <ACG.h>
-#include <MLCG.h>
 #include <Random.h>
 #include <Poisson.h>
 #include <Normal.h>
@@ -133,29 +132,6 @@ static double r_ACG(void* r) {
     return 1.;
 }
 
-// Use a Multiplicative Linear Congruential Generator.  Not as high
-// quality as the ACG, but uses only 8 bytes
-// syntax:
-// r.MLCG([seed1],[seed2])
-
-static double r_MLCG(void* r) {
-    Rand* x = (Rand*) r;
-
-    unsigned long seed1 = 0;
-    unsigned long seed2 = 0;
-
-    if (ifarg(1))
-        seed1 = long(*getarg(1));
-    if (ifarg(2))
-        seed2 = long(*getarg(2));
-
-    x->rand->generator(new MLCG(seed1, seed2));
-    delete x->gen;
-    x->gen = x->rand->generator();
-    x->type_ = 1;
-    return 1.;
-}
-
 static double r_MCellRan4(void* r) {
     Rand* x = (Rand*) r;
 
@@ -489,7 +465,6 @@ extern "C" void nrn_random_play() {
 
 
 static Member_func r_members[] = {{"ACG", r_ACG},
-                                  {"MLCG", r_MLCG},
                                   {"Isaac64", r_Isaac64},
                                   {"MCellRan4", r_MCellRan4},
                                   {"Random123", r_nrnran123},