lemon/random.h
author Alpar Juttner <alpar@cs.elte.hu>
Tue, 17 Jun 2008 12:47:15 +0100
changeset 176 47b69d4b0759
parent 110 f2d66d810c88
child 177 b685e12e08c0
permissions -rw-r--r--
Merge
alpar@10
     1
/* -*- C++ -*-
alpar@10
     2
 *
alpar@10
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@10
     4
 *
alpar@39
     5
 * Copyright (C) 2003-2008
alpar@10
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@10
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@10
     8
 *
alpar@10
     9
 * Permission to use, modify and distribute this software is granted
alpar@10
    10
 * provided that this copyright notice appears in all copies. For
alpar@10
    11
 * precise terms see the accompanying LICENSE file.
alpar@10
    12
 *
alpar@10
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@10
    14
 * express or implied, and with no claim as to its suitability for any
alpar@10
    15
 * purpose.
alpar@10
    16
 *
alpar@10
    17
 */
alpar@10
    18
alpar@10
    19
/*
alpar@10
    20
 * This file contains the reimplemented version of the Mersenne Twister
alpar@10
    21
 * Generator of Matsumoto and Nishimura.
alpar@10
    22
 *
alpar@10
    23
 * See the appropriate copyright notice below.
alpar@10
    24
 * 
alpar@10
    25
 * Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
alpar@10
    26
 * All rights reserved.                          
alpar@10
    27
 *
alpar@10
    28
 * Redistribution and use in source and binary forms, with or without
alpar@10
    29
 * modification, are permitted provided that the following conditions
alpar@10
    30
 * are met:
alpar@10
    31
 *
alpar@10
    32
 * 1. Redistributions of source code must retain the above copyright
alpar@10
    33
 *    notice, this list of conditions and the following disclaimer.
alpar@10
    34
 *
alpar@10
    35
 * 2. Redistributions in binary form must reproduce the above copyright
alpar@10
    36
 *    notice, this list of conditions and the following disclaimer in the
alpar@10
    37
 *    documentation and/or other materials provided with the distribution.
alpar@10
    38
 *
alpar@10
    39
 * 3. The names of its contributors may not be used to endorse or promote 
alpar@10
    40
 *    products derived from this software without specific prior written 
alpar@10
    41
 *    permission.
alpar@10
    42
 *
alpar@10
    43
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
alpar@10
    44
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
alpar@10
    45
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
alpar@10
    46
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
alpar@10
    47
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
alpar@10
    48
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
alpar@10
    49
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
alpar@10
    50
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
alpar@10
    51
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
alpar@10
    52
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
alpar@10
    53
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
alpar@10
    54
 * OF THE POSSIBILITY OF SUCH DAMAGE.
alpar@10
    55
 *
alpar@10
    56
 *
alpar@10
    57
 * Any feedback is very welcome.
alpar@10
    58
 * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
alpar@10
    59
 * email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
alpar@10
    60
 */
alpar@10
    61
alpar@10
    62
#ifndef LEMON_RANDOM_H
alpar@10
    63
#define LEMON_RANDOM_H
alpar@10
    64
alpar@10
    65
#include <algorithm>
alpar@10
    66
#include <iterator>
alpar@10
    67
#include <vector>
deba@110
    68
#include <limits>
alpar@10
    69
alpar@68
    70
#include <lemon/math.h>
alpar@10
    71
#include <lemon/dim2.h>
alpar@68
    72
alpar@10
    73
///\ingroup misc
alpar@10
    74
///\file
alpar@10
    75
///\brief Mersenne Twister random number generator
alpar@10
    76
alpar@10
    77
namespace lemon {
alpar@10
    78
alpar@10
    79
  namespace _random_bits {
alpar@10
    80
    
alpar@10
    81
    template <typename _Word, int _bits = std::numeric_limits<_Word>::digits>
alpar@10
    82
    struct RandomTraits {};
alpar@10
    83
alpar@10
    84
    template <typename _Word>
alpar@10
    85
    struct RandomTraits<_Word, 32> {
alpar@10
    86
alpar@10
    87
      typedef _Word Word;
alpar@10
    88
      static const int bits = 32;
alpar@10
    89
alpar@10
    90
      static const int length = 624;
alpar@10
    91
      static const int shift = 397;
alpar@10
    92
      
alpar@10
    93
      static const Word mul = 0x6c078965u;
alpar@10
    94
      static const Word arrayInit = 0x012BD6AAu;
alpar@10
    95
      static const Word arrayMul1 = 0x0019660Du;
alpar@10
    96
      static const Word arrayMul2 = 0x5D588B65u;
alpar@10
    97
alpar@10
    98
      static const Word mask = 0x9908B0DFu;
alpar@10
    99
      static const Word loMask = (1u << 31) - 1;
alpar@10
   100
      static const Word hiMask = ~loMask;
alpar@10
   101
alpar@10
   102
alpar@10
   103
      static Word tempering(Word rnd) {
alpar@10
   104
        rnd ^= (rnd >> 11);
alpar@10
   105
        rnd ^= (rnd << 7) & 0x9D2C5680u;
alpar@10
   106
        rnd ^= (rnd << 15) & 0xEFC60000u;
alpar@10
   107
        rnd ^= (rnd >> 18);
alpar@10
   108
        return rnd;
alpar@10
   109
      }
alpar@10
   110
alpar@10
   111
    };
alpar@10
   112
alpar@10
   113
    template <typename _Word>
alpar@10
   114
    struct RandomTraits<_Word, 64> {
alpar@10
   115
alpar@10
   116
      typedef _Word Word;
alpar@10
   117
      static const int bits = 64;
alpar@10
   118
alpar@10
   119
      static const int length = 312;
alpar@10
   120
      static const int shift = 156;
alpar@10
   121
alpar@10
   122
      static const Word mul = Word(0x5851F42Du) << 32 | Word(0x4C957F2Du);
alpar@10
   123
      static const Word arrayInit = Word(0x00000000u) << 32 |Word(0x012BD6AAu);
alpar@10
   124
      static const Word arrayMul1 = Word(0x369DEA0Fu) << 32 |Word(0x31A53F85u);
alpar@10
   125
      static const Word arrayMul2 = Word(0x27BB2EE6u) << 32 |Word(0x87B0B0FDu);
alpar@10
   126
alpar@10
   127
      static const Word mask = Word(0xB5026F5Au) << 32 | Word(0xA96619E9u);
alpar@10
   128
      static const Word loMask = (Word(1u) << 31) - 1;
alpar@10
   129
      static const Word hiMask = ~loMask;
alpar@10
   130
alpar@10
   131
      static Word tempering(Word rnd) {
alpar@10
   132
        rnd ^= (rnd >> 29) & (Word(0x55555555u) << 32 | Word(0x55555555u));
alpar@10
   133
        rnd ^= (rnd << 17) & (Word(0x71D67FFFu) << 32 | Word(0xEDA60000u));
alpar@10
   134
        rnd ^= (rnd << 37) & (Word(0xFFF7EEE0u) << 32 | Word(0x00000000u));
alpar@10
   135
        rnd ^= (rnd >> 43);
alpar@10
   136
        return rnd;
alpar@10
   137
      }
alpar@10
   138
alpar@10
   139
    };
alpar@10
   140
alpar@10
   141
    template <typename _Word>
alpar@10
   142
    class RandomCore {
alpar@10
   143
    public:
alpar@10
   144
alpar@10
   145
      typedef _Word Word;
alpar@10
   146
alpar@10
   147
    private:
alpar@10
   148
alpar@10
   149
      static const int bits = RandomTraits<Word>::bits;
alpar@10
   150
alpar@10
   151
      static const int length = RandomTraits<Word>::length;
alpar@10
   152
      static const int shift = RandomTraits<Word>::shift;
alpar@10
   153
alpar@10
   154
    public:
alpar@10
   155
alpar@10
   156
      void initState() {
alpar@10
   157
        static const Word seedArray[4] = {
alpar@10
   158
          0x12345u, 0x23456u, 0x34567u, 0x45678u
alpar@10
   159
        };
alpar@10
   160
    
alpar@10
   161
        initState(seedArray, seedArray + 4);
alpar@10
   162
      }
alpar@10
   163
alpar@10
   164
      void initState(Word seed) {
alpar@10
   165
alpar@10
   166
        static const Word mul = RandomTraits<Word>::mul;
alpar@10
   167
alpar@10
   168
        current = state; 
alpar@10
   169
alpar@10
   170
        Word *curr = state + length - 1;
alpar@10
   171
        curr[0] = seed; --curr;
alpar@10
   172
        for (int i = 1; i < length; ++i) {
alpar@10
   173
          curr[0] = (mul * ( curr[1] ^ (curr[1] >> (bits - 2)) ) + i);
alpar@10
   174
          --curr;
alpar@10
   175
        }
alpar@10
   176
      }
alpar@10
   177
alpar@10
   178
      template <typename Iterator>
alpar@10
   179
      void initState(Iterator begin, Iterator end) {
alpar@10
   180
alpar@10
   181
        static const Word init = RandomTraits<Word>::arrayInit;
alpar@10
   182
        static const Word mul1 = RandomTraits<Word>::arrayMul1;
alpar@10
   183
        static const Word mul2 = RandomTraits<Word>::arrayMul2;
alpar@10
   184
alpar@10
   185
alpar@10
   186
        Word *curr = state + length - 1; --curr;
alpar@10
   187
        Iterator it = begin; int cnt = 0;
alpar@10
   188
        int num;
alpar@10
   189
alpar@10
   190
        initState(init);
alpar@10
   191
alpar@10
   192
        num = length > end - begin ? length : end - begin;
alpar@10
   193
        while (num--) {
alpar@10
   194
          curr[0] = (curr[0] ^ ((curr[1] ^ (curr[1] >> (bits - 2))) * mul1)) 
alpar@10
   195
            + *it + cnt;
alpar@10
   196
          ++it; ++cnt;
alpar@10
   197
          if (it == end) {
alpar@10
   198
            it = begin; cnt = 0;
alpar@10
   199
          }
alpar@10
   200
          if (curr == state) {
alpar@10
   201
            curr = state + length - 1; curr[0] = state[0];
alpar@10
   202
          }
alpar@10
   203
          --curr;
alpar@10
   204
        }
alpar@10
   205
alpar@10
   206
        num = length - 1; cnt = length - (curr - state) - 1;
alpar@10
   207
        while (num--) {
alpar@10
   208
          curr[0] = (curr[0] ^ ((curr[1] ^ (curr[1] >> (bits - 2))) * mul2))
alpar@10
   209
            - cnt;
alpar@10
   210
          --curr; ++cnt;
alpar@10
   211
          if (curr == state) {
alpar@10
   212
            curr = state + length - 1; curr[0] = state[0]; --curr;
alpar@10
   213
            cnt = 1;
alpar@10
   214
          }
alpar@10
   215
        }
alpar@10
   216
        
alpar@10
   217
        state[length - 1] = Word(1) << (bits - 1);
alpar@10
   218
      }
alpar@10
   219
      
alpar@10
   220
      void copyState(const RandomCore& other) {
alpar@10
   221
        std::copy(other.state, other.state + length, state);
alpar@10
   222
        current = state + (other.current - other.state);
alpar@10
   223
      }
alpar@10
   224
alpar@10
   225
      Word operator()() {
alpar@10
   226
        if (current == state) fillState();
alpar@10
   227
        --current;
alpar@10
   228
        Word rnd = *current;
alpar@10
   229
        return RandomTraits<Word>::tempering(rnd);
alpar@10
   230
      }
alpar@10
   231
alpar@10
   232
    private:
alpar@10
   233
alpar@10
   234
  
alpar@10
   235
      void fillState() {
alpar@10
   236
        static const Word mask[2] = { 0x0ul, RandomTraits<Word>::mask };
alpar@10
   237
        static const Word loMask = RandomTraits<Word>::loMask;
alpar@10
   238
        static const Word hiMask = RandomTraits<Word>::hiMask;
alpar@10
   239
alpar@10
   240
        current = state + length; 
alpar@10
   241
alpar@10
   242
        register Word *curr = state + length - 1;
alpar@10
   243
        register long num;
alpar@10
   244
      
alpar@10
   245
        num = length - shift;
alpar@10
   246
        while (num--) {
alpar@10
   247
          curr[0] = (((curr[0] & hiMask) | (curr[-1] & loMask)) >> 1) ^
alpar@10
   248
            curr[- shift] ^ mask[curr[-1] & 1ul];
alpar@10
   249
          --curr;
alpar@10
   250
        }
alpar@10
   251
        num = shift - 1;
alpar@10
   252
        while (num--) {
alpar@10
   253
          curr[0] = (((curr[0] & hiMask) | (curr[-1] & loMask)) >> 1) ^
alpar@10
   254
            curr[length - shift] ^ mask[curr[-1] & 1ul];
alpar@10
   255
          --curr;
alpar@10
   256
        }
deba@62
   257
        state[0] = (((state[0] & hiMask) | (curr[length - 1] & loMask)) >> 1) ^
alpar@10
   258
          curr[length - shift] ^ mask[curr[length - 1] & 1ul];
alpar@10
   259
alpar@10
   260
      }
alpar@10
   261
alpar@10
   262
  
alpar@10
   263
      Word *current;
alpar@10
   264
      Word state[length];
alpar@10
   265
      
alpar@10
   266
    };
alpar@10
   267
alpar@10
   268
alpar@10
   269
    template <typename Result, 
alpar@10
   270
              int shift = (std::numeric_limits<Result>::digits + 1) / 2>
alpar@10
   271
    struct Masker {
alpar@10
   272
      static Result mask(const Result& result) {
alpar@10
   273
        return Masker<Result, (shift + 1) / 2>::
alpar@10
   274
          mask(static_cast<Result>(result | (result >> shift)));
alpar@10
   275
      }
alpar@10
   276
    };
alpar@10
   277
    
alpar@10
   278
    template <typename Result>
alpar@10
   279
    struct Masker<Result, 1> {
alpar@10
   280
      static Result mask(const Result& result) {
alpar@10
   281
        return static_cast<Result>(result | (result >> 1));
alpar@10
   282
      }
alpar@10
   283
    };
alpar@10
   284
alpar@10
   285
    template <typename Result, typename Word, 
alpar@10
   286
              int rest = std::numeric_limits<Result>::digits, int shift = 0, 
alpar@10
   287
              bool last = rest <= std::numeric_limits<Word>::digits>
alpar@10
   288
    struct IntConversion {
alpar@10
   289
      static const int bits = std::numeric_limits<Word>::digits;
alpar@10
   290
    
alpar@10
   291
      static Result convert(RandomCore<Word>& rnd) {
alpar@10
   292
        return static_cast<Result>(rnd() >> (bits - rest)) << shift;
alpar@10
   293
      }
alpar@10
   294
      
alpar@10
   295
    }; 
alpar@10
   296
alpar@10
   297
    template <typename Result, typename Word, int rest, int shift> 
alpar@10
   298
    struct IntConversion<Result, Word, rest, shift, false> {
alpar@10
   299
      static const int bits = std::numeric_limits<Word>::digits;
alpar@10
   300
alpar@10
   301
      static Result convert(RandomCore<Word>& rnd) {
alpar@10
   302
        return (static_cast<Result>(rnd()) << shift) | 
alpar@10
   303
          IntConversion<Result, Word, rest - bits, shift + bits>::convert(rnd);
alpar@10
   304
      }
alpar@10
   305
    };
alpar@10
   306
alpar@10
   307
alpar@10
   308
    template <typename Result, typename Word,
alpar@10
   309
              bool one_word = (std::numeric_limits<Word>::digits < 
alpar@10
   310
			       std::numeric_limits<Result>::digits) >
alpar@10
   311
    struct Mapping {
alpar@10
   312
      static Result map(RandomCore<Word>& rnd, const Result& bound) {
alpar@10
   313
        Word max = Word(bound - 1);
alpar@10
   314
        Result mask = Masker<Result>::mask(bound - 1);
alpar@10
   315
        Result num;
alpar@10
   316
        do {
alpar@10
   317
          num = IntConversion<Result, Word>::convert(rnd) & mask; 
alpar@10
   318
        } while (num > max);
alpar@10
   319
        return num;
alpar@10
   320
      }
alpar@10
   321
    };
alpar@10
   322
alpar@10
   323
    template <typename Result, typename Word>
alpar@10
   324
    struct Mapping<Result, Word, false> {
alpar@10
   325
      static Result map(RandomCore<Word>& rnd, const Result& bound) {
alpar@10
   326
        Word max = Word(bound - 1);
alpar@10
   327
        Word mask = Masker<Word, (std::numeric_limits<Result>::digits + 1) / 2>
alpar@10
   328
          ::mask(max);
alpar@10
   329
        Word num;
alpar@10
   330
        do {
alpar@10
   331
          num = rnd() & mask;
alpar@10
   332
        } while (num > max);
alpar@10
   333
        return num;
alpar@10
   334
      }
alpar@10
   335
    };
alpar@10
   336
alpar@10
   337
    template <typename Result, int exp, bool pos = (exp >= 0)>
alpar@10
   338
    struct ShiftMultiplier {
alpar@10
   339
      static const Result multiplier() {
alpar@10
   340
        Result res = ShiftMultiplier<Result, exp / 2>::multiplier();
alpar@10
   341
        res *= res;
alpar@10
   342
        if ((exp & 1) == 1) res *= static_cast<Result>(2.0);
alpar@10
   343
        return res; 
alpar@10
   344
      }
alpar@10
   345
    };
alpar@10
   346
alpar@10
   347
    template <typename Result, int exp>
alpar@10
   348
    struct ShiftMultiplier<Result, exp, false> {
alpar@10
   349
      static const Result multiplier() {
alpar@10
   350
        Result res = ShiftMultiplier<Result, exp / 2>::multiplier();
alpar@10
   351
        res *= res;
alpar@10
   352
        if ((exp & 1) == 1) res *= static_cast<Result>(0.5);
alpar@10
   353
        return res; 
alpar@10
   354
      }
alpar@10
   355
    };
alpar@10
   356
alpar@10
   357
    template <typename Result>
alpar@10
   358
    struct ShiftMultiplier<Result, 0, true> {
alpar@10
   359
      static const Result multiplier() {
alpar@10
   360
        return static_cast<Result>(1.0); 
alpar@10
   361
      }
alpar@10
   362
    };
alpar@10
   363
alpar@10
   364
    template <typename Result>
alpar@10
   365
    struct ShiftMultiplier<Result, -20, true> {
alpar@10
   366
      static const Result multiplier() {
alpar@10
   367
        return static_cast<Result>(1.0/1048576.0); 
alpar@10
   368
      }
alpar@10
   369
    };
alpar@10
   370
    
alpar@10
   371
    template <typename Result>
alpar@10
   372
    struct ShiftMultiplier<Result, -32, true> {
alpar@10
   373
      static const Result multiplier() {
alpar@10
   374
        return static_cast<Result>(1.0/424967296.0); 
alpar@10
   375
      }
alpar@10
   376
    };
alpar@10
   377
alpar@10
   378
    template <typename Result>
alpar@10
   379
    struct ShiftMultiplier<Result, -53, true> {
alpar@10
   380
      static const Result multiplier() {
alpar@10
   381
        return static_cast<Result>(1.0/9007199254740992.0); 
alpar@10
   382
      }
alpar@10
   383
    };
alpar@10
   384
alpar@10
   385
    template <typename Result>
alpar@10
   386
    struct ShiftMultiplier<Result, -64, true> {
alpar@10
   387
      static const Result multiplier() {
alpar@10
   388
        return static_cast<Result>(1.0/18446744073709551616.0); 
alpar@10
   389
      }
alpar@10
   390
    };
alpar@10
   391
alpar@10
   392
    template <typename Result, int exp>
alpar@10
   393
    struct Shifting {
alpar@10
   394
      static Result shift(const Result& result) {
alpar@10
   395
        return result * ShiftMultiplier<Result, exp>::multiplier();
alpar@10
   396
      }
alpar@10
   397
    };
alpar@10
   398
alpar@10
   399
    template <typename Result, typename Word,
alpar@10
   400
              int rest = std::numeric_limits<Result>::digits, int shift = 0, 
alpar@10
   401
              bool last = rest <= std::numeric_limits<Word>::digits>
alpar@10
   402
    struct RealConversion{ 
alpar@10
   403
      static const int bits = std::numeric_limits<Word>::digits;
alpar@10
   404
alpar@10
   405
      static Result convert(RandomCore<Word>& rnd) {
alpar@10
   406
        return Shifting<Result, - shift - rest>::
alpar@10
   407
          shift(static_cast<Result>(rnd() >> (bits - rest)));
alpar@10
   408
      }
alpar@10
   409
    };
alpar@10
   410
alpar@10
   411
    template <typename Result, typename Word, int rest, int shift>
alpar@10
   412
    struct RealConversion<Result, Word, rest, shift, false> { 
alpar@10
   413
      static const int bits = std::numeric_limits<Word>::digits;
alpar@10
   414
alpar@10
   415
      static Result convert(RandomCore<Word>& rnd) {
alpar@10
   416
        return Shifting<Result, - shift - bits>::
alpar@10
   417
          shift(static_cast<Result>(rnd())) +
alpar@10
   418
          RealConversion<Result, Word, rest-bits, shift + bits>::
alpar@10
   419
          convert(rnd);
alpar@10
   420
      }
alpar@10
   421
    };
alpar@10
   422
alpar@10
   423
    template <typename Result, typename Word>
alpar@10
   424
    struct Initializer {
alpar@10
   425
alpar@10
   426
      template <typename Iterator>
alpar@10
   427
      static void init(RandomCore<Word>& rnd, Iterator begin, Iterator end) {
alpar@10
   428
        std::vector<Word> ws;
alpar@10
   429
        for (Iterator it = begin; it != end; ++it) {
alpar@10
   430
          ws.push_back(Word(*it));
alpar@10
   431
        }
alpar@10
   432
        rnd.initState(ws.begin(), ws.end());
alpar@10
   433
      }
alpar@10
   434
alpar@10
   435
      static void init(RandomCore<Word>& rnd, Result seed) {
alpar@10
   436
        rnd.initState(seed);
alpar@10
   437
      }
alpar@10
   438
    };
alpar@10
   439
alpar@10
   440
    template <typename Word>
alpar@10
   441
    struct BoolConversion {
alpar@10
   442
      static bool convert(RandomCore<Word>& rnd) {
alpar@10
   443
        return (rnd() & 1) == 1;
alpar@10
   444
      }
alpar@10
   445
    };
alpar@10
   446
alpar@10
   447
    template <typename Word>
alpar@10
   448
    struct BoolProducer {
alpar@10
   449
      Word buffer;
alpar@10
   450
      int num;
alpar@10
   451
      
alpar@10
   452
      BoolProducer() : num(0) {}
alpar@10
   453
alpar@10
   454
      bool convert(RandomCore<Word>& rnd) {
alpar@10
   455
        if (num == 0) {
alpar@10
   456
          buffer = rnd();
alpar@10
   457
          num = RandomTraits<Word>::bits;
alpar@10
   458
        }
alpar@10
   459
        bool r = (buffer & 1);
alpar@10
   460
        buffer >>= 1;
alpar@10
   461
        --num;
alpar@10
   462
        return r;
alpar@10
   463
      }
alpar@10
   464
    };
alpar@10
   465
alpar@10
   466
  }
alpar@10
   467
alpar@10
   468
  /// \ingroup misc
alpar@10
   469
  ///
alpar@10
   470
  /// \brief Mersenne Twister random number generator
alpar@10
   471
  ///
alpar@10
   472
  /// The Mersenne Twister is a twisted generalized feedback
alpar@10
   473
  /// shift-register generator of Matsumoto and Nishimura. The period
alpar@10
   474
  /// of this generator is \f$ 2^{19937} - 1 \f$ and it is
alpar@10
   475
  /// equi-distributed in 623 dimensions for 32-bit numbers. The time
alpar@10
   476
  /// performance of this generator is comparable to the commonly used
alpar@10
   477
  /// generators.
alpar@10
   478
  ///
alpar@10
   479
  /// This implementation is specialized for both 32-bit and 64-bit
alpar@10
   480
  /// architectures. The generators differ sligthly in the
alpar@10
   481
  /// initialization and generation phase so they produce two
alpar@10
   482
  /// completly different sequences.
alpar@10
   483
  ///
alpar@10
   484
  /// The generator gives back random numbers of serveral types. To
alpar@10
   485
  /// get a random number from a range of a floating point type you
alpar@10
   486
  /// can use one form of the \c operator() or the \c real() member
alpar@10
   487
  /// function. If you want to get random number from the {0, 1, ...,
alpar@10
   488
  /// n-1} integer range use the \c operator[] or the \c integer()
alpar@10
   489
  /// method. And to get random number from the whole range of an
alpar@10
   490
  /// integer type you can use the argumentless \c integer() or \c
alpar@10
   491
  /// uinteger() functions. After all you can get random bool with
alpar@10
   492
  /// equal chance of true and false or given probability of true
alpar@10
   493
  /// result with the \c boolean() member functions.
alpar@10
   494
  ///
alpar@10
   495
  ///\code
alpar@10
   496
  /// // The commented code is identical to the other
alpar@10
   497
  /// double a = rnd();                     // [0.0, 1.0)
alpar@10
   498
  /// // double a = rnd.real();             // [0.0, 1.0)
alpar@10
   499
  /// double b = rnd(100.0);                // [0.0, 100.0)
alpar@10
   500
  /// // double b = rnd.real(100.0);        // [0.0, 100.0)
alpar@10
   501
  /// double c = rnd(1.0, 2.0);             // [1.0, 2.0)
alpar@10
   502
  /// // double c = rnd.real(1.0, 2.0);     // [1.0, 2.0)
alpar@10
   503
  /// int d = rnd[100000];                  // 0..99999
alpar@10
   504
  /// // int d = rnd.integer(100000);       // 0..99999
alpar@10
   505
  /// int e = rnd[6] + 1;                   // 1..6
alpar@10
   506
  /// // int e = rnd.integer(1, 1 + 6);     // 1..6
alpar@10
   507
  /// int b = rnd.uinteger<int>();          // 0 .. 2^31 - 1
alpar@10
   508
  /// int c = rnd.integer<int>();           // - 2^31 .. 2^31 - 1
alpar@10
   509
  /// bool g = rnd.boolean();               // P(g = true) = 0.5
alpar@10
   510
  /// bool h = rnd.boolean(0.8);            // P(h = true) = 0.8
alpar@10
   511
  ///\endcode
alpar@10
   512
  ///
kpeter@49
   513
  /// LEMON provides a global instance of the random number
alpar@10
   514
  /// generator which name is \ref lemon::rnd "rnd". Usually it is a
alpar@10
   515
  /// good programming convenience to use this global generator to get
alpar@10
   516
  /// random numbers.
alpar@10
   517
  class Random {
alpar@10
   518
  private:
alpar@10
   519
kpeter@16
   520
    // Architecture word
alpar@10
   521
    typedef unsigned long Word;
alpar@10
   522
    
alpar@10
   523
    _random_bits::RandomCore<Word> core;
alpar@10
   524
    _random_bits::BoolProducer<Word> bool_producer;
alpar@10
   525
    
alpar@10
   526
alpar@10
   527
  public:
alpar@10
   528
kpeter@49
   529
    /// \brief Default constructor
alpar@10
   530
    ///
alpar@10
   531
    /// Constructor with constant seeding.
alpar@10
   532
    Random() { core.initState(); }
alpar@10
   533
kpeter@49
   534
    /// \brief Constructor with seed
alpar@10
   535
    ///
alpar@10
   536
    /// Constructor with seed. The current number type will be converted
alpar@10
   537
    /// to the architecture word type.
alpar@10
   538
    template <typename Number>
alpar@10
   539
    Random(Number seed) { 
alpar@10
   540
      _random_bits::Initializer<Number, Word>::init(core, seed);
alpar@10
   541
    }
alpar@10
   542
kpeter@49
   543
    /// \brief Constructor with array seeding
alpar@10
   544
    ///
alpar@10
   545
    /// Constructor with array seeding. The given range should contain
alpar@10
   546
    /// any number type and the numbers will be converted to the
alpar@10
   547
    /// architecture word type.
alpar@10
   548
    template <typename Iterator>
alpar@10
   549
    Random(Iterator begin, Iterator end) { 
alpar@10
   550
      typedef typename std::iterator_traits<Iterator>::value_type Number;
alpar@10
   551
      _random_bits::Initializer<Number, Word>::init(core, begin, end);
alpar@10
   552
    }
alpar@10
   553
alpar@10
   554
    /// \brief Copy constructor
alpar@10
   555
    ///
alpar@10
   556
    /// Copy constructor. The generated sequence will be identical to
alpar@10
   557
    /// the other sequence. It can be used to save the current state
alpar@10
   558
    /// of the generator and later use it to generate the same
alpar@10
   559
    /// sequence.
alpar@10
   560
    Random(const Random& other) {
alpar@10
   561
      core.copyState(other.core);
alpar@10
   562
    }
alpar@10
   563
alpar@10
   564
    /// \brief Assign operator
alpar@10
   565
    ///
alpar@10
   566
    /// Assign operator. The generated sequence will be identical to
alpar@10
   567
    /// the other sequence. It can be used to save the current state
alpar@10
   568
    /// of the generator and later use it to generate the same
alpar@10
   569
    /// sequence.
alpar@10
   570
    Random& operator=(const Random& other) {
alpar@10
   571
      if (&other != this) {
alpar@10
   572
        core.copyState(other.core);
alpar@10
   573
      }
alpar@10
   574
      return *this;
alpar@10
   575
    }
alpar@10
   576
deba@102
   577
    /// \brief Seeding random sequence
deba@102
   578
    ///
deba@102
   579
    /// Seeding the random sequence. The current number type will be
deba@102
   580
    /// converted to the architecture word type.
deba@102
   581
    template <typename Number>
deba@102
   582
    void seed(Number seed) { 
deba@102
   583
      _random_bits::Initializer<Number, Word>::init(core, seed);
deba@102
   584
    }
deba@102
   585
deba@102
   586
    /// \brief Seeding random sequence
deba@102
   587
    ///
deba@102
   588
    /// Seeding the random sequence. The given range should contain
deba@102
   589
    /// any number type and the numbers will be converted to the
deba@102
   590
    /// architecture word type.
deba@102
   591
    template <typename Iterator>
deba@102
   592
    void seed(Iterator begin, Iterator end) { 
deba@102
   593
      typedef typename std::iterator_traits<Iterator>::value_type Number;
deba@102
   594
      _random_bits::Initializer<Number, Word>::init(core, begin, end);
deba@102
   595
    }
deba@102
   596
alpar@10
   597
    /// \brief Returns a random real number from the range [0, 1)
alpar@10
   598
    ///
alpar@10
   599
    /// It returns a random real number from the range [0, 1). The
kpeter@49
   600
    /// default Number type is \c double.
alpar@10
   601
    template <typename Number>
alpar@10
   602
    Number real() {
alpar@10
   603
      return _random_bits::RealConversion<Number, Word>::convert(core);
alpar@10
   604
    }
alpar@10
   605
alpar@10
   606
    double real() {
alpar@10
   607
      return real<double>();
alpar@10
   608
    }
alpar@10
   609
alpar@10
   610
    /// \brief Returns a random real number the range [0, b)
alpar@10
   611
    ///
alpar@10
   612
    /// It returns a random real number from the range [0, b).
alpar@10
   613
    template <typename Number>
alpar@10
   614
    Number real(Number b) { 
alpar@10
   615
      return real<Number>() * b; 
alpar@10
   616
    }
alpar@10
   617
alpar@10
   618
    /// \brief Returns a random real number from the range [a, b)
alpar@10
   619
    ///
alpar@10
   620
    /// It returns a random real number from the range [a, b).
alpar@10
   621
    template <typename Number>
alpar@10
   622
    Number real(Number a, Number b) { 
alpar@10
   623
      return real<Number>() * (b - a) + a; 
alpar@10
   624
    }
alpar@10
   625
alpar@10
   626
    /// \brief Returns a random real number from the range [0, 1)
alpar@10
   627
    ///
alpar@10
   628
    /// It returns a random double from the range [0, 1).
alpar@10
   629
    double operator()() {
alpar@10
   630
      return real<double>();
alpar@10
   631
    }
alpar@10
   632
alpar@10
   633
    /// \brief Returns a random real number from the range [0, b)
alpar@10
   634
    ///
alpar@10
   635
    /// It returns a random real number from the range [0, b).
alpar@10
   636
    template <typename Number>
alpar@10
   637
    Number operator()(Number b) { 
alpar@10
   638
      return real<Number>() * b; 
alpar@10
   639
    }
alpar@10
   640
alpar@10
   641
    /// \brief Returns a random real number from the range [a, b)
alpar@10
   642
    ///
alpar@10
   643
    /// It returns a random real number from the range [a, b).
alpar@10
   644
    template <typename Number>
alpar@10
   645
    Number operator()(Number a, Number b) { 
alpar@10
   646
      return real<Number>() * (b - a) + a; 
alpar@10
   647
    }
alpar@10
   648
alpar@10
   649
    /// \brief Returns a random integer from a range
alpar@10
   650
    ///
alpar@10
   651
    /// It returns a random integer from the range {0, 1, ..., b - 1}.
alpar@10
   652
    template <typename Number>
alpar@10
   653
    Number integer(Number b) {
alpar@10
   654
      return _random_bits::Mapping<Number, Word>::map(core, b);
alpar@10
   655
    }
alpar@10
   656
alpar@10
   657
    /// \brief Returns a random integer from a range
alpar@10
   658
    ///
alpar@10
   659
    /// It returns a random integer from the range {a, a + 1, ..., b - 1}.
alpar@10
   660
    template <typename Number>
alpar@10
   661
    Number integer(Number a, Number b) {
alpar@10
   662
      return _random_bits::Mapping<Number, Word>::map(core, b - a) + a;
alpar@10
   663
    }
alpar@10
   664
alpar@10
   665
    /// \brief Returns a random integer from a range
alpar@10
   666
    ///
alpar@10
   667
    /// It returns a random integer from the range {0, 1, ..., b - 1}.
alpar@10
   668
    template <typename Number>
alpar@10
   669
    Number operator[](Number b) {
alpar@10
   670
      return _random_bits::Mapping<Number, Word>::map(core, b);
alpar@10
   671
    }
alpar@10
   672
alpar@10
   673
    /// \brief Returns a random non-negative integer
alpar@10
   674
    ///
alpar@10
   675
    /// It returns a random non-negative integer uniformly from the
kpeter@49
   676
    /// whole range of the current \c Number type. The default result
kpeter@49
   677
    /// type of this function is <tt>unsigned int</tt>.
alpar@10
   678
    template <typename Number>
alpar@10
   679
    Number uinteger() {
alpar@10
   680
      return _random_bits::IntConversion<Number, Word>::convert(core);
alpar@10
   681
    }
alpar@10
   682
alpar@10
   683
    unsigned int uinteger() {
alpar@10
   684
      return uinteger<unsigned int>();
alpar@10
   685
    }
alpar@10
   686
alpar@10
   687
    /// \brief Returns a random integer
alpar@10
   688
    ///
alpar@10
   689
    /// It returns a random integer uniformly from the whole range of
alpar@10
   690
    /// the current \c Number type. The default result type of this
kpeter@49
   691
    /// function is \c int.
alpar@10
   692
    template <typename Number>
alpar@10
   693
    Number integer() {
alpar@10
   694
      static const int nb = std::numeric_limits<Number>::digits + 
alpar@10
   695
        (std::numeric_limits<Number>::is_signed ? 1 : 0);
alpar@10
   696
      return _random_bits::IntConversion<Number, Word, nb>::convert(core);
alpar@10
   697
    }
alpar@10
   698
alpar@10
   699
    int integer() {
alpar@10
   700
      return integer<int>();
alpar@10
   701
    }
alpar@10
   702
    
alpar@10
   703
    /// \brief Returns a random bool
alpar@10
   704
    ///
alpar@10
   705
    /// It returns a random bool. The generator holds a buffer for
alpar@10
   706
    /// random bits. Every time when it become empty the generator makes
alpar@10
   707
    /// a new random word and fill the buffer up.
alpar@10
   708
    bool boolean() {
alpar@10
   709
      return bool_producer.convert(core);
alpar@10
   710
    }
alpar@10
   711
kpeter@49
   712
    ///\name Non-uniform distributions
alpar@10
   713
    ///
alpar@10
   714
    
alpar@10
   715
    ///@{
alpar@10
   716
    
alpar@10
   717
    /// \brief Returns a random bool
alpar@10
   718
    ///
kpeter@23
   719
    /// It returns a random bool with given probability of true result.
alpar@10
   720
    bool boolean(double p) {
alpar@10
   721
      return operator()() < p;
alpar@10
   722
    }
alpar@10
   723
alpar@10
   724
    /// Standard Gauss distribution
alpar@10
   725
alpar@10
   726
    /// Standard Gauss distribution.
alpar@10
   727
    /// \note The Cartesian form of the Box-Muller
alpar@10
   728
    /// transformation is used to generate a random normal distribution.
alpar@10
   729
    /// \todo Consider using the "ziggurat" method instead.
alpar@10
   730
    double gauss() 
alpar@10
   731
    {
alpar@10
   732
      double V1,V2,S;
alpar@10
   733
      do {
alpar@10
   734
	V1=2*real<double>()-1;
alpar@10
   735
	V2=2*real<double>()-1;
alpar@10
   736
	S=V1*V1+V2*V2;
alpar@10
   737
      } while(S>=1);
alpar@10
   738
      return std::sqrt(-2*std::log(S)/S)*V1;
alpar@10
   739
    }
alpar@10
   740
    /// Gauss distribution with given mean and standard deviation
alpar@10
   741
kpeter@23
   742
    /// Gauss distribution with given mean and standard deviation.
alpar@10
   743
    /// \sa gauss()
alpar@10
   744
    double gauss(double mean,double std_dev)
alpar@10
   745
    {
alpar@10
   746
      return gauss()*std_dev+mean;
alpar@10
   747
    }
alpar@10
   748
alpar@10
   749
    /// Exponential distribution with given mean
alpar@10
   750
alpar@10
   751
    /// This function generates an exponential distribution random number
alpar@10
   752
    /// with mean <tt>1/lambda</tt>.
alpar@10
   753
    ///
alpar@10
   754
    double exponential(double lambda=1.0)
alpar@10
   755
    {
alpar@11
   756
      return -std::log(1.0-real<double>())/lambda;
alpar@10
   757
    }
alpar@10
   758
alpar@10
   759
    /// Gamma distribution with given integer shape
alpar@10
   760
alpar@10
   761
    /// This function generates a gamma distribution random number.
alpar@10
   762
    /// 
alpar@10
   763
    ///\param k shape parameter (<tt>k>0</tt> integer)
alpar@10
   764
    double gamma(int k) 
alpar@10
   765
    {
alpar@10
   766
      double s = 0;
alpar@10
   767
      for(int i=0;i<k;i++) s-=std::log(1.0-real<double>());
alpar@10
   768
      return s;
alpar@10
   769
    }
alpar@10
   770
    
alpar@10
   771
    /// Gamma distribution with given shape and scale parameter
alpar@10
   772
alpar@10
   773
    /// This function generates a gamma distribution random number.
alpar@10
   774
    /// 
alpar@10
   775
    ///\param k shape parameter (<tt>k>0</tt>)
alpar@10
   776
    ///\param theta scale parameter
alpar@10
   777
    ///
alpar@10
   778
    double gamma(double k,double theta=1.0)
alpar@10
   779
    {
alpar@10
   780
      double xi,nu;
alpar@10
   781
      const double delta = k-std::floor(k);
alpar@68
   782
      const double v0=E/(E-delta);
alpar@10
   783
      do {
alpar@10
   784
	double V0=1.0-real<double>();
alpar@10
   785
	double V1=1.0-real<double>();
alpar@10
   786
	double V2=1.0-real<double>();
alpar@10
   787
	if(V2<=v0) 
alpar@10
   788
	  {
alpar@10
   789
	    xi=std::pow(V1,1.0/delta);
alpar@10
   790
	    nu=V0*std::pow(xi,delta-1.0);
alpar@10
   791
	  }
alpar@10
   792
	else 
alpar@10
   793
	  {
alpar@10
   794
	    xi=1.0-std::log(V1);
alpar@10
   795
	    nu=V0*std::exp(-xi);
alpar@10
   796
	  }
alpar@10
   797
      } while(nu>std::pow(xi,delta-1.0)*std::exp(-xi));
alpar@116
   798
      return theta*(xi+gamma(int(std::floor(k))));
alpar@10
   799
    }
alpar@10
   800
    
alpar@11
   801
    /// Weibull distribution
alpar@11
   802
alpar@11
   803
    /// This function generates a Weibull distribution random number.
alpar@11
   804
    /// 
alpar@11
   805
    ///\param k shape parameter (<tt>k>0</tt>)
alpar@11
   806
    ///\param lambda scale parameter (<tt>lambda>0</tt>)
alpar@11
   807
    ///
alpar@11
   808
    double weibull(double k,double lambda)
alpar@11
   809
    {
alpar@11
   810
      return lambda*pow(-std::log(1.0-real<double>()),1.0/k);
alpar@11
   811
    }  
alpar@11
   812
      
alpar@11
   813
    /// Pareto distribution
alpar@11
   814
alpar@11
   815
    /// This function generates a Pareto distribution random number.
alpar@11
   816
    /// 
alpar@12
   817
    ///\param k shape parameter (<tt>k>0</tt>)
alpar@11
   818
    ///\param x_min location parameter (<tt>x_min>0</tt>)
alpar@11
   819
    ///
alpar@12
   820
    double pareto(double k,double x_min)
alpar@11
   821
    {
alpar@116
   822
      return exponential(gamma(k,1.0/x_min))+x_min;
alpar@11
   823
    }  
alpar@10
   824
      
alpar@92
   825
    /// Poisson distribution
alpar@92
   826
alpar@92
   827
    /// This function generates a Poisson distribution random number with
alpar@92
   828
    /// parameter \c lambda.
alpar@92
   829
    /// 
alpar@92
   830
    /// The probability mass function of this distribusion is
alpar@92
   831
    /// \f[ \frac{e^{-\lambda}\lambda^k}{k!} \f]
alpar@92
   832
    /// \note The algorithm is taken from the book of Donald E. Knuth titled
alpar@92
   833
    /// ''Seminumerical Algorithms'' (1969). Its running time is linear in the
alpar@92
   834
    /// return value.
alpar@92
   835
    
alpar@92
   836
    int poisson(double lambda)
alpar@92
   837
    {
alpar@92
   838
      const double l = std::exp(-lambda);
alpar@92
   839
      int k=0;
alpar@92
   840
      double p = 1.0;
alpar@92
   841
      do {
alpar@92
   842
	k++;
alpar@92
   843
	p*=real<double>();
alpar@92
   844
      } while (p>=l);
alpar@92
   845
      return k-1;
alpar@92
   846
    }  
alpar@92
   847
      
alpar@10
   848
    ///@}
alpar@10
   849
    
alpar@10
   850
    ///\name Two dimensional distributions
alpar@10
   851
    ///
alpar@10
   852
alpar@10
   853
    ///@{
alpar@10
   854
    
kpeter@23
   855
    /// Uniform distribution on the full unit circle
kpeter@16
   856
kpeter@16
   857
    /// Uniform distribution on the full unit circle.
kpeter@16
   858
    ///
alpar@10
   859
    dim2::Point<double> disc() 
alpar@10
   860
    {
alpar@10
   861
      double V1,V2;
alpar@10
   862
      do {
alpar@10
   863
	V1=2*real<double>()-1;
alpar@10
   864
	V2=2*real<double>()-1;
alpar@10
   865
	
alpar@10
   866
      } while(V1*V1+V2*V2>=1);
alpar@10
   867
      return dim2::Point<double>(V1,V2);
alpar@10
   868
    }
alpar@10
   869
    /// A kind of two dimensional Gauss distribution
alpar@10
   870
alpar@10
   871
    /// This function provides a turning symmetric two-dimensional distribution.
alpar@10
   872
    /// Both coordinates are of standard normal distribution, but they are not
alpar@10
   873
    /// independent.
alpar@10
   874
    ///
alpar@10
   875
    /// \note The coordinates are the two random variables provided by
alpar@10
   876
    /// the Box-Muller method.
alpar@10
   877
    dim2::Point<double> gauss2()
alpar@10
   878
    {
alpar@10
   879
      double V1,V2,S;
alpar@10
   880
      do {
alpar@10
   881
	V1=2*real<double>()-1;
alpar@10
   882
	V2=2*real<double>()-1;
alpar@10
   883
	S=V1*V1+V2*V2;
alpar@10
   884
      } while(S>=1);
alpar@10
   885
      double W=std::sqrt(-2*std::log(S)/S);
alpar@10
   886
      return dim2::Point<double>(W*V1,W*V2);
alpar@10
   887
    }
alpar@10
   888
    /// A kind of two dimensional exponential distribution
alpar@10
   889
alpar@10
   890
    /// This function provides a turning symmetric two-dimensional distribution.
alpar@10
   891
    /// The x-coordinate is of conditionally exponential distribution
alpar@10
   892
    /// with the condition that x is positive and y=0. If x is negative and 
alpar@10
   893
    /// y=0 then, -x is of exponential distribution. The same is true for the
alpar@10
   894
    /// y-coordinate.
alpar@10
   895
    dim2::Point<double> exponential2() 
alpar@10
   896
    {
alpar@10
   897
      double V1,V2,S;
alpar@10
   898
      do {
alpar@10
   899
	V1=2*real<double>()-1;
alpar@10
   900
	V2=2*real<double>()-1;
alpar@10
   901
	S=V1*V1+V2*V2;
alpar@10
   902
      } while(S>=1);
alpar@10
   903
      double W=-std::log(S)/S;
alpar@10
   904
      return dim2::Point<double>(W*V1,W*V2);
alpar@10
   905
    }
alpar@10
   906
alpar@10
   907
    ///@}    
alpar@10
   908
  };
alpar@10
   909
alpar@10
   910
alpar@10
   911
  extern Random rnd;
alpar@10
   912
alpar@10
   913
}
alpar@10
   914
alpar@10
   915
#endif