ランダム

ランダム数を生成するためのサポート。rand、randn、AbstractRNG、MersenneTwister、およびRandomDeviceを提供します。

rand([rng=default_rng()], [S], [dims...])

指定された値の集合 S からランダムな要素またはランダムな要素の配列を選択します。S は以下のいずれかであることができます。

• インデックス可能なコレクション（例えば 1:9 や ('x', "y", :z)）

• AbstractDict または AbstractSet オブジェクト

• 文字列（文字のコレクションと見なされる）、または

• 指定された値の集合に対応する以下のリストからの型

  • 具体的な整数型は typemin(S):typemax(S) からサンプリングします（BigInt はサポートされていません）
  • 具体的な浮動小数点型は [0, 1) からサンプリングします
  • 具体的な複素数型 Complex{T} は、T がサンプリング可能な型であれば、実部と虚部をそれぞれ T に対応する値の集合から独立して取得しますが、T がサンプリング不可能な場合はサポートされません。
  • すべての <:AbstractChar 型は有効なUnicodeスカラーの集合からサンプリングします
  • ユーザー定義型と値の集合; 実装ガイダンスについては Hooking into the Random API を参照してください
  • 知られたサイズのタプル型で、S の各パラメータがサンプリング可能な型である場合; 型 S の値を返します。Tuple{Vararg{T}}（サイズ不明）や Tuple{1:2}（値でパラメータ化された）などのタプル型はサポートされていないことに注意してください
  • Pair 型、例えば Pair{X, Y} で、rand が X と Y に対して定義されている場合、ランダムなペアが生成されます。

S のデフォルトは Float64 です。オプションの rng 以外に1つの引数が渡され、かつそれが Tuple の場合、それは値のコレクション（S）として解釈され、dims とは見なされません。

通常分布の数値については randn を、インプレースの同等物については rand! および randn! を参照してください。

例

julia> rand(Int, 2)
2-element Array{Int64,1}:
 1339893410598768192
 1575814717733606317

julia> using Random

julia> rand(Xoshiro(0), Dict(1=>2, 3=>4))
3 => 4

julia> rand((2, 3))
3

julia> rand(Float64, (2, 3))
2×3 Array{Float64,2}:
 0.999717  0.0143835  0.540787
 0.696556  0.783855   0.938235

rand!([rng=default_rng()], A, [S=eltype(A)])

配列 A をランダムな値で埋めます。S が指定されている場合（S は型またはコレクションであり、詳細は rand を参照）、値は S からランダムに選ばれます。これは copyto!(A, rand(rng, S, size(A))) と同等ですが、新しい配列を割り当てることはありません。

例

julia> rand!(Xoshiro(123), zeros(5))
5-element Vector{Float64}:
 0.521213795535383
 0.5868067574533484
 0.8908786980927811
 0.19090669902576285
 0.5256623915420473

bitrand([rng=default_rng()], [dims...])

ランダムなブール値の BitArray を生成します。

例

julia> bitrand(Xoshiro(123), 10)
10-element BitVector:
 0
 1
 0
 1
 0
 1
 0
 0
 1
 1

randn([rng=default_rng()], [T=Float64], [dims...])

平均0、標準偏差1の正規分布に従う型Tの乱数を生成します。オプションのdims引数を指定すると、そのサイズの配列を生成します。Juliaの標準ライブラリは、randを実装している任意の浮動小数点型に対してrandnをサポートしています。例えば、Base型のFloat16、Float32、Float64（デフォルト）、およびBigFloatと、それらのComplex対応型です。

（Tが複素数の場合、値は分散1の円対称複素正規分布から引き出され、実部と虚部は平均0、分散1/2の独立した正規分布を持ちます）。

インプレースで動作するrandn!も参照してください。

例

単一の乱数を生成する（デフォルトのFloat64型を使用）：

julia> randn()
-0.942481877315864

正規乱数の行列を生成する（デフォルトのFloat64型を使用）：

julia> randn(2,3)
2×3 Matrix{Float64}:
  1.18786   -0.678616   1.49463
 -0.342792  -0.134299  -1.45005

ユーザー定義のシードで乱数生成器rngを設定し（再現可能な数値のため）、それを使用して乱数Float32またはComplexF32の乱数行列を生成する：

julia> using Random

julia> rng = Xoshiro(123);

julia> randn(rng, Float32)
-0.6457307f0

julia> randn(rng, ComplexF32, (2, 3))
2×3 Matrix{ComplexF32}:
  -1.03467-1.14806im  0.693657+0.056538im   0.291442+0.419454im
 -0.153912+0.34807im    1.0954-0.948661im  -0.543347-0.0538589im

randn!([rng=default_rng()], A::AbstractArray) -> A

配列 A を平均 0、標準偏差 1 の正規分布に従うランダムな数値で埋めます。 rand 関数も参照してください。

例

julia> randn!(Xoshiro(123), zeros(5))
5-element Vector{Float64}:
 -0.6457306721039767
 -1.4632513788889214
 -1.6236037455860806
 -0.21766510678354617
  0.4922456865251828

randexp([rng=default_rng()], [T=Float64], [dims...])

スケール1の指数分布に従って、型 T のランダムな数を生成します。オプションで、そのようなランダムな数の配列を生成します。Base モジュールは現在、Float16、Float32、および Float64（デフォルト）の型に対する実装を提供しています。

例

julia> rng = Xoshiro(123);

julia> randexp(rng, Float32)
1.1757717f0

julia> randexp(rng, 3, 3)
3×3 Matrix{Float64}:
 1.37766  0.456653  0.236418
 3.40007  0.229917  0.0684921
 0.48096  0.577481  0.71835

randexp!([rng=default_rng()], A::AbstractArray) -> A

配列 A をスケール1の指数分布に従うランダムな数値で埋めます。

例

julia> randexp!(Xoshiro(123), zeros(5))
5-element Vector{Float64}:
 1.1757716836348473
 1.758884569451514
 1.0083623637301151
 0.3510644315565272
 0.6348266443720407

randstring([rng=default_rng()], [chars], [len=8])

長さ len のランダムな文字列を作成します。文字列は chars の文字から構成され、デフォルトでは大文字と小文字のアルファベットおよび数字 0-9 のセットになります。オプションの rng 引数は乱数生成器を指定します。詳細は Random Numbers を参照してください。

例

julia> Random.seed!(3); randstring()
"Lxz5hUwn"

julia> randstring(Xoshiro(3), 'a':'z', 6)
"iyzcsm"

julia> randstring("ACGT")
"TGCTCCTC"

randsubseq([rng=default_rng(),] A, p) -> Vector

与えられた配列 A のランダム部分列からなるベクターを返します。A の各要素は、独立した確率 p で（順序を保ったまま）含まれます。（複雑さは p*length(A) に対して線形であるため、この関数は p が小さく A が大きい場合でも効率的です。）技術的には、このプロセスは A の「ベルヌーイサンプリング」として知られています。

例

julia> randsubseq(Xoshiro(123), 1:8, 0.3)
2-element Vector{Int64}:
 4
 7

randsubseq!([rng=default_rng(),] S, A, p)

randsubseqと同様ですが、結果はSに格納されます（必要に応じてサイズが変更されます）。

例

julia> S = Int64[];

julia> randsubseq!(Xoshiro(123), S, 1:8, 0.3)
2-element Vector{Int64}:
 4
 7

julia> S
2-element Vector{Int64}:
 4
 7

randperm([rng=default_rng(),] n::Integer)

長さ n のランダムな順列を構築します。オプションの rng 引数は乱数生成器を指定します（乱数を参照）。結果の要素型は n の型と同じです。

任意のベクトルをランダムに並べ替えるには、shuffle または shuffle! を参照してください。

例

julia> randperm(Xoshiro(123), 4)
4-element Vector{Int64}:
 1
 4
 2
 3

randperm!([rng=default_rng(),] A::Array{<:Integer})

Aの中に長さlength(A)のランダムな順列を構築します。オプションのrng引数は乱数生成器を指定します（乱数を参照）。任意のベクトルをランダムに順列するには、shuffleまたはshuffle!を参照してください。

例

julia> randperm!(Xoshiro(123), Vector{Int}(undef, 4))
4-element Vector{Int64}:
 1
 4
 2
 3

randcycle([rng=default_rng(),] n::Integer)

長さ n のランダムな循環置換を構築します。オプションの rng 引数は乱数生成器を指定します。詳細は Random Numbers を参照してください。結果の要素型は n の型と同じです。

ここで「循環置換」とは、すべての要素が単一のサイクル内にあることを意味します。n > 0 の場合、可能な循環置換は $(n-1)!$ 個あり、均等にサンプリングされます。n == 0 の場合、randcycle は空のベクターを返します。

randcycle! はこの関数のインプレースバリアントです。

例

julia> randcycle(Xoshiro(123), 6)
6-element Vector{Int64}:
 5
 4
 2
 6
 3
 1

randcycle!([rng=default_rng(),] A::Array{<:Integer})

Aに長さn = length(A)のランダムな循環置換を構築します。オプションのrng引数は乱数生成器を指定します。詳細はRandom Numbersを参照してください。

ここで「循環置換」とは、すべての要素が単一のサイクル内にあることを意味します。Aが空でない場合（n > 0）、可能な循環置換は$(n-1)!$個あり、これらは均等にサンプリングされます。Aが空の場合、randcycle!はそれを変更しません。

randcycleは、新しいベクトルを割り当てるこの関数のバリアントです。

例

julia> randcycle!(Xoshiro(123), Vector{Int}(undef, 6))
6-element Vector{Int64}:
 5
 4
 2
 6
 3
 1

shuffle([rng=default_rng(),] v::AbstractArray)

vのランダムに順序を入れ替えたコピーを返します。オプションのrng引数は乱数生成器を指定します（乱数を参照）。vをインプレースで順序を入れ替えるには、shuffle!を参照してください。ランダムに順序を入れ替えたインデックスを取得するには、randpermを参照してください。

例

julia> shuffle(Xoshiro(123), Vector(1:10))
10-element Vector{Int64}:
  5
  4
  2
  3
  6
 10
  8
  1
  9
  7

shuffle!([rng=default_rng(),] v::AbstractArray)

shuffle のインプレースバージョン：v をインプレースでランダムに順序を入れ替え、オプションで乱数生成器 rng を指定します。

例

julia> shuffle!(Xoshiro(123), Vector(1:10))
10-element Vector{Int64}:
  5
  4
  2
  3
  6
 10
  8
  1
  9
  7

Random.default_rng() -> rng

デフォルトのグローバル乱数生成器 (RNG) を返します。これは、明示的な RNG が提供されていない場合に rand 関連の関数によって使用されます。

Random モジュールがロードされると、デフォルトの RNG は ランダムに シードされます。これは Random.seed!() を介して行われます。つまり、新しい Julia セッションが開始されるたびに、最初の rand() の呼び出しは異なる結果を生成します。最初に seed!(seed) が呼ばれない限りです。

これはスレッドセーフです：異なるスレッドは安全に default_rng() に対して rand 関連の関数を同時に呼び出すことができます。例えば、rand(default_rng()) のようにです。

seed!([rng=default_rng()], seed) -> rng
seed!([rng=default_rng()]) -> rng

乱数生成器を再シードします：rngは、seedが提供される場合に限り、再現可能な数列を生成します。一部のRNGはシードを受け付けません（例：RandomDevice）。seed!の呼び出し後、rngは同じシードで初期化された新しく作成されたオブジェクトと同等になります。受け入れられるシードの型はrngの型によって異なりますが、一般的に整数シードは機能するはずです。

rngが指定されていない場合、共有タスクローカルジェネレーターの状態をシードすることがデフォルトとなります。

例

julia> Random.seed!(1234);

julia> x1 = rand(2)
2-element Vector{Float64}:
 0.32597672886359486
 0.5490511363155669

julia> Random.seed!(1234);

julia> x2 = rand(2)
2-element Vector{Float64}:
 0.32597672886359486
 0.5490511363155669

julia> x1 == x2
true

julia> rng = Xoshiro(1234); rand(rng, 2) == x1
true

julia> Xoshiro(1) == Random.seed!(rng, 1)
true

julia> rand(Random.seed!(rng), Bool) # 再現性なし
true

julia> rand(Random.seed!(rng), Bool) # 再現性なし
false

julia> rand(Xoshiro(), Bool) # 再現性なし
true

AbstractRNG

MersenneTwisterやRandomDeviceなどの乱数生成器のスーパークラスです。

TaskLocalRNG

TaskLocalRNGは、そのスレッドではなくタスクにローカルな状態を持っています。これはタスクの作成時に親タスクの状態からシードされますが、親のRNGの状態を進めることはありません。

利点として、TaskLocalRNGは非常に高速で、スケジューラの決定に依存せず、レースコンディションを除けば再現可能なマルチスレッドシミュレーションを許可します。タスクの作成にスレッド数が使用されない限り、シミュレーション結果は利用可能なスレッド/CPUの数にも依存しません。ランダムストリームは、エンディアンやおそらくワードサイズを除いて、ハードウェアの特性に依存するべきではありません。

current_task()によって返されるタスク以外のタスクのRNGを使用したりシードしたりすることは未定義の動作です：ほとんどの場合は機能しますが、時には静かに失敗することがあります。

TaskLocalRNG()をseed!でシードする際に渡されるシードは、あれば任意の整数であることができます。

Xoshiro(seed::Union{Integer, AbstractString})
Xoshiro()

Xoshiro256++は、David BlackmanとSebastiano Vignaによって「Scrambled Linear Pseudorandom Number Generators」で説明された高速擬似乱数生成器です。参照実装は https://prng.di.unimi.it で入手可能です。

高速度に加えて、Xoshiroは小さなメモリフットプリントを持ち、多くの異なる乱数状態を長時間保持する必要があるアプリケーションに適しています。

JuliaのXoshiro実装にはバルク生成モードがあり、親から新しい仮想PRNGをシードし、SIMDを使用して並列に生成します（つまり、バルクストリームは複数のインタリーブされたxoshiroインスタンスで構成されます）。仮想PRNGは、バルクリクエストが処理されると破棄され（ヒープアロケーションを引き起こすことはありません）、

シードが提供されない場合は、ランダムに生成されたものが作成されます（システムからのエントロピーを使用）。既存のXoshiroオブジェクトの再シードについては、seed!関数を参照してください。

例

julia> using Random

julia> rng = Xoshiro(1234);

julia> x1 = rand(rng, 2)
2-element Vector{Float64}:
 0.32597672886359486
 0.5490511363155669

julia> rng = Xoshiro(1234);

julia> x2 = rand(rng, 2)
2-element Vector{Float64}:
 0.32597672886359486
 0.5490511363155669

julia> x1 == x2
true

MersenneTwister(seed)
MersenneTwister()

MersenneTwister RNGオブジェクトを作成します。異なるRNGオブジェクトはそれぞれ独自のシードを持つことができ、異なるランダム数のストリームを生成するのに役立ちます。seedは整数、文字列、またはUInt32整数のベクターである可能性があります。シードが提供されない場合、ランダムに生成されたものが作成されます（システムからのエントロピーを使用）。既存のMersenneTwisterオブジェクトの再シードについては、seed!関数を参照してください。

例

julia> rng = MersenneTwister(123);

julia> x1 = rand(rng, 2)
2-element Vector{Float64}:
 0.37453777969575874
 0.8735343642013971

julia> x2 = rand(MersenneTwister(123), 2)
2-element Vector{Float64}:
 0.37453777969575874
 0.8735343642013971

julia> x1 == x2
true

RandomDevice()

RandomDevice RNGオブジェクトを作成します。このような2つのオブジェクトは常に異なるランダム数のストリームを生成します。エントロピーはオペレーティングシステムから取得されます。

Sampler(rng, x, repetition = Val(Inf))

rngからxのランダムな値を生成するために使用できるサンプラーオブジェクトを返します。

sp = Sampler(rng, x, repetition) のとき、rand(rng, sp) がランダムな値を引き出すために使用され、適切に定義されるべきです。

repetition は Val(1) または Val(Inf) であり、適用可能な場合の前計算の量を決定するための提案として使用されるべきです。

Random.SamplerType と Random.SamplerTrivial はそれぞれ 型 と 値 のデフォルトのフォールバックです。 Random.SamplerSimple は、この目的のためだけに追加の型を定義することなく、前計算された値を保存するために使用できます。

SamplerType{T}()

型のためのサンプラーで、他の情報は含まれていません。型で呼び出されたときのSamplerのデフォルトフォールバックです。

SamplerTrivial(x)

与えられた値 x を単にラップするサンプラーを作成します。これは値のデフォルトのフォールバックです。このサンプラーの eltype は eltype(x) と等しいです。

推奨される使用ケースは、事前に計算されたデータなしで値からサンプリングすることです。

SamplerSimple(x, data)

与えられた値 x と data をラップするサンプラーを作成します。このサンプラーの eltype は eltype(x) と等しくなります。

推奨される使用ケースは、事前に計算されたデータから値をサンプリングすることです。