[Rust]疑似乱数生成ライブラリrand_simpleを公開しました

はじめに

最近Rustの勉強を始めました。
先達の言語で見つかった痒い所に手が届く便利な仕様で、書いていて楽しい言語だと思います。
後、無限ループ脱出時のreturnでその後に続かないと指摘してくれる等、コンパイラがとても賢くて驚きました。

学習結果を定着させるにはアウトプットをするのが一番です。
今回の記事では、私が作成したRustのライブラリを紹介します。

追記

• 2023/5/1: 確率分布乱数が目次で分かるように、章・節を格上げしました。
• 2023/5/2: READMEを修正しました。
  • 一様分布乱数インスタンス生成マクロを追加したため。

README

このライブラリは、疑似乱数を簡単に生成できるライブラリです。

例えば、use rand_simple::Uniform;と宣言するだけで、一様分布乱数の構造体を使えるようになります。

偉大な先達randと比較して、簡素なモジュール宣言と豊富な確率変数による使いやすさを目指しています。

実装する疑似乱数

計算機シミュレーションのための確率分布乱数生成法/著者　四辻 哲章/プレアデス出版に掲載されている確率分布乱数を実装していきます。

掲載されている46種類の確率分布と、その基礎である一様分布・ベルヌーイ分布を実装していきます。

基本的なアルゴリズムはXorshiftです。

Xorshiftはたった4つの状態変数から周期 $2^{128} - 1$ の乱数計算を行うことができます。

0.001秒ごとに乱数を生成したとしても、ループが完了するまで$10^{28}$年かかるそうなので、
ちょっとした乱数生成の範疇ではこれで十分だと考えています。

使用例

一様分布

new関数

use rand_simple::Uniform;
let uniform = Uniform::new(1192u32);
let next = uniform.sample(); // 閉区間[0, 1]の一様乱数
println!("乱数: {}", next); // 0.8698977918526851f64

マクロ・引数有り

use rand_simple::create_uniform;
let uniform = create_uniform!(1192u32);
let next = uniform.sample(); // 閉区間[0, 1]の一様乱数
println!("乱数: {}", next); // 0.8698977918526851f64

マクロ・引数無し

use rand_simple::create_uniform;
let uniform = create_uniform!();
let next = uniform.sample(); // 閉区間[0, 1]の一様乱数
println!("乱数: {}", next); // 値不明

正規分布

use rand_simple::Normal;
let normal = Normal::new(1192u32, 765u32);
let next = normal.sample(); // 平均値 0, 標準偏差 1 の標準正規分布
println!("乱数: {}", next); // -1.2296205447119757

半正規分布

use rand_simple::HalfNormal;
let half_normal = HalfNormal::new(1192u32, 765u32);
let next = half_normal.sample(); // 標準偏差 1 の標準半正規分布
println!("乱数: {}", next); // 2.5308912695634582

ベルヌーイ分布

use rand_simple::Bernoulli;
let bernoulli = Bernoulli::new(1192u32);
let next = bernoulli.sample(0.5f64); // 発生確率 0.5の事象が生じたか(1)、否か(0)
println!("乱数: {}", next); // 0u32

幾何分布

use rand_simple::Geometric;
let geometric = Geometric::new(1192u32);
let next = geometric.sample(0.5f64); // 発生確率 0.5の事象が初めて生じるまでの試行回数
println!("乱数: {}", next); // 4u32

外部ライブラリからの独立

使い勝手を考慮して、外部ライブラリに依存しないライブラリを目指しています。

use std::time::SystemTime::now();で現在時刻を呼べることを知りました。
順次、宣言的マクロを用いた時刻による初期化を組み込んでいきたいと思います。
そして、デフォルトの時刻取得ライブラリが無いとのことで、よくある時刻による乱数の初期化はありません。