RanMT (Morphokinetics)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class RanMT
extends RandomSeedable
implements java.io.Serializable
```
Mersenne Twister -- advanced psuedorandom generator with a period of 2¹⁹⁹³⁷-1

Source code is available.
This class is derived from Sean Luke's implementation
License
Copyright (c) 2003 by Paul Houle.
Derived from a work copyright (c) 2003 by Sean Luke.
Portions copyright (c) 1993 by Michael Lecuyer.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the copyright owners, their employers, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Author:

Paul Houle (E-mail: paul@honeylocust.com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`LOWER_MASK`
`private static int`	`M`
`private int[]`	`mag01`
`private static int`	`MATRIX_A`
`private int[]`	`mt`
`private int`	`mti`
`private static int`	`N`
`private static int`	`TEMPERING_MASK_B`
`private static int`	`TEMPERING_MASK_C`
`private static int`	`UPPER_MASK`

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

Constructor Summary

Constructors
Constructor and Description
`RanMT()`
`RanMT(java.util.Date d)`
`RanMT(int[] array)` If a 32 bit seed isn't enough for you, you can pass an array of 624 integers.
`RanMT(long seed)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`raw()` The abstract method that must be defined to make a working RandomElement.
`private void`	`setSeed(int[] array)` An alternative, more complete, method of seeding the pseudo random number generator.
`private void`	`setSeed(long seed)`

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
  - N
```
private static final int N
```
    See Also:
    
    Constant Field Values
  - M
```
private static final int M
```
    See Also:
    
    Constant Field Values
  - MATRIX_A
```
private static final int MATRIX_A
```
    See Also:
    
    Constant Field Values
  - UPPER_MASK
```
private static final int UPPER_MASK
```
    See Also:
    
    Constant Field Values
  - LOWER_MASK
```
private static final int LOWER_MASK
```
    See Also:
    
    Constant Field Values
  - TEMPERING_MASK_B
```
private static final int TEMPERING_MASK_B
```
    See Also:
    
    Constant Field Values
  - TEMPERING_MASK_C
```
private static final int TEMPERING_MASK_C
```
    See Also:
    
    Constant Field Values
  - mt
```
private int[] mt
```
  - mti
```
private int mti
```
  - mag01
```
private int[] mag01
```
- Constructor Detail
  - RanMT
```
public RanMT()
```
  - RanMT
```
public RanMT(long seed)
```
  - RanMT
```
public RanMT(java.util.Date d)
```
  - RanMT
```
public RanMT(int[] array)
```
    If a 32 bit seed isn't enough for you, you can pass an array of 624 integers. Any array of integers is fine so long as they aren't all zero.
- Method Detail
  - setSeed
```
private void setSeed(long seed)
```
  - setSeed
```
private void setSeed(int[] array)
```
    An alternative, more complete, method of seeding the pseudo random number generator. array must be an array of 624 ints, and they can be any value as long as they're not *all* zero.
  - raw
```
public final double raw()
```
    Description copied from class: RandomElement
    
    The abstract method that must be defined to make a working RandomElement. See the class RandomJava for an example of how to do this.
    
    Specified by:
    
    raw in class RandomElement
    
    Returns:
    
    a random double in the range [0,1]
    
    See Also:
    
    RandomJava

Class RanMT

License

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

N

M

MATRIX_A

UPPER_MASK

LOWER_MASK

TEMPERING_MASK_B

TEMPERING_MASK_C

mt

mti

mag01

Constructor Detail

RanMT

RanMT

RanMT

RanMT

Method Detail

setSeed

setSeed

raw