[Rust] メルセンヌ・ツイスターのアルゴリズム

そういえばメルセンヌ・ツイスターの仕組みを理解してない, とふと思ったので連休にオリジナルコード `mt19937ar.c` (C言語, 修正BSDライセンス) を読んで勉強しました. これはそれを Rust に移植した勉強ノートです.

# struct の定義

MT の内部状態は `N = 624` 個の `u32` です. それに加えて乱数生成時にどの要素までを使ったかを記録するためにひとつのインデックス `mti: usize` を持っておく必要があります. 

```rust
const N: usize = 624;

#[derive(Debug, Clone)]
pub struct MT {
    state: Vec<u32>,
    mti: usize,
}
```

# 初期化

`mt19937ar.c` に従って初期化するようにしますが, この部分はメルセンヌ・ツイスタのアルゴリズムという訳ではないです. MT を初期化するにはシード値としてひとつの `u32` (または `[u8;4]`) を与え, 適当な乱数生成漸化式を解くことで `Vec<u32>` を作ります. 

```rust
use rand::SeedableRng;

impl SeedableRng for MT {
    type Seed = [u8; 4];

    fn from_seed(seed: Self::Seed) -> Self {
        let state = (0..N).scan(
            u32::from_ne_bytes(seed),
            |x, mti| {
                let s = *x;
                *x = 1812433253u32.wrapping_mul(*x ^ (*x >> 30)).wrapping_add(mti as u32 + 1);
                Some(s)
            }
        ).collect::<Vec<_>>();

        MT { state, mti: N }
    }
}
```

# 内部状態の更新

この部分が本題です. 内部状態 `Vec<u32>` の離れた要素を使って新しい要素を計算するので, イテレータを使ってスマートに書くのは無理そうです. 剰余を使ってシンプルにまとめましたが, オリジナルの C コードのように `for` ループを分割して剰余が出ないように書いた方が速度面で有利だと思います.

```rust
const M: usize = 397;
const MATRIX_A: [u32; 2] = [0, 0x9908b0df];
const UPPER_MASK: u32 = 0x80000000;
const LOWER_MASK: u32 = 0x7fffffff;

impl MT {
    pub fn update(&mut self) {
        self.mti = 0;

        for k in 0..N {
            let y = (self.state[k] & UPPER_MASK)|(self.state[(k+1)%N] & LOWER_MASK);
            self.state[k] = self.state[(k+M)%N] ^ (y >> 1) ^ MATRIX_A[y as usize & 1];
        }
    }
}
```

# 乱数の生成

乱数の値を返す際には, 内部状態の要素をそのまま出すのではなく, tempering と呼ばれる変換をします.

```rust
use rand::RngCore;
use rand_core::impls;

impl RngCore for MT {
    fn next_u32(&mut self) -> u32 {
        // 内部状態を使い切ったら更新する
        if self.mti == N { self.update(); }

        let mut y = self.state[self.mti];
        self.mti += 1;

        // tempering
        y ^= y >> 11;
        y ^= (y << 7) & 0x9D2C5680;
        y ^= (y << 15) & 0xEFC60000;
        y ^= y >> 18;

        y
    }

    fn next_u64(&mut self) -> u64 {
        impls::next_u64_via_u32(self)
    }
    fn fill_bytes(&mut self, dest: &mut [u8]) {
        impls::fill_bytes_via_next(self, dest)
    }
    fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), rand::Error> {
        Ok(self.fill_bytes(dest))
    }
}
```

# 使ってみる

```rust
#[cfg(test)]
mod tests {
    use crate::MT;
    use rand::{Rng, SeedableRng};

    #[test]
    fn it_works() {
        let seed: u32 = 5489;
        let mut rng = MT::from_seed(seed.to_ne_bytes());

        for _ in 0..8 {
            println!("{:10}", rng.gen::<u32>());
        }
    }
}
```

# 参考文献
* [Mersenne Twister Home Page](http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/mt.html)

# ライセンス表記

メルセンヌ・ツイスタのオリジナルコードは (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura によるもので, 修正BSDライセンスのもとで配布されています. 本記事のコードはそれを Rust へ移植したものです. 移植に関する著作権は [CC0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) としますが, 本記事のコードを利用する場合は原作者の修正BSDライセンスに留意してください.

<details><summary>ライセンス原文</summary>
<div>/* 
   Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
   All rights reserved.                          

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

     1. Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

     2. 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.

     3. The names of its contributors may not 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 OWNER 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.
*/</div>
</details>