deploy: 62ca18e

bitgenerators/Bitgen/SeedSequence/index.html

@@ -3,7 +3,7 @@
 let ss = SeedSequence.initialize []
 SeedSequence.entropy ss |> List.map Uint128.to_string
 (*: string list = [&quot;152280350332430215596244075920305924447&quot;] *)</code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p><code>t</code> is the type of a SeedSequence</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-initialize"><a href="#val-initialize" class="anchor"></a><code><span><span class="keyword">val</span> initialize : 
-  <span><span class="optlabel">?spawn_key</span>:<span>int list</span> <span class="arrow">&#45;&gt;</span></span>
+  <span><span class="optlabel">?spawn_key</span>:<span><span class="xref-unresolved">Stdint</span>.uint128 list</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?pool_size</span>:int <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="xref-unresolved">Stdint</span>.uint128 list</span> <span class="arrow">&#45;&gt;</span></span>
   <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>initialize seed</code> Creates a new seed sequence type given a list of unsigned 128-bit integers <code>seed</code>. <code>~spawn_key</code> is an additional source of entropy based on the position of type in the tree of such types created with <a href="#val-spawn"><code>SeedSequence.spawn</code></a>. Typically users need not set this parameter. <code>~pool_size</code> is the size of the pooled entropy to store. It defaults to the value 4 to give a 128-bit entropy pool.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate_32bit_state"><a href="#val-generate_32bit_state" class="anchor"></a><code><span><span class="keyword">val</span> generate_32bit_state : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Stdint</span>.uint32 array</span></span></code></div><div class="spec-doc"><p><code>generate_32bit_state n t</code> returns an array of <code>n</code> unsigned 32-bit integers for seeding a PRNG and generating it's initial 32-bit state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate_64bit_state"><a href="#val-generate_64bit_state" class="anchor"></a><code><span><span class="keyword">val</span> generate_64bit_state : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Stdint</span>.uint64 array</span></span></code></div><div class="spec-doc"><p><code>generate_64bit_state n t</code> returns an array of <code>n</code> unsigned 64-bit integers for seeding a PRNG and generating it's initial state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-spawn"><a href="#val-spawn" class="anchor"></a><code><span><span class="keyword">val</span> spawn : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> list</span> * <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>spawn n t</code> creates <code>n</code> independent child types of <code>t</code> that can be used to initialize <code>n</code> bitgenerator instances.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-children_spawned"><a href="#val-children_spawned" class="anchor"></a><code><span><span class="keyword">val</span> children_spawned : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>The number of children already spawned by this instance of a SeedSequence type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-entropy"><a href="#val-entropy" class="anchor"></a><code><span><span class="keyword">val</span> entropy : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Stdint</span>.uint128 list</span></span></code></div><div class="spec-doc"><p><code>entropy t</code> gives a list representing the entropy used to create <code>t</code>. It can be used as an argument of <a href="#val-initialize"><code>SeedSequence.initialize</code></a> to reproduce the the bit stream of <code>t</code>.</p></div></div></div></body></html>