Ranlux (Morphokinetics)

java.lang.Object
- utils.edu.cornell.lassp.houle.rngPack.RandomElement
- - utils.edu.cornell.lassp.houle.rngPack.RandomSeedable
  - - utils.edu.cornell.lassp.houle.rngPack.Ranlux

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable

public class Ranlux
extends RandomSeedable
implements java.io.Serializable

RANLUX is an advanced pseudo-random number generator based on the RCARRY algorithm proposed in 1991 by Marsaglia and Zaman. RCARRY used a subtract-and-borrow algorithm with a period on the order of 10¹⁷¹ but still had detectable correlations between numbers. Martin Luescher proposed the RANLUX algorithm in 1993; RANLUX generates pseudo-random numbers using RCARRY but throws away numbers to destroy correlations. Thus RANLUX trades execution speed for quality; by choosing a larger luxury setting one gets better random numbers slower. By the tests availible at the time it was proposed, RANLUX at the default luxury setting appears to be a significant advance quality over previous generators.

LUXURY LEVELS
level	p
0	24	equivalent to the original `RCARRY` of Marsaglia and Zaman, very long period, but fails many tests.
1	48	considerable improvement in quality over level 0, now passes the gap test, but still fails spectral test.
2	97	passes all known tests, but theoretically still defective.
3	223	DEFAULT VALUE. Any theoretically possible correlations have very small chance of being observed.
4	389	highest possible luxury, all 24 bits chaotic.

VALIDATION The Java version of RANLUX has been verified against published values of numbers 1-5 and 101-105 produced by the reference implementation of RANLUX for the following initial conditions:

Default initialization: Ranlux()
Initialization with: Ranlux(0,0)
Initialization with: Ranlux(389,1)
Initialization with: Ranlux(75,0)

References:

M. Luscher, Computer Physics Communications 79 (1994) 100
F. James, Computer Physics Communications 79 (1994) 111
About RANLUX random number generator: Excerpts from discussion in the Usenet news groups
Miller's FORTRAN 90 implementation of RANLUX with test code

Source code is available.

Author:: Paul Houle (E-mail: paul@honeylocust.com)
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) float`	`carry`
`(package private) boolean`	`diagOn`
`(package private) int`	`i24`
`(package private) static int`	`icons`
`(package private) static int`	`igiga`
`(package private) int`	`in24`
`(package private) int`	`inseed`
`(package private) int[]`	`isdext`
`(package private) int[]`	`iseeds`
`(package private) static int`	`itwo24`
`(package private) int`	`j24`
`(package private) static int`	`jsdflt`
`(package private) int`	`jseed`
`(package private) int`	`kount`
`(package private) int`	`luxlev`
`static int`	`lxdflt` Default luxury level: `lxdflt=3`
`static int`	`maxlev` Maximum luxury level: `maxlev=4`
`(package private) int`	`mkount`
`(package private) static int[]`	`ndskip`
`(package private) int[]`	`next`
`(package private) int`	`nskip`
`(package private) float[]`	`seeds`
`(package private) float`	`twom12`
`(package private) float`	`twom24`
`(package private) static int`	`twop12`

Fields inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomElement
BMoutput

Constructor Summary

Constructors
Constructor and Description
`Ranlux()` Default initialization of `RANLUX`.
`Ranlux(java.util.Date d)` Initialize `RANLUX` with default luxury level and a Date object.
`Ranlux(int ins)` Initialize `RANLUX` with default luxury level and a specified seed.
`Ranlux(int lux, java.util.Date d)` Initialize `RANLUX` with specified luxury level and a Date object.
`Ranlux(int lux, int ins)` Initialize `RANLUX` with specified luxury level and seed.
`Ranlux(int lux, long ins)` Initialize `RANLUX` with specified luxury level and seed.
`Ranlux(long ins)` Initialize `RANLUX` with default luxury level and a specified seed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`diag(java.lang.String s)`
`private void`	`init_arrays()`
`double`	`raw()` The random number generator.
`private void`	`rluxdef()`
`private void`	`rluxgo(int lux, int ins)`
`void`	`setDiag(boolean b)` Turns diagnostic messages on and off.

Methods inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomSeedable
ClockSeed, ClockSeed

Methods inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomElement
choose, choose, clone, coin, coin, gaussian, gaussian, powlaw, raw, raw, uniform

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - maxlev
```
public static final int maxlev
```
    Maximum luxury level: maxlev=4
    
    See Also:
    
    Constant Field Values
  - lxdflt
```
public static final int lxdflt
```
    Default luxury level: lxdflt=3
    
    See Also:
    
    Constant Field Values
  - igiga
```
static final int igiga
```
    See Also:
    
    Constant Field Values
  - jsdflt
```
static final int jsdflt
```
    See Also:
    
    Constant Field Values
  - twop12
```
static final int twop12
```
    See Also:
    
    Constant Field Values
  - itwo24
```
static final int itwo24
```
    See Also:
    
    Constant Field Values
  - icons
```
static final int icons
```
    See Also:
    
    Constant Field Values
  - ndskip
```
static final int[] ndskip
```
  - iseeds
```
int[] iseeds
```
  - isdext
```
int[] isdext
```
  - next
```
int[] next
```
  - luxlev
```
int luxlev
```
  - nskip
```
int nskip
```
  - inseed
```
int inseed
```
  - jseed
```
int jseed
```
  - in24
```
int in24
```
  - kount
```
int kount
```
  - mkount
```
int mkount
```
  - i24
```
int i24
```
  - j24
```
int j24
```
  - seeds
```
float[] seeds
```
  - carry
```
float carry
```
  - twom24
```
float twom24
```
  - twom12
```
float twom12
```
  - diagOn
```
boolean diagOn
```
- Constructor Detail
  - Ranlux
```
public Ranlux()
```
    Default initialization of RANLUX. Uses default seed jsdflt=314159265 and luxury level 3.
  - Ranlux
```
public Ranlux(int lux,
              int ins)
```
    Initialize RANLUX with specified luxury level and seed.
    
    Parameters:
    
    lux - luxury level from 0-4.
    
    ins - seed, a positive integer.
  - Ranlux
```
public Ranlux(int lux,
              long ins)
```
    Initialize RANLUX with specified luxury level and seed.
    
    Parameters:
    
    lux - luxury level from 0-4.
    
    ins - seed, a positive long.
  - Ranlux
```
public Ranlux(int ins)
```
    Initialize RANLUX with default luxury level and a specified seed.
    
    Parameters:
    
    ins - seed, a positive integer
  - Ranlux
```
public Ranlux(long ins)
```
    Initialize RANLUX with default luxury level and a specified seed.
    
    Parameters:
    
    ins - seed, a positive integer
  - Ranlux
```
public Ranlux(int lux,
              java.util.Date d)
```
    Initialize RANLUX with specified luxury level and a Date object. Can be used to conveniently initialize RANLUX from the clock,
```
 RandomElement e = Ranlux(4,new Date());
 
```
    Parameters:
    
    lux - luxury level from 0-4.
    
    d - date used to generate seed
  - Ranlux
```
public Ranlux(java.util.Date d)
```
    Initialize RANLUX with default luxury level and a Date object. Can be used to conveniently initialize RANLUX from the clock,
```
 RandomElement e = Ranlux(new Date());
 
```
    Parameters:
    
    d - date used to generate seed
- Method Detail
  - setDiag
```
public void setDiag(boolean b)
```
    Turns diagnostic messages on and off. If setDiag(true) is called, RANLUX will print diagnostic information to System.err
    
    Parameters:
    
    b - diagnostic message status
  - raw
```
public final double raw()
```
    The random number generator.
    
    Specified by:
    
    raw in class RandomElement
    
    Returns:
    
    a pseudo-random double in the range (0,1)
    
    See Also:
    
    RandomJava
  - init_arrays
```
private void init_arrays()
```
  - rluxdef
```
private void rluxdef()
```
  - rluxgo
```
private final void rluxgo(int lux,
                          int ins)
```
  - diag
```
private void diag(java.lang.String s)
```

Class Ranlux

Field Summary

Fields inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomElement

Constructor Summary

Method Summary

Methods inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomSeedable

Methods inherited from class utils.edu.cornell.lassp.houle.rngPack.RandomElement

Methods inherited from class java.lang.Object

Field Detail

maxlev

lxdflt

igiga

jsdflt

twop12

itwo24

icons

ndskip

iseeds

isdext

next

luxlev

nskip

inseed

jseed

in24

kount

mkount

i24

j24

seeds

carry

twom24

twom12

diagOn

Constructor Detail

Ranlux

Ranlux

Ranlux

Ranlux

Ranlux

Ranlux

Ranlux

Method Detail

setDiag

raw

init_arrays

rluxdef

rluxgo

diag