Merge pull request #53 from schmouk/well-impl

Merge branch Well-impl w. branch dev

Author: schmouk

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com.
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com.
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal

PyRandLib/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal

PyRandLib/README.md

@@ -9,7 +9,7 @@ If you decide to use this library,  please add the copyright notice to  your
 software as stated in the LICENSE file.
 
 ```
-Copyright (c) 2016-2022 Philippe Schmouker, <ph.schmouker (at) gmail.com>
+Copyright (c) 2016-2025 Philippe Schmouker, <ph.schmouker (at) gmail.com>
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal

PyRandLib/__init__.py

@@ -3,13 +3,14 @@
 It is provided under MIT License.
 Please see files README.md and LICENSE.
 
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 """
 
 from .baselcg        import BaseLCG
 from .baselfib64     import BaseLFib64
 from .basemrg        import BaseMRG
 from .baserandom     import BaseRandom
+from .basewell       import BaseWELL
 from .fastrand32     import FastRand32
 from .fastrand63     import FastRand63
 from .lfib78         import LFib78
@@ -19,3 +20,7 @@
 from .mrgrand287     import MRGRand287
 from .mrgrand1457    import MRGRand1457
 from .mrgrand49507   import MRGRand49507
+from .well512a       import Well512a
+from .well1024a      import Well1024a
+from .well19937c     import Well19937c
+from .well44497b     import Well44497b

PyRandLib/types.py PyRandLib/annotation_types.pyPyRandLib/types.py renamed to PyRandLib/annotation_types.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
-Copyright (c) 2021-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2021-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -26,8 +24,10 @@
 from typing import List, Tuple, Union
 
 Numerical     = Union[ int, float ]
-StateType     = Union[ Tuple[Numerical], List[Numerical], Tuple[List[Numerical], int] ]
+StateType     = Union[ Tuple[Numerical], List[Numerical], Tuple[List[Numerical], int], Tuple[Tuple[Numerical], int] ]
 SeedStateType = Union[ Numerical, StateType ]
 
 
-#=====   end of   PyRandLib.types   =====#
+#=====   end of   PyRandLib.annotation_types   ===============================
+
+# type: ignore  (this comment line is just to avoid boring pylance related error checking)

PyRandLib/baselcg.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -32,7 +30,7 @@ class BaseLCG( BaseRandom ):
     
     This module is part of library PyRandLib.
 
-    Copyright (c) 2016-2021 Philippe Schmouker
+    Copyright (c) 2016-2025 Philippe Schmouker
 
     LCG models evaluate pseudo-random numbers suites x(i) as a simple mathem-
     atical function of 
@@ -55,9 +53,9 @@ class BaseLCG( BaseRandom ):
 
     Furthermore this class is callable:
       rand = BaseLCG()
-      print( rand() )    # prints a uniform pseudo-random value within [0.0, 1.0)
-      print( rand(a) )   # prints a uniform pseudo-random value within [0.0, a)
-      print( rand(a,b) ) # prints a uniform pseudo-random value within [a  , b)
+      print( rand() )    # prints a pseudo-random value within [0.0, 1.0)
+      print( rand(a) )   # prints a pseudo-random value within [0.0, a)
+      print( rand(a,b) ) # prints a pseudo-random value within [a  , b)
 
     Reminder:
     We give you here below a copy of the table of tests for the LCGs that have 

PyRandLib/baselfib64.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -23,9 +23,9 @@
 """
 
 #=============================================================================
-from .baserandom import BaseRandom
-from .fastrand32 import FastRand32
-from .types      import SeedStateType, StateType
+from .baserandom       import BaseRandom
+from .fastrand32       import FastRand32
+from .annotation_types import SeedStateType, StateType
 
 
 #=============================================================================
@@ -36,7 +36,7 @@ class BaseLFib64( BaseRandom ):
     on 64-bits generated numbers.
     This module is part of library PyRandLib.
     
-    Copyright (c) 2016-2021 Philippe Schmouker
+    Copyright (c) 2016-2025 Philippe Schmouker
 
     Lagged Fibonacci generators LFib( m, r, k, op) use the recurrence
     
@@ -66,9 +66,9 @@ class BaseLFib64( BaseRandom ):
     Example:
     
       rand = BaseLFib()
-      print( rand() )    # prints a uniform pseudo-random value within [0.0, 1.0)
-      print( rand(a) )   # prints a uniform pseudo-random value within [0.0, a)
-      print( rand(a,b) ) # prints a uniform pseudo-random value within [a  , b)
+      print( rand() )    # prints a pseudo-random value within [0.0, 1.0)
+      print( rand(a) )   # prints a pseudo-random value within [0.0, a)
+      print( rand(a,b) ) # prints a pseudo-random value within [a  , b)
     
     Inheriting classes have to define class attribute '_LIST_SIZE'.  See LFib78 for an
     example.
@@ -109,7 +109,7 @@ def __init__(self, _seedState: SeedStateType = None) -> None:
         """
         super().__init__( _seedState )
             # this  call  creates  the  two  attributes
-            # self._list and self._index, and sets them
+            # self._state and self._index, and sets them
             # since it internally calls self.setstate().
 
 
@@ -132,7 +132,7 @@ def getstate(self) -> StateType:
         tuple containing a list of self._LIST_SIZE integers and an 
         index in this list (index value being then in range(0,self._LIST_SIZE).
         """
-        return (self._list[:], self._index)
+        return (self._state[:], self._index)
 
 
     #------------------------------------------------------------------------=
@@ -156,19 +156,19 @@ def setstate(self, _seedState: StateType) -> None:
 
             if count == 0:
                 self._initIndex( 0 )
-                self._initList()
+                self._initState()
 
             elif count == 1:
                 self._initIndex( 0 )
-                self._initList( _seedState[0] )
+                self._initState( _seedState[0] )
 
             else:
                 self._initIndex( _seedState[1] )
-                self._list = _seedState[0][:]
+                self._state = _seedState[0][:]
 
         except:
             self._initIndex( 0 )
-            self._initList( _seedState )
+            self._initState( _seedState )
 
 
     #------------------------------------------------------------------------=
@@ -182,7 +182,7 @@ def _initIndex(self, _index: int) -> None:
 
 
     #------------------------------------------------------------------------=
-    def _initList(self, _initialSeed: StateType = None) -> None:
+    def _initState(self, _initialSeed: StateType = None) -> None:
         """Inits the internal list of values.
         
         Inits the internal list of values according to some initial
@@ -191,7 +191,7 @@ def _initList(self, _initialSeed: StateType = None) -> None:
         current local time value is used as initial seed value.
         """
         myRand = FastRand32( _initialSeed )
-        self._list = [ (int(myRand(0x1_0000_0000)) << 32) + int(myRand(0x1_0000_0000)) for _ in range(self._LIST_SIZE) ]        
+        self._state = [ (int(myRand(0x1_0000_0000)) << 32) + int(myRand(0x1_0000_0000)) for _ in range(self._LIST_SIZE) ]        
 
 #=====   end of module   baselfib64.py   =====================================
 

PyRandLib/basemrg.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -23,9 +21,9 @@
 """
 
 #=============================================================================
-from .baserandom import BaseRandom
-from .fastrand32 import FastRand32
-from .types      import SeedStateType, StateType
+from .baserandom       import BaseRandom
+from .fastrand32       import FastRand32
+from .annotation_types import SeedStateType, StateType
 
 
 #=============================================================================
@@ -34,7 +32,7 @@ class BaseMRG( BaseRandom ):
     
     This module is part of library PyRandLib.
     
-    Copyright (c) 2016-2021 Philippe Schmouker
+    Copyright (c) 2016-2025 Philippe Schmouker
 
     Multiple Recursive Generators (MRGs) uses  recurrence  to  evaluate  pseudo-random
     numbers suites. Recurrence is of the form:
@@ -63,15 +61,15 @@ class BaseMRG( BaseRandom ):
     Example:
     
       rand = BaseMRG()
-      print( rand() )    # prints a uniform pseudo-random value within [0.0, 1.0)
-      print( rand(a) )   # prints a uniform pseudo-random value within [0.0, a)
-      print( rand(a,b) ) # prints a uniform pseudo-random value within [a  , b)
+      print( rand() )    # prints a pseudo-random value within [0.0, 1.0)
+      print( rand(a) )   # prints a pseudo-random value within [0.0, a)
+      print( rand(a,b) ) # prints a pseudo-random value within [a  , b)
     
     Inheriting classes have to define class attributes '_LIST_SIZE' and '_MODULO'. See 
     MRGRand287 for an example.
 
     Reminder:
-    We give you here below a copy of the table of tests for the LCGs that have 
+    We give you here below a copy of the table of tests for the MRGs that have 
     been implemented in PyRandLib, as provided in paper "TestU01, ..."  -  see
     file README.md.
 
@@ -105,7 +103,7 @@ def __init__(self, _seedState: SeedStateType = None) -> None:
         """
         super().__init__( _seedState )
             # this  call  creates  the  two  attributes
-            # self._list and self._index, and sets them
+            # self._state and self._index, and sets them
             # since it internally calls self.setstate().
 
 
@@ -128,7 +126,7 @@ def getstate(self) -> StateType:
         tuple containing a list of self._LIST_SIZE integers and an 
         index in this list (index value being then in range(0,self._LIST_SIZE).
         """
-        return (self._list[:], self._index)
+        return (self._state[:], self._index)
 
 
     #------------------------------------------------------------------------=
@@ -152,19 +150,19 @@ def setstate(self, _seedState: StateType) -> None:
 
             if count == 0:
                 self._initIndex( 0 )
-                self._initList()
+                self._initState()
 
             elif count == 1:
                 self._initIndex( 0 )
-                self._initList( _seedState[0] )
+                self._initState( _seedState[0] )
 
             else:
                 self._initIndex( _seedState[1] )
-                self._list = _seedState[0][:]
+                self._state = _seedState[0][:]
 
         except:
             self._initIndex( 0 )
-            self._initList( _seedState )
+            self._initState( _seedState )
 
 
     #------------------------------------------------------------------------=
@@ -178,7 +176,7 @@ def _initIndex(self, _index: int) -> None:
 
 
     #------------------------------------------------------------------------=
-    def _initList(self, _initialSeed: StateType = None) -> None:
+    def _initState(self, _initialSeed: StateType = None) -> None:
         """Inits the internal list of values.
         
         Inits the internal list of values according to some initial
@@ -188,7 +186,7 @@ def _initList(self, _initialSeed: StateType = None) -> None:
         """
         # feeds the list according to an initial seed and the value+1 of the modulo.
         myRand = FastRand32( _initialSeed )
-        self._list = [ int(myRand(self._MODULO+1)) for _ in range(self._LIST_SIZE) ]
+        self._state = [ int(myRand(self._MODULO+1)) for _ in range(self._LIST_SIZE) ]
 
 
 #=====   end of module   basemrg.py   ========================================

PyRandLib/baserandom.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """
-Copyright (c) 2016-2022 Philippe Schmouker, schmouk (at) gmail.com
+Copyright (c) 2016-2025 Philippe Schmouker, schmouk (at) gmail.com
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -26,7 +24,7 @@
 from random import Random
 from typing import Any, List, Tuple, Union
 
-from .types import Numerical, SeedStateType, StateType
+from .annotation_types import Numerical, SeedStateType, StateType
 
 
 #=============================================================================
@@ -35,7 +33,7 @@ class BaseRandom( Random ):
     
     This module is part of library PyRandLib.
     
-    Copyright (c) 2016-2021 Philippe Schmouker
+    Copyright (c) 2016-2025 Philippe Schmouker
 
     See FastRand32 for a 2^32 (i.e. 4.3e+9) period LC-Generator and  FastRand63  for a  
     2^63 (i.e. about 9.2e+18) period LC-Generator with low computation time.
@@ -264,13 +262,13 @@ def __call__(self, _max : Union[Numerical,
             times =  1
 
         if isinstance( _max, int ):
-            ret = [ self.randint(0, _max) for _ in range(times) ]
+            ret = [ int(_max * self.random()) for _ in range(times) ]
         elif isinstance( _max, float ):
-            ret = [ self.uniform( 0.0, _max ) for _ in range(times) ]
+            ret = [ _max * self.random() for _ in range(times) ]
         else:
             try:
                 if times == 1:
-                    ret = [ self(m,1) for m in _max] 
+                    ret = [ self(m,1) for m in _max ] 
                 else:
                     ret = [ [self(m,1) for m in _max] for _ in range(times) ]
             except: