Home Explore Help
Sign In
rparedis
/
PythonDEVS-BBL
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 5814ed696c
Branches Tags
PythonDEVS-BBL
/
docs
/
_build
/
html
/
_modules
/
pypdevsbbl
/
extra
/
rngstreams.html

rngstreams.html 25 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    8. 

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    9. 

  9.     <title>pypdevsbbl.extra.rngstreams &#8212; Python(P)DEVS-BBL  documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
    13. 

  13.     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
    14. 

  14.     <script type="text/javascript" src="../../../_static/jquery.js"></script>
    15. 

  15.     <script type="text/javascript" src="../../../_static/underscore.js"></script>
    16. 

  16.     <script type="text/javascript" src="../../../_static/doctools.js"></script>
    17. 

  17.     <script type="text/javascript" src="../../../_static/language_data.js"></script>
    18. 

  18.     <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    19. 

  19.     <link rel="index" title="Index" href="../../../genindex.html" />
    20. 

  20.     <link rel="search" title="Search" href="../../../search.html" /> 
    21. 

  21.   </head><body>
    22. 

  22.     <div class="related" role="navigation" aria-label="related navigation">
    23. 

  23.       <h3>Navigation</h3>
    24. 

  24.       <ul>
    25. 

  25.         <li class="right" style="margin-right: 10px">
    26. 

  26.           <a href="../../../genindex.html" title="General Index"
    27. 

  27.              accesskey="I">index</a></li>
    28. 

  28.         <li class="right" >
    29. 

  29.           <a href="../../../py-modindex.html" title="Python Module Index"
    30. 

  30.              >modules</a> |</li>
    31. 

  31.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    32. 

  32.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    33. 

  33.           <li class="nav-item nav-item-2"><a href="../extra.html" accesskey="U">pypdevsbbl.extra</a> &#187;</li> 
    34. 

  34.       </ul>
    35. 

  35.     </div>  
    36. 

  36. 

  37.     <div class="document">
    38. 

  38.       <div class="documentwrapper">
    39. 

  39.         <div class="bodywrapper">
    40. 

  40.           <div class="body" role="main">
    41. 

  41.             
    42. 

  42.   <h1>Source code for pypdevsbbl.extra.rngstreams</h1><div class="highlight"><pre>
    43. 

  43. <span></span><span class="c1">#  Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
    44. 

  44. <span class="c1">#  McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
    45. 

  45. <span class="c1">#</span>
    46. 

  46. <span class="c1">#  Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
    47. 

  47. <span class="c1">#  you may not use this file except in compliance with the License.</span>
    48. 

  48. <span class="c1">#  You may obtain a copy of the License at</span>
    49. 

  49. <span class="c1">#</span>
    50. 

  50. <span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
    51. 

  51. <span class="c1">#</span>
    52. 

  52. <span class="c1">#  Unless required by applicable law or agreed to in writing, software</span>
    53. 

  53. <span class="c1">#  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
    54. 

  54. <span class="c1">#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
    55. 

  55. <span class="c1">#  See the License for the specific language governing permissions and</span>
    56. 

  56. <span class="c1">#  limitations under the License.</span>
    57. 

  57. 

  58. <span class="sd">&quot;&quot;&quot;Subpackage for RNGs.</span>
    59. 

  59. 

  60. <span class="sd">This file contains:</span>
    61. 

  61. <span class="sd">    - A Python wrapper for</span>
    62. 

  62. <span class="sd">      `P. L&#39;Ecuyers&#39; and Richard Simard&#39;s RngStreams &lt;http://statmath.wu.ac.at/software/RngStreams/&gt;`_.</span>
    63. 

  63. <span class="sd">      This code was based on https://github.com/adamzjw/RngStream-in-Python/blob/master/RngStream.py .</span>
    64. 

  64. <span class="sd">    - Some helper classes for working with RNGs.</span>
    65. 

  65. 

  66. <span class="sd">By default, the MRG32k3a-based RngStreams are used for generating random</span>
    67. 

  67. <span class="sd">numbers in the building blocks, but this can be changed to Python&#39;s builtin</span>
    68. 

  68. <span class="sd">:mod:`random` module, or the :mod:`numpy.random` module, as is required by</span>
    69. 

  69. <span class="sd">the user. Call :meth:`setGeneratorType` to do so.</span>
    70. 

  70. 

  71. <span class="sd">Warning:</span>
    72. 

  72. <span class="sd">    In order to use RngStreams, please make sure you have the required</span>
    73. 

  73. <span class="sd">    library installed. This consists of the compiled C code for RngStreams</span>
    74. 

  74. <span class="sd">    and should be located in the :file:`src/dependencies/RngStreams/c` folder.</span>
    75. 

  75. 

  76. <span class="sd">    Whenever this library cannot be found, a warning will be printed and the</span>
    77. 

  77. <span class="sd">    builtin :mod:`random` module will be used instead.</span>
    78. 

  78. <span class="sd">&quot;&quot;&quot;</span>
    79. 

  79. 

  80. <span class="kn">import</span> <span class="nn">sys</span><span class="o">,</span> <span class="nn">random</span>
    81. 

  81. <span class="kn">from</span> <span class="nn">ctypes</span> <span class="kn">import</span> <span class="o">*</span>
    82. 

  82. <span class="kn">from</span> <span class="nn">pypdevsbbl.extra.fileutils</span> <span class="kn">import</span> <span class="o">*</span>
    83. 

  83. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    84. 

  84. <span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
    85. 

  85. 

  86. <div class="viewcode-block" id="Generators"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.Generators">[docs]</a><span class="k">class</span> <span class="nc">Generators</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
    87. 

  87.     <span class="sd">&quot;&quot;&quot;Enum helper class to determine the RNG to use.&quot;&quot;&quot;</span>
    88. 

  88. 

  89.     <span class="n">RANDOM</span> <span class="o">=</span> <span class="mi">0</span>
    90. 

  90.     <span class="sd">&quot;&quot;&quot;Use Python&#39;s builtin RNG. (i.e. the :mod:`random` module)&quot;&quot;&quot;</span>
    91. 

  91. 

  92.     <span class="n">NUMPY</span> <span class="o">=</span> <span class="mi">1</span>
    93. 

  93.     <span class="sd">&quot;&quot;&quot;Use Numpy&#39;s RNG.&quot;&quot;&quot;</span>
    94. 

  94. 

  95.     <span class="n">RNGSTREAMS</span> <span class="o">=</span> <span class="mi">2</span>
    96. 

  96.     <span class="sd">&quot;&quot;&quot;Use Pierre L&#39;Ecuyers&#39; and Richard Simard&#39;s RngStreams.</span>
    97. 

  97. <span class="sd">    </span>
    98. 

  98. <span class="sd">    See Also:</span>
    99. 

  99. <span class="sd">        http://statmath.wu.ac.at/software/RngStreams/</span>
    100. 

  100. <span class="sd">    &quot;&quot;&quot;</span></div>
    101. 

  101. 

  102. <span class="n">GENERATE_WITH</span> <span class="o">=</span> <span class="n">Generators</span><span class="o">.</span><span class="n">RNGSTREAMS</span>
    103. 

  103. <span class="sd">&quot;&quot;&quot;Identifies the stream to use.</span>
    104. 

  104. 

  105. <span class="sd">Set this value to the desired RNG stream, before the model is constructed.</span>
    106. 

  106. <span class="sd">Must be a value from the :class:`Generators` enum.</span>
    107. 

  107. <span class="sd">&quot;&quot;&quot;</span>
    108. 

  108. 

  109. <div class="viewcode-block" id="setGeneratorType"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.setGeneratorType">[docs]</a><span class="k">def</span> <span class="nf">setGeneratorType</span><span class="p">(</span><span class="n">gen_type</span><span class="p">):</span>
    110. 

  110.     <span class="sd">&quot;&quot;&quot;Sets the :attr:`GENERATE_WITH` variable.</span>
    111. 

  111. 

  112. <span class="sd">    Call this function to validly set the generator type.</span>
    113. 

  113. 

  114. <span class="sd">    See Also:</span>
    115. 

  115. <span class="sd">        - :attr:`GENERATE_WITH`</span>
    116. 

  116. <span class="sd">        - :class:`Generators`</span>
    117. 

  117. 

  118. <span class="sd">    Note:</span>
    119. 

  119. <span class="sd">        May be changed during construction of RNG-dependent building blocks.</span>
    120. 

  120. <span class="sd">        This allows the combination of multiple generator types.</span>
    121. 

  121. <span class="sd">    &quot;&quot;&quot;</span>
    122. 

  122.     <span class="k">global</span> <span class="n">GENERATE_WITH</span>
    123. 

  123.     <span class="n">GENERATE_WITH</span> <span class="o">=</span> <span class="n">gen_type</span></div>
    124. 

  124. 

  125. 

  126. <span class="c1"># LOAD RNGSTREAMS</span>
    127. 

  127. <span class="k">try</span><span class="p">:</span>
    128. 

  128.     <span class="k">if</span> <span class="s1">&#39;win&#39;</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span><span class="p">:</span> <span class="c1"># Windows</span>
    129. 

  129.         <span class="n">RngStream</span> <span class="o">=</span> <span class="n">CDLL</span><span class="p">(</span><span class="n">dependencies</span><span class="p">(</span><span class="s2">&quot;RngStreams&quot;</span><span class="p">,</span> <span class="s2">&quot;c&quot;</span><span class="p">,</span> <span class="s2">&quot;librngstream.dll&quot;</span><span class="p">))</span>
    130. 

  130.     <span class="k">else</span><span class="p">:</span>                     <span class="c1"># Other OS</span>
    131. 

  131.         <span class="n">RngStream</span> <span class="o">=</span> <span class="n">CDLL</span><span class="p">(</span><span class="n">dependencies</span><span class="p">(</span><span class="s2">&quot;RngStreams&quot;</span><span class="p">,</span> <span class="s2">&quot;c&quot;</span><span class="p">,</span> <span class="s2">&quot;librngstream.so&quot;</span><span class="p">))</span>
    132. 

  132. 

  133. 

  134.     <span class="c1"># define struct</span>
    135. 

  135. <div class="viewcode-block" id="RngStream_InfoState"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.RngStream_InfoState">[docs]</a>    <span class="k">class</span> <span class="nc">RngStream_InfoState</span><span class="p">(</span><span class="n">Structure</span><span class="p">):</span>
    136. 

  136.         <span class="n">_fields_</span> <span class="o">=</span> <span class="p">[</span>
    137. 

  137.             <span class="p">(</span><span class="s1">&#39;Cg&#39;</span><span class="p">,</span> <span class="n">c_double</span> <span class="o">*</span> <span class="mi">6</span><span class="p">),</span>
    138. 

  138.             <span class="p">(</span><span class="s1">&#39;Bg&#39;</span><span class="p">,</span> <span class="n">c_double</span> <span class="o">*</span> <span class="mi">6</span><span class="p">),</span>
    139. 

  139.             <span class="p">(</span><span class="s1">&#39;Ig&#39;</span><span class="p">,</span> <span class="n">c_double</span> <span class="o">*</span> <span class="mi">6</span><span class="p">),</span>
    140. 

  140.             <span class="p">(</span><span class="s1">&#39;Anti&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
    141. 

  141.             <span class="p">(</span><span class="s1">&#39;IncPrec&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
    142. 

  142.             <span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">c_char_p</span><span class="p">)</span>
    143. 

  143.         <span class="p">]</span></div>
    144. 

  144. 

  145.     <span class="c1"># Set argument and return values</span>
    146. 

  146.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_SetPackageSeed</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span><span class="n">c_ulong</span> <span class="o">*</span> <span class="mi">6</span><span class="p">]</span>
    147. 

  147.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_SetPackageSeed</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">c_int</span>
    148. 

  148.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_CreateStream</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">POINTER</span><span class="p">(</span><span class="n">RngStream_InfoState</span><span class="p">)</span>
    149. 

  149.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_SetSeed</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span><span class="n">POINTER</span><span class="p">(</span><span class="n">RngStream_InfoState</span><span class="p">),</span> <span class="n">c_ulong</span> <span class="o">*</span> <span class="mi">6</span><span class="p">]</span>
    150. 

  150.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_SetSeed</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">c_int</span>
    151. 

  151.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_GetState</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span><span class="n">POINTER</span><span class="p">(</span><span class="n">RngStream_InfoState</span><span class="p">),</span> <span class="n">c_ulong</span> <span class="o">*</span> <span class="mi">6</span><span class="p">]</span>
    152. 

  152.     <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_RandU01</span><span class="o">.</span><span class="n">restype</span> <span class="o">=</span> <span class="n">c_double</span>
    153. 

  153. 

  154. <div class="viewcode-block" id="setSeed"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.setSeed">[docs]</a>    <span class="k">def</span> <span class="nf">setSeed</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span>
    155. 

  155.         <span class="sd">&quot;&quot;&quot;Sets a new seed for the RngStreams generator object.</span>
    156. 

  156. 

  157. <span class="sd">        RngStream requires a seed that is of size 6. This function makes it</span>
    158. 

  158. <span class="sd">        easier in a sense that when it does not find enough values for its seed,</span>
    159. 

  159. <span class="sd">        it will automatically fill the seed until it is large enough.</span>
    160. 

  160. 

  161. <span class="sd">        Args:</span>
    162. 

  162. <span class="sd">            gen (object):   The generator object (RngStreams).</span>
    163. 

  163. <span class="sd">            seed:           Either a numeric, or an iterable.</span>
    164. 

  164. <span class="sd">                            The new seed to use.</span>
    165. 

  165. 

  166. <span class="sd">        Returns:</span>
    167. 

  167. <span class="sd">            -1 on faillure, 0 on success.</span>
    168. 

  168. 

  169. <span class="sd">        Raises:</span>
    170. 

  170. <span class="sd">            ValueError: When an invalid seed was given.</span>
    171. 

  171. <span class="sd">        &quot;&quot;&quot;</span>
    172. 

  172.         <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">POINTER</span><span class="p">(</span><span class="n">RngStream_InfoState</span><span class="p">))</span>
    173. 

  173.         <span class="n">n</span> <span class="o">=</span> <span class="mi">6</span>
    174. 

  174.         <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">seed</span><span class="p">),</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
    175. 

  175.             <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    176. 

  176.                 <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Seed list size cannot be of length 0!&quot;</span><span class="p">)</span>
    177. 

  177.             <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">n</span><span class="p">:</span>
    178. 

  178.                 <span class="n">s</span> <span class="o">=</span> <span class="p">(</span><span class="n">seed</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">n</span><span class="o">/</span><span class="nb">len</span><span class="p">(</span><span class="n">seed</span><span class="p">)))[:</span><span class="n">n</span><span class="p">]</span>
    179. 

  179.             <span class="k">else</span><span class="p">:</span>
    180. 

  180.                 <span class="n">s</span> <span class="o">=</span> <span class="n">seed</span><span class="p">[:</span><span class="mi">6</span><span class="p">]</span>
    181. 

  181.         <span class="k">elif</span> <span class="nb">issubclass</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">seed</span><span class="p">),</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">complex</span><span class="p">)):</span>
    182. 

  182.             <span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="n">seed</span><span class="p">]</span> <span class="o">*</span> <span class="n">n</span>
    183. 

  183.         <span class="k">else</span><span class="p">:</span>
    184. 

  184.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Invalid seed aquired: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">seed</span><span class="p">))</span>
    185. 

  185.         <span class="n">SD_TYPE</span> <span class="o">=</span> <span class="n">c_ulong</span> <span class="o">*</span> <span class="mi">6</span>
    186. 

  186.         <span class="k">return</span> <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_SetSeed</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">SD_TYPE</span><span class="p">(</span><span class="o">*</span><span class="n">s</span><span class="p">))</span></div>
    187. 

  187. 

  188. <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    189. 

  189.     <span class="kn">import</span> <span class="nn">warnings</span>
    190. 

  190.     <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">. Cannot load RngStreams. Using &#39;random&#39; module instead.&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
    191. 

  191.     <span class="n">setGeneratorType</span><span class="p">(</span><span class="n">Generators</span><span class="o">.</span><span class="n">RANDOM</span><span class="p">)</span>
    192. 

  192. 

  193. 

  194. 

  195. <div class="viewcode-block" id="createStream"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.createStream">[docs]</a><span class="k">def</span> <span class="nf">createStream</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    196. 

  196.     <span class="sd">&quot;&quot;&quot;Creates a custom RNG stream, w.r.t. the requested generator.</span>
    197. 

  197. 

  198. <span class="sd">    Args:</span>
    199. 

  199. <span class="sd">        name (str): The unique name in case of an RngStreams generator.</span>
    200. 

  200. <span class="sd">        seed:       Either a numeric, or an iterable. The seed to use.</span>
    201. 

  201. <span class="sd">                    When ``None``, no seed will be set. Defaults to</span>
    202. 

  202. <span class="sd">                    ``None``.</span>
    203. 

  203. <span class="sd">    &quot;&quot;&quot;</span>
    204. 

  204.     <span class="k">if</span> <span class="n">GENERATE_WITH</span> <span class="o">==</span> <span class="n">Generators</span><span class="o">.</span><span class="n">RANDOM</span><span class="p">:</span>
    205. 

  205.         <span class="n">stream</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">Random</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
    206. 

  206.     <span class="k">elif</span> <span class="n">GENERATE_WITH</span> <span class="o">==</span> <span class="n">Generators</span><span class="o">.</span><span class="n">NUMPY</span><span class="p">:</span>
    207. 

  207.         <span class="n">stream</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">RandomState</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
    208. 

  208.     <span class="k">elif</span> <span class="n">GENERATE_WITH</span> <span class="o">==</span> <span class="n">Generators</span><span class="o">.</span><span class="n">RNGSTREAMS</span><span class="p">:</span>
    209. 

  209.         <span class="n">stream</span> <span class="o">=</span> <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_CreateStream</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    210. 

  210.         <span class="k">if</span> <span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    211. 

  211.             <span class="n">setSeed</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">seed</span><span class="p">)</span>
    212. 

  212.     <span class="k">else</span><span class="p">:</span>
    213. 

  213.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Unable to determine stream to generate.&quot;</span><span class="p">)</span>
    214. 

  214.     <span class="k">return</span> <span class="n">stream</span></div>
    215. 

  215. 

  216. 

  217. <div class="viewcode-block" id="U01"><a class="viewcode-back" href="../../../pypdevsbbl.extra.rngstreams.html#pypdevsbbl.extra.rngstreams.U01">[docs]</a><span class="k">def</span> <span class="nf">U01</span><span class="p">(</span><span class="n">gen</span><span class="p">):</span>
    218. 

  218.     <span class="sd">&quot;&quot;&quot;Return a uniformly distributed random variable within (0, 1).</span>
    219. 

  219. 

  220. <span class="sd">    This function works no matter the selected generator.</span>
    221. 

  221. 

  222. <span class="sd">    Args:</span>
    223. 

  223. <span class="sd">        gen (object):   The generator to use.</span>
    224. 

  224. 

  225. <span class="sd">    Returns:</span>
    226. 

  226. <span class="sd">        A numpy.float64 in the range (0, 1).</span>
    227. 

  227. <span class="sd">    &quot;&quot;&quot;</span>
    228. 

  228.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">random</span><span class="o">.</span><span class="n">Random</span><span class="p">):</span>
    229. 

  229.         <span class="n">value</span> <span class="o">=</span> <span class="n">gen</span><span class="o">.</span><span class="n">random</span><span class="p">()</span>
    230. 

  230.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">RandomState</span><span class="p">):</span>
    231. 

  231.         <span class="n">value</span> <span class="o">=</span> <span class="n">gen</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
    232. 

  232.     <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">gen</span><span class="p">,</span> <span class="n">POINTER</span><span class="p">(</span><span class="n">RngStream_InfoState</span><span class="p">)):</span>
    233. 

  233.         <span class="n">value</span> <span class="o">=</span> <span class="n">RngStream</span><span class="o">.</span><span class="n">RngStream_RandU01</span><span class="p">(</span><span class="n">gen</span><span class="p">)</span>
    234. 

  234.     <span class="k">else</span><span class="p">:</span>
    235. 

  235.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Invalid generator instance.&quot;</span><span class="p">)</span>
    236. 

  236.     <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
    237. 

  237. </pre></div>
    238. 

  238. 

  239.           </div>
    240. 

  240.         </div>
    241. 

  241.       </div>
    242. 

  242.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    243. 

  243.         <div class="sphinxsidebarwrapper">
    244. 

  244. <div id="searchbox" style="display: none" role="search">
    245. 

  245.   <h3>Quick search</h3>
    246. 

  246.     <div class="searchformwrapper">
    247. 

  247.     <form class="search" action="../../../search.html" method="get">
    248. 

  248.       <input type="text" name="q" />
    249. 

  249.       <input type="submit" value="Go" />
    250. 

  250.       <input type="hidden" name="check_keywords" value="yes" />
    251. 

  251.       <input type="hidden" name="area" value="default" />
    252. 

  252.     </form>
    253. 

  253.     </div>
    254. 

  254. </div>
    255. 

  255. <script type="text/javascript">$('#searchbox').show(0);</script>
    256. 

  256.         </div>
    257. 

  257.       </div>
    258. 

  258.       <div class="clearer"></div>
    259. 

  259.     </div>
    260. 

  260.     <div class="related" role="navigation" aria-label="related navigation">
    261. 

  261.       <h3>Navigation</h3>
    262. 

  262.       <ul>
    263. 

  263.         <li class="right" style="margin-right: 10px">
    264. 

  264.           <a href="../../../genindex.html" title="General Index"
    265. 

  265.              >index</a></li>
    266. 

  266.         <li class="right" >
    267. 

  267.           <a href="../../../py-modindex.html" title="Python Module Index"
    268. 

  268.              >modules</a> |</li>
    269. 

  269.         <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
    270. 

  270.           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
    271. 

  271.           <li class="nav-item nav-item-2"><a href="../extra.html" >pypdevsbbl.extra</a> &#187;</li> 
    272. 

  272.       </ul>
    273. 

  273.     </div>
    274. 

  274.     <div class="footer" role="contentinfo">
    275. 

  275.         &#169; Copyright 2020, Randy Paredis.
    276. 

  276.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    277. 

  277.     </div>
    278. 

  278.   </body>
    279. 

  279. </html>
    280.