Skip to content

Commit ba284da

Browse files
committed
#21: Update README.
1 parent b09f28b commit ba284da

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# PRNGine (1.0.1)
1+
# PRNGine
22

3-
*PRNGine* is a pseudo-random number generator library for sequential and parallel [Monte Carlo simulations](https://de.wikipedia.org/wiki/Monte-Carlo-Simulation). It has been designed to work smoothly with the [Jenetics](http://jenetics.io) GA library, but it has no dependency to it. All PRNG implementations of this library extends the Java [Random](http://docs.oracle.com/javase/8/docs/api/java/util/Random.html) class, which makes it easily usable in other projects. *The PRNGs are* **not** *cryptographically strong RNGs.*
3+
[![Build Status](https://travis-ci.org/jenetics/prngine.svg?branch=master)](https://travis-ci.org/jenetics/jpx)
4+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.jenetics/prngine/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22jpx%22)
5+
[![Javadoc](https://www.javadoc.io/badge/io.jenetics/prngine.svg)](http://www.javadoc.io/doc/io.jenetics/prngine)
6+
[![Code Quality: Java](https://img.shields.io/lgtm/grade/java/g/jenetics/prngine.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jenetics/prngine/context:java)
7+
[![Total Alerts](https://img.shields.io/lgtm/alerts/g/jenetics/prngine.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jenetics/prngine/alerts)
8+
9+
**PRNGine** is a pseudo-random number generator library for sequential and parallel [Monte Carlo simulations](https://de.wikipedia.org/wiki/Monte-Carlo-Simulation). It has been designed to work smoothly with the [Jenetics](http://jenetics.io) GA library, but it has no dependency to it. All PRNG implementations of this library extends the Java [Random](http://docs.oracle.com/javase/8/docs/api/java/util/Random.html) class, which makes it easily usable in other projects. *The PRNGs are* **not** *cryptographically strong RNGs.*
410

511
The following PRNGs are currently implemented:
612

@@ -12,22 +18,12 @@ The following PRNGs are currently implemented:
1218
* `XOR32ShiftRandom`: This generator was discovered and characterized by George Marsaglia [[Xorshift RNGs](http://www.jstatsoft.org/v08/i14/paper)]. In just three XORs and three shifts (generally fast operations) it produces a full period of 2<sup>32</sup> - 1 on 32 bits. (The missing value is zero, which perpetuates itself and must be avoided.) High and low bits pass Diehard.
1319
* `XOR64ShiftRandom`: This generator was discovered and characterized by George Marsaglia [[Xorshift RNGs](http://www.jstatsoft.org/v08/i14/paper)]. In just three XORs and three shifts (generally fast operations) it produces a full period of 2<sup>64</sup> - 1 on 64 bits. (The missing value is zero, which perpetuates itself and must be avoided.) High and low bits pass Diehard.
1420

15-
The full Javadoc can be found [here](http://jenetics.io/javadoc/prngine/1.0/index.html).
16-
1721
## Requirements
1822

19-
### Runtime
20-
* **JRE 8**: Java runtime version 8 is needed for using the library.
21-
22-
### Build time
23-
* **JDK 8**: The Java [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) must be installed.
24-
* **Gradle 3.x**: [Gradle](http://www.gradle.org/) is used for building the library. (Gradle is download automatically, if you are using the Gradle Wrapper script `./gradlew`, located in the base directory, for building the library.)
25-
* **TestNG 6.10**: PRNGine uses [TestNG](http://testng.org/doc/index.html) framework for unit tests.
23+
* **JRE 8**: Java runtime version 8 is needed for using the library.
2624

2725
## Building PRNGine
2826

29-
[![Build Status](https://travis-ci.org/jenetics/prngine.svg?branch=master)](https://travis-ci.org/jenetics/prngine)
30-
3127
For building the PRNGine library you have to check out the master branch from Github.
3228

3329
$ git clone https://github.com/jenetics/prngine.git
@@ -41,11 +37,6 @@ For building the PRNGine library you have to check out the master branch from G
4137

4238
$ ./gradle jar
4339

44-
## Download
45-
46-
* **Github**: <https://github.com/jenetics/prngine/archive/v1.0.1.zip>
47-
* **Maven**: `io.jenetics:prngine:1.0.1` on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22prngine%22)
48-
4940
## Examples
5041

5142
### PRN creation

0 commit comments

Comments
 (0)