#14 - Release 1.1.0

Finally modified copyright dates (2021); added Unix and Utf-8 goodies at top of modules; conforms now to new documentation rules; uses now library `typing` for types annotations in methods signatures.

Author: schmouk

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2020 Philippe Schmouker, schmouk (at) typee.ovh.
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh.
 
 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-2020 Philippe Schmouker, schmouk (at) typee.ovh
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh
 
 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-2020 Philippe Schmouker, schmouk (at) typee.ovh
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -106,7 +106,8 @@ implemented in PyRabdLib, as provided in [1].
 
 
 ## Implementation
-Current implementation of PyRandLib uses Python 3.x with no Cython version.
+Current implementation of PyRandLib uses Python 3.x with no Cython version.  
+It has been tested with Python 3.8 but should run with most of Python 3 suvbversions.
 
 Python 2.7 could be later available,  if asked for.  Cython  implementations
 could also be later available.
@@ -337,7 +338,7 @@ Please notice that the TestUO1 article states that the operator  should  be
 
 
 
-### LFibRand1340
+### LFibRand1340  -  2^1340 periodicity
 
 **LFibRand1340** implements an LFib 64-bits generator  proposed  by  George
 Marsaglia in [4]. This PRG uses the recurrence

PyRandLib/__init__.py

@@ -3,7 +3,7 @@
 It is provided under MIT License.
 Please see files README.md and LICENSE.
 
-Copyright (c) 2016-2020 Philippe Schmouker
+Copyright (c) 2016-2021 Philippe Schmouker
 """
 
 from .baselcg        import BaseLCG

PyRandLib/baselcg.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
 """
-Copyright (c) 2016-2020 Philippe Schmouker, schmouk (at) typee.ovh
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh
 
 Permission is hereby granted,  free of charge,  to any person obtaining a copy
 of this software and associated documentation files (the "Software"),  to deal
@@ -29,11 +28,11 @@
 
 #=============================================================================
 class BaseLCG( BaseRandom ):
-    """
-    Definition of the base class for all LCG pseudo-random generators.
+    """Definition of the base class for all LCG pseudo-random generators.
+    
     This module is part of library PyRandLib.
 
-    Copyright (c) 2016-2020 Philippe Schmouker
+    Copyright (c) 2016-2021 Philippe Schmouker
 
     LCG models evaluate pseudo-random numbers suites x(i) as a simple mathem-
     atical function of 
@@ -78,30 +77,31 @@ class BaseLCG( BaseRandom ):
     should definitively pass.
     """
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def __init__(self, _seedState: int = None) -> None:
-        """
-        Constructor.  Should inSeed be None or not an integer  then
-        the local time is used (with its shuffled value) as a seed.
+        """Constructor. 
+        
+        Should inSeed be None or not an integer then the local 
+        time is used (with its shuffled value) as a seed.
         """
         super().__init__( _seedState ) # this call creates attribute self._value and sets it
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def random(self) -> float:
-        """
-        This is the core of the pseudo-random generator.
+        """This is the core of the pseudo-random generator.
+        
         Returned values are within [0.0, 1.0).
         Inheriting classes HAVE TO IMPLEMENT this method  -  see FastRand32
         for an example. It should use and initialize attribute self._value.
         """
-        raise NotImplementedError
+        raise NotImplementedError()
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def getstate(self) -> int:
-        """
-        Returns an object capturing the current internal state of the generator.
+        """Returns an object capturing the current internal state of the generator.
+        
         This object can be passed to setstate() to restore the state.
         For LCG,  the state is defined with  a  single  integer,  'self._value',
         which  has  to  be  used  in  methods 'random() and 'setstate() of every
@@ -110,16 +110,17 @@ def getstate(self) -> int:
         return self._value
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def setstate(self, _state: int) -> None:
-        """
+        """Restores the internal state of the generator.
+        
         _state should have been obtained from a previous call to getstate(),
         and  setstate() restores the internal state of the generator to what
         it was at the time setstate() was called.
         Inheriting classes HAVE TO IMPLEMENT this method  -  see  FastRand32
         for an example. It should initialize attribute self._value.
         """
-        raise NotImplementedError
+        raise NotImplementedError()
 
 
 #=====   end of module   baselcg.py   ========================================

PyRandLib/baselfib64.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
 """
-Copyright (c) 2016-2020 Philippe Schmouker, schmouk (at) typee.ovh
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh
 
 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,16 +25,18 @@
 #=============================================================================
 from .baserandom import BaseRandom
 from .fastrand63 import FastRand63
+from .types      import SeedStateType, StateType
 
 
 #=============================================================================
 class BaseLFib64( BaseRandom ):
-    """
+    """The base class for all LFib PRG based on 64-bits numbers.
+    
     Definition of the base class for all LFib pseudo-random generators based
     on 64-bits generated numbers.
     This module is part of library PyRandLib.
     
-    Copyright (c) 2016-2020 Philippe Schmouker
+    Copyright (c) 2016-2021 Philippe Schmouker
 
     Lagged Fibonacci generators LFib( m, r, k, op) use the recurrence
     
@@ -92,10 +93,10 @@ class BaseLFib64( BaseRandom ):
     should definitively pass.
     """
 
-    #=========================================================================
-    def __init__(self, _seedState: tuple = None) -> None:
-        """
-        Constructor.
+    #------------------------------------------------------------------------=
+    def __init__(self, _seedState: SeedStateType = None) -> None:
+        """Constructor.
+        
         _seedState is either a valid state, an integer,  a float or None.
         About  valid  state:  this  is  a  tuple  containing  a  list  of  
         self._LIST_SIZE integers and  an index in this list (index  value 
@@ -112,31 +113,32 @@ def __init__(self, _seedState: tuple = None) -> None:
             # since it internally calls self.setstate().
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def random(self) -> float:
-        """
-        This is the core of the pseudo-random generator.
+        """This is the core of the pseudo-random generator.
+        
         Returned values are within [0.0, 1.0).
         Inheriting classes HAVE TO IMPLEMENT this method - see LFib78
         for an example.
         """
-        raise NotImplementedError
+        raise NotImplementedError()
 
 
-    #=========================================================================
-    def getstate(self) -> tuple:
-        """
-        Return an object capturing the current internal state of the  generator.
+    #------------------------------------------------------------------------=
+    def getstate(self) -> StateType:
+        """Returns an object capturing the current internal state of the  generator.
+        
         This  object  can be passed to setstate() to restore the state.  It is a
         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)
 
 
-    #=========================================================================
-    def setstate(self, _seedState: tuple) -> None:
-        """
+    #------------------------------------------------------------------------=
+    def setstate(self, _seedState: StateType) -> None:
+        """Restores the internal state of the generator.
+        
         _seedState should have been obtained from a previous call  to 
         getstate(), and setstate() restores the internal state of the 
         generator to what it was at the time setstate() was called.
@@ -162,20 +164,20 @@ def setstate(self, _seedState: tuple) -> None:
             self._list = _seedState[0][:]
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def _initIndex(self, _index: int) -> None:
-        """
-        Inits the internal index pointing to the internal list.
+        """Inits the internal index pointing to the internal list.
         """
         try:
             self._index = int( _index ) % self._LIST_SIZE
         except:
             self._index = 0
 
 
-    #=========================================================================
-    def _initList(self, _initialSeed: list = None) -> None:
-        """
+    #------------------------------------------------------------------------=
+    def _initList(self, _initialSeed: StateType = None) -> None:
+        """Inits the internal list of values.
+        
         Inits the internal list of values according to some initial
         seed  that  has  to be an integer or a float ranging within
         [0.0, 1.0).  Should it be None or anything  else  then  the

PyRandLib/basemrg.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
 """
-Copyright (c) 2016-2020 Philippe Schmouker, schmouk (at) typee.ovh
+Copyright (c) 2016-2021 Philippe Schmouker, schmouk (at) typee.ovh
 
 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,15 +25,16 @@
 #=============================================================================
 from .baserandom import BaseRandom
 from .fastrand32 import FastRand32
+from .types      import SeedStateType, StateType
 
 
 #=============================================================================
 class BaseMRG( BaseRandom ):
-    """
-    Definition of the base class for all MRG pseudo-random generators.
+    """Definition of the base class for all MRG pseudo-random generators.
+    
     This module is part of library PyRandLib.
     
-    Copyright (c) 2016-2020 Philippe Schmouker
+    Copyright (c) 2016-2021 Philippe Schmouker
 
     Multiple Recursive Generators (MRGs) uses  recurrence  to  evaluate  pseudo-random
     numbers suites. Recurrence is of the form:
@@ -89,10 +89,10 @@ class BaseMRG( BaseRandom ):
     should definitively pass.
     """
 
-    #=========================================================================
-    def __init__(self, _seedState: (int,float,list) = None) -> None:
-        """
-        Constructor.
+    #------------------------------------------------------------------------=
+    def __init__(self, _seedState: SeedStateType = None) -> None:
+        """Constructor.
+        
         _seedState is either a valid state, an integer, a float or None.
         About  valid  state:  this  is  a  tuple  containing  a  list  of  
         self._LIST_SIZE integers and  an index in this list (index  value 
@@ -109,31 +109,32 @@ def __init__(self, _seedState: (int,float,list) = None) -> None:
             # since it internally calls self.setstate().
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def random(self) -> float:
-        """
-        This is the core of the pseudo-random generator.
+        """This is the core of the pseudo-random generator.
+        
         Returned values are within [0.0, 1.0).
         Inheriting classes HAVE TO IMPLEMENT this method - see MRGRand287
         for an example.
         """
-        raise NotImplementedError
+        raise NotImplementedError()
 
 
-    #=========================================================================
-    def getstate(self) -> tuple:
-        """
-        Return an object capturing the current internal state of the  generator.
+    #------------------------------------------------------------------------=
+    def getstate(self) -> StateType:
+        """Returns an object capturing the current internal state of the  generator.
+        
         This  object  can be passed to setstate() to restore the state.  It is a
         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)
 
 
-    #=========================================================================
-    def setstate(self, _seedState: tuple) -> None:
-        """
+    #------------------------------------------------------------------------=
+    def setstate(self, _seedState: StateType) -> None:
+        """Restores the internal state of the generator.
+
         _seedState should have been obtained from a previous call  to 
         getstate(), and setstate() restores the internal state of the 
         generator to what it was at the time setstate() was called.
@@ -159,20 +160,20 @@ def setstate(self, _seedState: tuple) -> None:
             self._list = _seedState[0][:]
 
 
-    #=========================================================================
+    #------------------------------------------------------------------------=
     def _initIndex(self, _index: int) -> None:
-        """
-        Inits the internal index pointing to the internal list.
+        """Inits the internal index pointing to the internal list.
         """
         try:
             self._index = int( _index ) % self._LIST_SIZE
         except:
             self._index = 0
 
 
-    #=========================================================================
-    def _initList(self, _initialSeed: list = None) -> None:
-        """
+    #------------------------------------------------------------------------=
+    def _initList(self, _initialSeed: StateType = None) -> None:
+        """Inits the internal list of values.
+        
         Inits the internal list of values according to some initial
         seed  that  has  to be an integer or a float ranging within
         [0.0, 1.0).  Should it be None or anything  else  then  the