schmouk / pyrandlib Goto Github PK

Prepare new release with new copyright dates (2019).

• Modify copyright dates to 2021;
• add Unix and UTF-8 goodies at top of all files;
• conform to new documentation rules;
• add usage of typing for types annotations.

It appears that very first initialization of LFibs and MRGs is not fully correct. Let's fix this according to the content of this chapter : L’Ecuyer, P., Panneton, F. (2009). F2-Linear Random Number Generators. In: Alexopoulos, C., Goldsman, D., Wilson, J. (eds) Advancing the Frontiers of Simulation. International Series in Operations Research & Management Science, vol 133. Springer, Boston, MA. https://doi.org/10.1007/b110059_9

• Optimize code (according to issue #15 );
• Augment operator '()' (according to issue #16 );
• Modify accordingly README.md.

Let's write the whole readme documentation.

Let's implement two LCGs, 32-bits and 64-bits. Documentation is mandatory.

Let's optimize code when possible (using comprehensions and the like, enhancing comments, normalizing docstrings, etc.)

Once issues #21 and #22 will have been resolved, let's create a new release with new numbering : major = 2, minor = two last digits of year, patch starting at 0 : 2.23.0

The selected PRNG should help creating indépendant multi streams, which will be of great help for parallelized simulations.

Let's implement four LFibs. Documentation is mandatory.

Let's implement three MRGs. Documentation is mandatory.

On calls applied to a PRG variable with arguments, let's take benefit of the types of the arguments to return a value of same type.
Furthermore, let's return generators or lists under some circumstances, i.e. when many arguments are provided or when a named argument 'times' (integer) is specifically added at end of args list.

Let's implement the base class for every other PRGs.