rparedis
/
PythonDEVS-BBL


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
							
<!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="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>pypdevsbbl.generic.generators module &#8212; Python(P)DEVS-BBL  documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/custom.css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="pypdevsbbl.generic.io module" href="pypdevsbbl.generic.io.html" />
    <link rel="prev" title="pypdevsbbl.generic.collectors module" href="pypdevsbbl.generic.collectors.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.generic.io.html" title="pypdevsbbl.generic.io module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.generic.collectors.html" title="pypdevsbbl.generic.collectors module"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="pypdevsbbl.generic.html" accesskey="U">pypdevsbbl.generic package</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-pypdevsbbl.generic.generators">
<span id="pypdevsbbl-generic-generators-module"></span><h1>pypdevsbbl.generic.generators module<a class="headerlink" href="#module-pypdevsbbl.generic.generators" title="Permalink to this headline">¶</a></h1>
<p>A set of building blocks that can be used for generating data.</p>
<p>When using the classes in this file, you can start creating simple
(and complex) flow systems or, generally, anything that requires
input.</p>
<dl class="class">
<dt id="pypdevsbbl.generic.generators.ConstantGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">ConstantGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>value=0</em>, <em>dt=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#ConstantGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.ConstantGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p>AtomicDEVS that generates a constant value every dt time.</p>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/constant-generator.svg" src="../paper/images/blocks/generators/constant-generator.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the generator.</li>
<li><strong>value</strong> (<em>any</em>) – The item to be generated. Defaults to 0.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Defaults to 1.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>value</strong> (<em>any</em>) – The item to generate.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Cannot be negative or zero.</li>
<li><strong>elapsed</strong> (<em>numeric</em>) – The elapsed time since last internal transition.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first simple">
<li><strong>value</strong> (<em>any</em>) – A new value to output.</li>
<li><strong>dt</strong> (<em>numeric</em>) – A new time delay. Cannot be negative or zero.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>any</em>) – Outputs the generated value.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.ConstantGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#ConstantGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.ConstantGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.ConstantGenerator.extTransition">
<code class="descname">extTransition</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#ConstantGenerator.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.ConstantGenerator.extTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.ConstantGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#ConstantGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.ConstantGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.ConstantGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#ConstantGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.ConstantGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.FunctionGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">FunctionGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>function=&lt;function FunctionGenerator.&lt;lambda&gt;&gt;</em>, <em>ic=0</em>, <em>dt=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#FunctionGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.FunctionGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p>AtomicDEVS that generates a new value based on the previous one and the elapsed time.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">By default, he first output <code class="docutils literal notranslate"><span class="pre">ic</span></code> (initial condition) will be outputted at time 0.</p>
</div>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/function-generator.svg" src="../paper/images/blocks/generators/function-generator.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the generator.</li>
<li><strong>function</strong> (<em>def</em>) – A function that takes the previous value and the elapsed time as
arguments and returns a new item from those.
Defaults to an incrementor of the ic.</li>
<li><strong>ic</strong> (<em>any</em>) – The initial condition of the generator.
Defaults to 0.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Defaults to 1.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>next</strong> (<em>any</em>) – The next item that will be generated.</li>
<li><strong>time</strong> (<em>numeric</em>) – The amount of time that has elapsed.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Cannot be negative or zero. Defaults to 1.</li>
<li><strong>elapsed</strong> (<em>numeric</em>) – The elapsed time since last internal transition.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><p class="first"><strong>dt</strong> (<em>numeric</em>) – A new time delay. Cannot be negative or zero.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>any</em>) – Outputs the generated value.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.FunctionGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#FunctionGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.FunctionGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.FunctionGenerator.extTransition">
<code class="descname">extTransition</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#FunctionGenerator.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.FunctionGenerator.extTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.FunctionGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#FunctionGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.FunctionGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.FunctionGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#FunctionGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.FunctionGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.TableGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">TableGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>table</em>, <em>repeat: bool = False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#TableGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.TableGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p>AtomicDEVS that generates a new value based on the table.</p>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/table-generator.svg" src="../paper/images/blocks/generators/table-generator.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the generator.</li>
<li><strong>table</strong> (<em>iter</em>) – An iterable containing (time, value) tuples/pairs.
Defaults to empty list.</li>
<li><strong>repeat</strong> (<em>bool</em>) – When <code class="docutils literal notranslate"><span class="pre">True</span></code>, the table will be repeated when it
is finished. Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>time</strong> (<em>numeric</em>) – The amount of time until the next transition.</li>
<li><strong>index</strong> (<em>int</em>) – The index in the table at this point.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>any</em>) – Outputs the generated value.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.TableGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#TableGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.TableGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.TableGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#TableGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.TableGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.TableGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#TableGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.TableGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.SingleFire">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">SingleFire</code><span class="sig-paren">(</span><em>name: str</em>, <em>item</em>, <em>t=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#SingleFire"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.SingleFire" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p>Output an item once.</p>
<p>Useful to prevent the overhead of a <a class="reference internal" href="#pypdevsbbl.generic.generators.TableGenerator" title="pypdevsbbl.generic.generators.TableGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">TableGenerator</span></code></a> with a
single record.</p>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/single-fire.svg" src="../paper/images/blocks/generators/single-fire.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the block.</li>
<li><strong>item</strong> (<em>any</em>) – The item that needs to be outputted.
Cannot be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</li>
<li><strong>t</strong> (<em>numeric</em>) – Absolute simulation time when to fire the event.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> (<em>any</em>) – The item to fire.</li>
<li><strong>t</strong> (<em>numeric</em>) – The absolute time until the event or <code class="docutils literal notranslate"><span class="pre">INFINITY</span></code>
if the event has already passed.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>any</em>) – The item.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.SingleFire.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#SingleFire.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.SingleFire.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.SingleFire.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#SingleFire.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.SingleFire.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.SingleFire.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#SingleFire.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.SingleFire.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.BulkGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">BulkGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>dt=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#BulkGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.BulkGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p>Creates <span class="math notranslate nohighlight">\(n\)</span> messages every time it receives <span class="math notranslate nohighlight">\(n\)</span>.</p>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/bulk-generator.svg" src="../paper/images/blocks/generators/bulk-generator.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the block.</li>
<li><strong>dt</strong> (<em>numeric</em>) – The time delay between the messages. Cannot be
negative. Defaults to 0.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>index</strong> (<em>int</em>) – The index of the last item that was outputted.</li>
<li><strong>items</strong> (<em>list</em>) – The items to generate.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Cannot be negative or zero.</li>
<li><strong>elapsed</strong> (<em>numeric</em>) – The elapsed time since last internal transition.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first simple">
<li><strong>input</strong> (<em>int</em>) – A amount of items to output in bulk. When there
are still items remaining, the provided values
are appended to the list.</li>
<li><strong>dt</strong> (<em>numeric</em>) – A new time delay. Cannot be negative.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>numeric</em>) – Outputs the generated values.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.BulkGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#BulkGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.BulkGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.BulkGenerator.extTransition">
<code class="descname">extTransition</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#BulkGenerator.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.BulkGenerator.extTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.BulkGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#BulkGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.BulkGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.BulkGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#BulkGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.BulkGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">RandomNumberGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>seed=None</em>, <em>dist=&lt;function RandomNumberGenerator.&lt;lambda&gt;&gt;</em>, <em>args=()</em>, <em>dt=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">AtomicDEVS</span></code> that generates a random number every dt time.</p>
<p>It makes use of the RngStreams random number generator i.i.d. (0, 1).
Using the <code class="docutils literal notranslate"><span class="pre">dist</span></code> argument, one can simply change the distribution over which
numbers need to be generated. The <code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams.distributions</span></code>
module provides an extensive implementation of a lot of distributions.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="pypdevsbbl.generic.math.html#pypdevsbbl.generic.math.Random" title="pypdevsbbl.generic.math.Random"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.math.Random</span></code></a></li>
<li><a class="reference internal" href="#pypdevsbbl.generic.generators.RandomDelayGenerator" title="pypdevsbbl.generic.generators.RandomDelayGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">RandomDelayGenerator</span></code></a></li>
<li><a class="reference internal" href="pypdevsbbl.extra.rngstreams.html#module-pypdevsbbl.extra.rngstreams" title="pypdevsbbl.extra.rngstreams"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams</span></code></a></li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams.distributions</span></code></li>
</ul>
</div>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/rng.svg" src="../paper/images/blocks/generators/rng.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the generator (both the block and the engine).</li>
<li><strong>seed</strong> (<em>numeric</em>) – The seed for the generator. When <code class="docutils literal notranslate"><span class="pre">None</span></code>, it will not set a
seed. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</li>
<li><strong>dist</strong> (<em>def</em>) – A stateless function that implements an inversive cumulative
distribution function. It takes at least a single argument,
which falls in (0, 1).
Defaults to a uniform distribution over (0, 1).</li>
<li><strong>args</strong> (<em>tuple</em>) – Optional additional arguments to add to the distribution.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.
Defaults to 1. Cannot be negative or zero.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.</li>
<li><strong>num</strong> (<em>numeric</em>) – The random number that’s being/needs to be outputted.</li>
<li><strong>elapsed</strong> (<em>numeric</em>) – The elapsed time since last internal transition.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><p class="first"><strong>dt</strong> (<em>numeric</em>) – A new time delay. Cannot be negative or zero.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>numeric</em>) – Outputs the generated value.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator.extTransition">
<code class="descname">extTransition</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator.extTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomNumberGenerator.next">
<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomNumberGenerator.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomNumberGenerator.next" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtains a random variable w.r.t. this generator’s config.</p>
<p>Do note that this updates the gen object, meaning it must only be called
in functions that may update the state.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator">
<em class="property">class </em><code class="descclassname">pypdevsbbl.generic.generators.</code><code class="descname">RandomDelayGenerator</code><span class="sig-paren">(</span><em>name: str</em>, <em>seed=None</em>, <em>dist=&lt;function RandomDelayGenerator.&lt;lambda&gt;&gt;</em>, <em>args=()</em>, <em>func=&lt;function RandomDelayGenerator.&lt;lambda&gt;&gt;</em>, <em>dt=0.0</em>, <em>max=inf</em>, <em>base=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">AtomicDEVS</span></code> that generates a new item every random time.</p>
<p>The items that are generated get a sequential numbering (which can be altered
using the <code class="xref py py-attr docutils literal notranslate"><span class="pre">func</span></code> argument), but their inter-arrival times follow the
provided distribution.</p>
<p>It makes use of the RngStreams random number generator i.i.d. (0, 1).
Using the <code class="docutils literal notranslate"><span class="pre">dist</span></code> argument, one can simply change the distribution over which
numbers need to be generated. The <code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams.distributions</span></code>
module provides an extensive implementation of a lot of distributions.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="#pypdevsbbl.generic.generators.RandomNumberGenerator" title="pypdevsbbl.generic.generators.RandomNumberGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">RandomNumberGenerator</span></code></a></li>
<li><a class="reference internal" href="pypdevsbbl.generic.math.html#pypdevsbbl.generic.math.Random" title="pypdevsbbl.generic.math.Random"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.math.Random</span></code></a></li>
<li><a class="reference internal" href="pypdevsbbl.extra.rngstreams.html#module-pypdevsbbl.extra.rngstreams" title="pypdevsbbl.extra.rngstreams"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams</span></code></a></li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.rngstreams.distributions</span></code></li>
</ul>
</div>
<div align="center" class="align-center"><img alt="../paper/images/blocks/generators/random-delay-generator.svg" src="../paper/images/blocks/generators/random-delay-generator.svg" /></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>str</em>) – The name of the generator (both the block and the engine).</li>
<li><strong>seed</strong> (<em>numeric</em>) – The seed for the generator. When <code class="docutils literal notranslate"><span class="pre">None</span></code>, it will not set a
seed. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</li>
<li><strong>dist</strong> (<em>def</em>) – A stateless function that implements an inversive cumulative
distribution function. It takes at least a single argument,
which falls in (0, 1).
Defaults to a uniform distribution over (0, 1).</li>
<li><strong>args</strong> (<em>tuple</em>) – Optional additional arguments to add to the distribution.</li>
<li><strong>func</strong> (<em>def</em>) – Transformation function for the newly generated item.</li>
<li><strong>dt</strong> (<em>numeric</em>) – Time of first item to generate. When <code class="docutils literal notranslate"><span class="pre">None</span></code>, no output
will be created at time 0. Defaults to 0.</li>
<li><strong>max</strong> (<em>numeric</em>) – Maximal amount of items to generate.</li>
<li><strong>base</strong> (<em>numeric</em>) – The base number to start from when assigning the sequential
numbering. When <code class="docutils literal notranslate"><span class="pre">None</span></code>, the block’s hash is used. Defaults
to 0.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
<li><strong>dt</strong> (<em>numeric</em>) – Time delay between the generation of new events.</li>
<li><strong>num</strong> (<em>numeric</em>) – The random number that’s being/needs to be outputted.</li>
<li><strong>elapsed</strong> (<em>numeric</em>) – The elapsed time since last internal transition.</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><p class="first"><strong>halt</strong> (<em>bool</em>) – Halts the generator until further notice.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><p class="first last"><strong>output</strong> (<em>any</em>) – Outputs the value.</p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator.timeAdvance">
<code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator.timeAdvance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator.extTransition">
<code class="descname">extTransition</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator.extTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator.intTransition">
<code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator.intTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator.outputFnc">
<code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator.outputFnc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.generic.generators.RandomDelayGenerator.next">
<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/generators.html#RandomDelayGenerator.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.generators.RandomDelayGenerator.next" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtains a random variable w.r.t. this generator’s config.</p>
<p>Do note that this updates the gen object, meaning it must only be called
in functions that may update the state.</p>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="pypdevsbbl.generic.collectors.html"
                        title="previous chapter">pypdevsbbl.generic.collectors module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pypdevsbbl.generic.io.html"
                        title="next chapter">pypdevsbbl.generic.io module</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.generic.io.html" title="pypdevsbbl.generic.io module"
             >next</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.generic.collectors.html" title="pypdevsbbl.generic.collectors module"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="pypdevsbbl.generic.html" >pypdevsbbl.generic package</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, Randy Paredis.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    </div>
  </body>
</html>