RandomKISS2.st
author Claus Gittinger <cg@exept.de>
Wed, 01 Oct 2014 15:27:25 +0200
changeset 3366 9f2ba94535c2
child 3382 0c6e6bcca5fb
permissions -rw-r--r--
initial checkin
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3366
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"{ Package: 'stx:libbasic2' }"
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
Object subclass:#RandomKISS2
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
	instanceVariableNames:'x y z c'
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
	classVariableNames:''
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
	poolDictionaries:''
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
	category:'Magnitude-Numbers'
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
!RandomKISS2 class methodsFor:'documentation'!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
documentation
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
"
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
    Warning: this generator should not be used for cryptographic work.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
    NO WARRANTY
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
    KISS combines a linear congruence, XorShift and Lag with carry geenrator.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
    The idea is from George Marsaglia.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
    KISS2 uses slightly different parameters and initial state.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
    RandomKISS2 new nextInteger
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
    (RandomKISS2 new:5489) nextInteger
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
    If heavily used, it may be useful to embed the original C code as inline C code for a big speedup)
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
    Please read:
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
        http://www.cs.ucl.ac.uk/staff/d.jones/GoodPracticeRNG.pdf
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
    [see also:]
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
        RandomGenerator - the default; uses the machines /dev/random if available
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
        Random  - fast, but generates less quality random numbers
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
        RandomTT800 - another random generator
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
        RandomParkMiller - another random generator
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
        RandomMT19937 - another random generator
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
    [author:]
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
        Ported to Smalltalk by Claus Gittinger.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
"
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
! !
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
!RandomKISS2 class methodsFor:'instance creation'!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
new
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
    ^ self basicNew 
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
        initialize;
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
        seed:(Time millisecondClockValue)
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
new:seed
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
    ^ self basicNew 
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
        initialize;
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
        seed:seed
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
! !
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
!RandomKISS2 methodsFor:'initialization'!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
initialize
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
    x := 123456789. "/ <- any seed !!= 0
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
    y := 362436000.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
    z := 521288629.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
    c := 7654321.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
seed:seed
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
    self assert:(seed ~= 0).
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
    x := seed.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
! !
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
!RandomKISS2 methodsFor:'random numbers'!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
nextBoolean
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
    "generates the next integer in 0..FFFFFFFF"
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
    ^ self nextInteger > 16r7FFFFFFF
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
nextInteger
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
    "generates the next integer in 0..FFFFFFFF"
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
    |t|
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
    "/ Linear Congruencegenerator
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
    x := (314527869 * x) + 1234567.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
    x := x bitAnd:16rFFFFFFFF.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
    "/ Xorshift
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
    y := y bitXor:(y << 5).
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
    y := y bitAnd:16rFFFFFFFF.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
    y := y bitXor:(y >> 7).
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
    y := y bitAnd:16rFFFFFFFF.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
    y := y bitXor:(y << 22).
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
    y := y bitAnd:16rFFFFFFFF.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
    "/ Multiply-with-carry
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
    t := (4294584393 * z) + c.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
    c := t >> 32.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
    z := t bitAnd:16rFFFFFFFF.
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
    ^ (x + y + z) bitAnd:16rFFFFFFFF
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
! !
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
!RandomKISS2 class methodsFor:'documentation'!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
version
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
    ^ '$Header: /cvs/stx/stx/libbasic2/RandomKISS2.st,v 1.1 2014-10-01 13:27:25 cg Exp $'
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
!
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
version_CVS
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   110
    ^ '$Header: /cvs/stx/stx/libbasic2/RandomKISS2.st,v 1.1 2014-10-01 13:27:25 cg Exp $'
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
! !
9f2ba94535c2 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112