written a README

This commit is contained in:
didier amyot committed 2016-12-31 11:04:32 -05:00
1 parent 041c4b57bf
commit 0320806043
3 files changed
+74 -36

No files matched your search

+42
View File
@@ -0,0 +1,42 @@
======
random
======
A pure clojure random library.
-----------
description
-----------
This project is a pure clojure random number library that has goals.
#. Written in pure clojure
#. Functional; a seed should be the input of every functions
#. Use a very good pseudo random number generator algorithm
#. Thread Safe
---------
Algorithm
---------
The algorithms are translation of Go's "`math/rand`_" package. It totally
makes sense to use Go's random number generator has it has been implemented
by `Ken Thompson`_ and has been used and verified by many talented programmers.
Hence, we can be sure the algorithm is not totally wrong and has a decent speed.
.. _math/rand: https://golang.org/pkg/math/rand/
.. _Ken Thompson: https://en.wikipedia.org/wiki/Ken_Thompson
------------
performances
------------
The performance sucks! The java random number generator is many time faster.
But, if the bottle of your application is the random number generator... bravo!
That has never happend to me.
-----
Usage
-----
The usage idea is to generate a *state* from a seed. The seed is an integer
and the state an atom.