/usr/share/doc/libghc-tf-random-doc/html/System-Random-TF-Gen.html is in libghc-tf-random-doc 0.5-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>System.Random.TF.Gen</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_System-Random-TF-Gen.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-Random-TF-Gen.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">tf-random-0.5: High-quality splittable pseudorandom number generator</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) 2012-2013 Michał Pałka</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>michal.palka@chalmers.se</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">System.Random.TF.Gen</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides the <code><a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></code> generator and the alternative <code><a href="System-Random-TF-Gen.html#t:RandomGen">RandomGen</a></code> class.
<code><a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></code> also implements the standard <code><a href="file:///usr/share/doc/libghc-random-doc/html/System-Random.html#v:RandomGen">RandomGen</a></code> class.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:TFGen">TFGen</a></li><li class="src short"><span class="keyword">class</span> <a href="#t:RandomGen">RandomGen</a> g <span class="keyword">where</span><ul class="subs"><li><a href="#v:next">next</a> :: g -> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word32">Word32</a>, g)</li><li><a href="#v:split">split</a> :: g -> (g, g)</li><li><a href="#v:splitn">splitn</a> :: g -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word32">Word32</a> -> g</li><li><a href="#v:level">level</a> :: g -> g</li></ul></li><li class="src short"><a href="#v:seedTFGen">seedTFGen</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>) -> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TFGen" class="def">TFGen</a> <a href="src/System-Random-TF-Gen.html#TFGen" class="link">Source</a></p><div class="doc"><p>The generator type</p></div><div class="subs instances"><p id="control.i:TFGen" class="caption collapser" onclick="toggleSection('i:TFGen')">Instances</p><div id="section.i:TFGen" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Read.html#t:Read">Read</a> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></span> <a href="src/System-Random-TF-Gen.html#line-110" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></span> <a href="src/System-Random-TF-Gen.html#line-107" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/libghc-random-doc/html/System-Random.html#t:RandomGen">RandomGen</a> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></span> <a href="src/System-Random-TF-Gen.html#line-175" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="System-Random-TF-Gen.html#t:RandomGen">RandomGen</a> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></span> <a href="src/System-Random-TF-Gen.html#line-251" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:RandomGen" class="def">RandomGen</a> g <span class="keyword">where</span> <a href="src/System-Random-TF-Gen.html#RandomGen" class="link">Source</a></p><div class="doc"><p>Alternative <code><a href="System-Random-TF-Gen.html#t:RandomGen">RandomGen</a></code> class with a modified <code><a href="System-Random-TF-Gen.html#v:next">next</a></code> operation, and added <code><a href="System-Random-TF-Gen.html#v:splitn">splitn</a></code>
and <code><a href="System-Random-TF-Gen.html#v:level">level</a></code> operations.</p><p>Using the generator requires that no more than one operation is called
on the same generator state, as the implementation does not guarantee pseudorandomness
otherwise. As an exception, calling <code><a href="System-Random-TF-Gen.html#v:splitn">splitn</a></code> many times on the same generator state is
allowed as long as the 'bits' argument is the same for all the calls.</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:next" class="def">next</a> :: g -> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word32">Word32</a>, g) <a href="src/System-Random-TF-Gen.html#next" class="link">Source</a></p><div class="doc"><p><code><a href="System-Random-TF-Gen.html#v:next">next</a></code> returns a <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word32">Word32</a></code> that appears to have been chosen uniformly at random, and a
new generator state.</p></div><p class="src"><a name="v:split" class="def">split</a> :: g -> (g, g) <a href="src/System-Random-TF-Gen.html#split" class="link">Source</a></p><div class="doc"><p><code><a href="System-Random-TF-Gen.html#v:split">split</a></code> returns two derived generator states that appear to be independent pseudorandom
number generators.</p></div><p class="src"><a name="v:splitn" class="def">splitn</a> <a href="src/System-Random-TF-Gen.html#splitn" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: g</td><td class="doc"><p>Original generator state.</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Number of bits that will be used to index the derived states.
Must be between 0 and 32.</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word32">Word32</a></td><td class="doc"><p>Index of the derived state. Call to <code>splitn r n i</code> must
satisfy <code>0 <= i < 2^n</code>.</p></td></tr><tr><td class="src">-> g</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p><code><a href="System-Random-TF-Gen.html#v:splitn">splitn</a></code> is the n-way split operation used to create many derived generator states
in one go. Application of <code><a href="System-Random-TF-Gen.html#v:splitn">splitn</a></code> to two first arguments should be shared between
different applications of the index argument to avoid unnecessary repeated computations.</p><p>The following code creates ten 'independent' generator states. Number '4' comes
from the fact that at least
four bits are needed to encode ten different indices.</p><pre> f :: RandomGen g => g -> [g]
f r = map (splitn r 4) [0..9]
</pre></div><p class="src"><a name="v:level" class="def">level</a> :: g -> g <a href="src/System-Random-TF-Gen.html#level" class="link">Source</a></p><div class="doc"><p><code><a href="System-Random-TF-Gen.html#v:level">level</a></code> is a 'hint' operation that may cause an iteration of work
of the generator be performed prematurely in order to
prevent the subsequent operations from being expensive. It is meant to be
called before a <code><a href="System-Random-TF-Gen.html#v:splitn">splitn</a></code> operation, which is expected to be evaluated
a very large number indices. Calling <code><a href="System-Random-TF-Gen.html#v:level">level</a></code> in such case might decrease
the total amount of work performed.</p></div></div><div class="subs instances"><p id="control.i:RandomGen" class="caption collapser" onclick="toggleSection('i:RandomGen')">Instances</p><div id="section.i:RandomGen" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="System-Random-TF-Gen.html#t:RandomGen">RandomGen</a> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a></span> <a href="src/System-Random-TF-Gen.html#line-251" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:seedTFGen" class="def">seedTFGen</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Word.html#t:Word64">Word64</a>) -> <a href="System-Random-TF-Gen.html#t:TFGen">TFGen</a> <a href="src/System-Random-TF-Gen.html#seedTFGen" class="link">Source</a></p><div class="doc"><p>Create a generator from a random seed.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
|