RandomKISS.st
author Claus Gittinger <cg@exept.de>
Fri, 10 Feb 2017 11:17:32 +0100
changeset 4311 55d6e8abb73b
parent 3419 4b76d1a14086
child 4324 c3d7f79e34b0
permissions -rw-r--r--
#DOCUMENTATION by cg class: CompressionStream added: #isAbstract
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"{ Package: 'stx:libbasic2' }"
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
Object subclass:#RandomKISS
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
	instanceVariableNames:'x y z c'
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
	classVariableNames:''
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
	poolDictionaries:''
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
	category:'Magnitude-Numbers'
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
!RandomKISS class methodsFor:'documentation'!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
documentation
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
"
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
    Warning: this generator should not be used for cryptographic work.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
    NO WARRANTY
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
    KISS combines a linear congruence, XorShift and Lag with carry geenrator.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
    The idea is from George Marsaglia.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
    RandomKISS new nextInteger
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
    (RandomKISS new:5489) nextInteger
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
    If heavily used, it may be useful to embed the original C code as inline C code for a big speedup)
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
    Please read:
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
        Wikipedia article on KISS http://de.wikipedia.org/wiki/KISS_(Zufallszahlengenerator)
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
        http://de.wikipedia.org/wiki/Liste_von_Zufallszahlengeneratoren
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
        http://eprint.iacr.org/2011/007.pdf  (KISS is not cryptographically secure)
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
    [see also:]
3390
5d3e4ea61bc5 documentation link
Claus Gittinger <cg@exept.de>
parents: 3384
diff changeset
    32
        http://www0.cs.ucl.ac.uk/staff/d.jones/GoodPracticeRNG.pdf
3397
2c9a2efbb06c documentation link
Claus Gittinger <cg@exept.de>
parents: 3390
diff changeset
    33
        RandomGenerator - the default; uses the machine's /dev/random if available
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
        Random  - fast, but generates less quality random numbers
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
        RandomTT800 - another random generator
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
        RandomParkMiller - another random generator
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
        RandomMT19937 - another random generator
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
    [author:]
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
        Ported to Smalltalk by Claus Gittinger.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
"
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
! !
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
!RandomKISS class methodsFor:'instance creation'!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
new
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    ^ self basicNew 
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
        initialize;
3384
da820ca60855 better seeding
Claus Gittinger <cg@exept.de>
parents: 3365
diff changeset
    49
        seed:(Random randomSeed bitAnd:16rFFFFFFFF)
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
new:seed
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
    ^ self basicNew 
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
        initialize;
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
        seed:seed
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
! !
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
!RandomKISS methodsFor:'initialization'!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
initialize
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
    x := 123456789. "/ <- any seed !!= 0
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
    y := 362436000.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
    z := 521288629.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
    c := 7654321.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
seed:seed
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
    self assert:(seed ~= 0).
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
    x := seed.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
! !
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
!RandomKISS methodsFor:'random numbers'!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
nextBoolean
3419
4b76d1a14086 comments
Claus Gittinger <cg@exept.de>
parents: 3397
diff changeset
    75
    "generates a boolean random"
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
    ^ self nextInteger > 16r7FFFFFFF
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
nextInteger
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
    "generates the next integer in 0..FFFFFFFF"
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
    |t|
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
    "/ Linear Congruencegenerator
3364
386f1893c6ba class: RandomKISS
Claus Gittinger <cg@exept.de>
parents: 3356
diff changeset
    86
    x := (69069 * x) + 12345.
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
    x := x bitAnd:16rFFFFFFFF.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
    "/ Xorshift
3364
386f1893c6ba class: RandomKISS
Claus Gittinger <cg@exept.de>
parents: 3356
diff changeset
    90
    y := y bitXor:(y << 13).
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
    y := y bitXor:(y >> 17).
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
    y := y bitXor:(y << 5).
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
    y := y bitAnd:16rFFFFFFFF.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
    "/ Multiply-with-carry
3364
386f1893c6ba class: RandomKISS
Claus Gittinger <cg@exept.de>
parents: 3356
diff changeset
    96
    t := (698769069 * z) + c.
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
    c := t >> 32.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
    z := t bitAnd:16rFFFFFFFF.
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
    ^ (x + y + z) bitAnd:16rFFFFFFFF
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
! !
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
!RandomKISS class methodsFor:'documentation'!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
version
3419
4b76d1a14086 comments
Claus Gittinger <cg@exept.de>
parents: 3397
diff changeset
   106
    ^ '$Header: /cvs/stx/stx/libbasic2/RandomKISS.st,v 1.7 2014-10-02 16:23:23 cg Exp $'
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
!
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
version_CVS
3419
4b76d1a14086 comments
Claus Gittinger <cg@exept.de>
parents: 3397
diff changeset
   110
    ^ '$Header: /cvs/stx/stx/libbasic2/RandomKISS.st,v 1.7 2014-10-02 16:23:23 cg Exp $'
3356
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
! !
abf44c625c74 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112