Skip to content

Commit 330e6f0

Browse files
committed
added more information, refs #3
1 parent 90456f4 commit 330e6f0

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

Diff for: README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
A python implementation of the MIXMAX PRNG.
33

44
## Description
5-
In this project we successfully construct a python implementation of the two-parameter family of C-system operators `A(N,s)`, as discussed in this [1] paper.
5+
In this project we successfully construct a python implementation of the two-parameter family of C-system operators `A(N,s)`, as discussed in this [1] paper. A more general three-parameter family of C-system operators `A(N,s,m)` is calculated too. But our generator doesn't produce all the results of the three parameter family, whereas it works good for the two parameter family.
66

77
## Code
88
There are two implementations. The first attempt was a naive approach, using vanilla python3 for the construction of the operator `A(N,s)`. The second attempt, which is much better and faster is using cython for speeding up the construction process.
99

1010
## How to use the python script
1111
Run: `python3 create_matrix.py` . You'll get instructions then.
1212

13-
An example of correct run: `python3 create_matrix.py 100 0 1`.
13+
An example of correct run: `python3 create_matrix.py 128 1 1`.
1414

1515
## How to use the cython files
1616

@@ -23,10 +23,11 @@ Simply run in your terminal:
2323
### Using the create_matrix_new.py script
2424
Run: `python3 create_matrix_new.py`. You'll get instructions then.
2525

26-
A correct run: `python3 create_matrix_new.py 100 0 1`.
26+
A correct run: `python3 create_matrix_new.py 128 1 1`.
2727

2828
## Features
29-
Both programs plot the distributions of the eigenvalues of the given `A(N,s)` for input variables `N`,`s` on the plane.
29+
Both programs plot the distributions of the eigenvalues of the given `A(N,s,m)` for input variables `N`,`s,m` on the plane.
30+
When `m` equals `1` then `A(N,s,m``)` is the same matrix as the matrix `A(N,s)`.
3031

3132
## Results
3233
The results agree with the results presented in the paper [1]. The distribution of the eigenvalues in some cases follow the curve of a cardioid as expected. For various other values of `N` and `s` different shapes are being created. See inside the images directory for more examples.

0 commit comments

Comments
 (0)