Accueil Explorer Aide
Connexion
rparedis
/
PythonDEVS-BBL
Suivre 1
Voter 0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Aborescence: 5814ed696c
Branches Tags
PythonDEVS-BBL
/
docs
/
_build
/
html
/
pypdevsbbl.generic.collectors.html

pypdevsbbl.generic.collectors.html 54 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811 
  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.generic.collectors module &#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.     <link rel="next" title="pypdevsbbl.generic.generators module" href="pypdevsbbl.generic.generators.html" />
    22. 

  22.     <link rel="prev" title="pypdevsbbl.generic package" href="pypdevsbbl.generic.html" /> 
    23. 

  23.   </head><body>
    24. 

  24.     <div class="related" role="navigation" aria-label="related navigation">
    25. 

  25.       <h3>Navigation</h3>
    26. 

  26.       <ul>
    27. 

  27.         <li class="right" style="margin-right: 10px">
    28. 

  28.           <a href="genindex.html" title="General Index"
    29. 

  29.              accesskey="I">index</a></li>
    30. 

  30.         <li class="right" >
    31. 

  31.           <a href="py-modindex.html" title="Python Module Index"
    32. 

  32.              >modules</a> |</li>
    33. 

  33.         <li class="right" >
    34. 

  34.           <a href="pypdevsbbl.generic.generators.html" title="pypdevsbbl.generic.generators module"
    35. 

  35.              accesskey="N">next</a> |</li>
    36. 

  36.         <li class="right" >
    37. 

  37.           <a href="pypdevsbbl.generic.html" title="pypdevsbbl.generic package"
    38. 

  38.              accesskey="P">previous</a> |</li>
    39. 

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

  40.           <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
    41. 

  41.           <li class="nav-item nav-item-2"><a href="pypdevsbbl.generic.html" accesskey="U">pypdevsbbl.generic package</a> &#187;</li> 
    42. 

  42.       </ul>
    43. 

  43.     </div>  
    44. 

  44. 

  45.     <div class="document">
    46. 

  46.       <div class="documentwrapper">
    47. 

  47.         <div class="bodywrapper">
    48. 

  48.           <div class="body" role="main">
    49. 

  49.             
    50. 

  50.   <div class="section" id="module-pypdevsbbl.generic.collectors">
    51. 

  51. <span id="pypdevsbbl-generic-collectors-module"></span><h1>pypdevsbbl.generic.collectors module<a class="headerlink" href="#module-pypdevsbbl.generic.collectors" title="Permalink to this headline">¶</a></h1>
    52. 

  52. <p>Set of PythonPDEVS collectors for keeping track of all data.</p>
    53. 

  53. <p>The classes in this file will allow for obtaining some well
    54. 

  54. required statistical data from your models.</p>
    55. 

  55. <dl class="class">
    56. 

  56. <dt id="pypdevsbbl.generic.collectors.BaseCollector">
    57. 

  57. <em class="property">class </em><code class="descclassname">pypdevsbbl.generic.collectors.</code><code class="descname">BaseCollector</code><span class="sig-paren">(</span><em>name: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#BaseCollector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.BaseCollector" title="Permalink to this definition">¶</a></dt>
    58. 

  58. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.AtomicDEVS</span></code></p>
    59. 

  59. <p>Base class for all the collectors.</p>
    60. 

  60. <p>This building block itself is not useful, but mainly acts as a root
    61. 

  61. from which all collectors can inherit.</p>
    62. 

  62. <table class="docutils field-list" frame="void" rules="none">
    63. 

  63. <col class="field-name" />
    64. 

  64. <col class="field-body" />
    65. 

  65. <tbody valign="top">
    66. 

  66. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>name</strong> (<em>str</em>) – The name of the Collector.</p>
    67. 

  67. </td>
    68. 

  68. </tr>
    69. 

  69. <tr class="field-even field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first last simple">
    70. 

  70. <li><strong>input</strong> (<em>any</em>) – Obtains values.</li>
    71. 

  71. <li><strong>clear</strong> (<em>any</em>) – Clears the contents of the block.</li>
    72. 

  72. </ul>
    73. 

  73. </td>
    74. 

  74. </tr>
    75. 

  75. </tbody>
    76. 

  76. </table>
    77. 

  77. <dl class="method">
    78. 

  78. <dt id="pypdevsbbl.generic.collectors.BaseCollector.clearContents">
    79. 

  79. <code class="descname">clearContents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#BaseCollector.clearContents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.BaseCollector.clearContents" title="Permalink to this definition">¶</a></dt>
    80. 

  80. <dd><p>Clears the contents of the block.</p>
    81. 

  81. </dd></dl>
    82. 

  82. 

  83. <dl class="method">
    84. 

  84. <dt id="pypdevsbbl.generic.collectors.BaseCollector.plot">
    85. 

  85. <code class="descname">plot</code><span class="sig-paren">(</span><em>axis</em>, <em>arg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#BaseCollector.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.BaseCollector.plot" title="Permalink to this definition">¶</a></dt>
    86. 

  86. <dd><p>Plots the data of the collector.</p>
    87. 

  87. <table class="docutils field-list" frame="void" rules="none">
    88. 

  88. <col class="field-name" />
    89. 

  89. <col class="field-body" />
    90. 

  90. <tbody valign="top">
    91. 

  91. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    92. 

  92. <li><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</li>
    93. 

  93. <li><strong>arg</strong> – Additional argument.</li>
    94. 

  94. </ul>
    95. 

  95. </td>
    96. 

  96. </tr>
    97. 

  97. </tbody>
    98. 

  98. </table>
    99. 

  99. </dd></dl>
    100. 

  100. 

  101. </dd></dl>
    102. 

  102. 

  103. <dl class="class">
    104. 

  104. <dt id="pypdevsbbl.generic.collectors.Collector">
    105. 

  105. <em class="property">class </em><code class="descclassname">pypdevsbbl.generic.collectors.</code><code class="descname">Collector</code><span class="sig-paren">(</span><em>name: str</em>, <em>positive: bool = False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector" title="Permalink to this definition">¶</a></dt>
    106. 

  106. <dd><p>Bases: <a class="reference internal" href="#pypdevsbbl.generic.collectors.BaseCollector" title="pypdevsbbl.generic.collectors.BaseCollector"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.collectors.BaseCollector</span></code></a></p>
    107. 

  107. <p>Collects base information about items that arrive on <cite>input</cite>.</p>
    108. 

  108. <p>The Collector block keeps track of the basic information about all items that
    109. 

  109. arrive. This includes minima, maxima, means, sums, sums of squares and the
    110. 

  110. amount of items that it has seen.</p>
    111. 

  111. <p>Using this data, the min, max, mean, variance, standard derivation and count
    112. 

  112. of the passed items can be obtained. See their respective functions below.</p>
    113. 

  113. <div class="admonition note">
    114. 

  114. <p class="first admonition-title">Note</p>
    115. 

  115. <p class="last">In order to do this, the items must be numeric and therefore have the
    116. 

  116. <code class="docutils literal notranslate"><span class="pre">__lt__</span></code>, <code class="docutils literal notranslate"><span class="pre">__gt__</span></code>, <code class="docutils literal notranslate"><span class="pre">__add__</span></code>, <code class="docutils literal notranslate"><span class="pre">__pow__</span></code> and <code class="docutils literal notranslate"><span class="pre">__div__</span></code> operators
    117. 

  117. available.</p>
    118. 

  118. </div>
    119. 

  119. <div align="center" class="align-center"><img alt="_images/collector.svg" src="_images/collector.svg" /></div>
    120. 

  120. <table class="docutils field-list" frame="void" rules="none">
    121. 

  121. <col class="field-name" />
    122. 

  122. <col class="field-body" />
    123. 

  123. <tbody valign="top">
    124. 

  124. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    125. 

  125. <li><strong>name</strong> (<em>str</em>) – The name for the Collector.</li>
    126. 

  126. <li><strong>positive</strong> (<em>bool</em>) – When <code class="docutils literal notranslate"><span class="pre">True</span></code>, only data from strict positive values will be
    127. 

  127. captured. Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</li>
    128. 

  128. </ul>
    129. 

  129. </td>
    130. 

  130. </tr>
    131. 

  131. <tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
    132. 

  132. <li><strong>min</strong> (<em>numeric</em>) – The minimal value that arrived. When no items passed
    133. 

  133. through, this will be INFINITY.</li>
    134. 

  134. <li><strong>max</strong> (<em>numeric</em>) – The maximal value that arrived. When no items passed
    135. 

  135. through, this will be -INFINITY.</li>
    136. 

  136. <li><strong>n</strong> (<em>int</em>) – The amount of items that have arrived.</li>
    137. 

  137. <li><strong>sum</strong> (<em>numeric</em>) – The sum of all values that have arrived.</li>
    138. 

  138. <li><strong>squares</strong> (<em>numeric</em>) – The sum of the squares of all values that have arrived.</li>
    139. 

  139. </ul>
    140. 

  140. </td>
    141. 

  141. </tr>
    142. 

  142. <tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first last simple">
    143. 

  143. <li><strong>input</strong> (<em>numeric</em>) – Obtains values.
    144. 

  144. Note that INFINITY inputs will shape the data in an undefined way.</li>
    145. 

  145. <li><strong>clear</strong> (<em>any</em>) – Clears the contents of the block.</li>
    146. 

  146. </ul>
    147. 

  147. </td>
    148. 

  148. </tr>
    149. 

  149. </tbody>
    150. 

  150. </table>
    151. 

  151. <dl class="method">
    152. 

  152. <dt id="pypdevsbbl.generic.collectors.Collector.plot">
    153. 

  153. <code class="descname">plot</code><span class="sig-paren">(</span><em>axis</em>, <em>cols=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.plot" title="Permalink to this definition">¶</a></dt>
    154. 

  154. <dd><p>Plots the data of the collector.</p>
    155. 

  155. <table class="docutils field-list" frame="void" rules="none">
    156. 

  156. <col class="field-name" />
    157. 

  157. <col class="field-body" />
    158. 

  158. <tbody valign="top">
    159. 

  159. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    160. 

  160. <li><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</li>
    161. 

  161. <li><strong>cols</strong> – How many columns to split the info into.
    162. 

  162. Defaults to 1.</li>
    163. 

  163. </ul>
    164. 

  164. </td>
    165. 

  165. </tr>
    166. 

  166. </tbody>
    167. 

  167. </table>
    168. 

  168. </dd></dl>
    169. 

  169. 

  170. <dl class="method">
    171. 

  171. <dt id="pypdevsbbl.generic.collectors.Collector.extTransition">
    172. 

  172. <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/collectors.html#Collector.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.extTransition" title="Permalink to this definition">¶</a></dt>
    173. 

  173. <dd></dd></dl>
    174. 

  174. 

  175. <dl class="method">
    176. 

  176. <dt id="pypdevsbbl.generic.collectors.Collector.clearContents">
    177. 

  177. <code class="descname">clearContents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.clearContents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.clearContents" title="Permalink to this definition">¶</a></dt>
    178. 

  178. <dd></dd></dl>
    179. 

  179. 

  180. <dl class="method">
    181. 

  181. <dt id="pypdevsbbl.generic.collectors.Collector.min">
    182. 

  182. <code class="descname">min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.min"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.min" title="Permalink to this definition">¶</a></dt>
    183. 

  183. <dd><p>Conveniance method to obtain the minimal value.</p>
    184. 

  184. <table class="docutils field-list" frame="void" rules="none">
    185. 

  185. <col class="field-name" />
    186. 

  186. <col class="field-body" />
    187. 

  187. <tbody valign="top">
    188. 

  188. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The minimal value that arrived.</td>
    189. 

  189. </tr>
    190. 

  190. </tbody>
    191. 

  191. </table>
    192. 

  192. </dd></dl>
    193. 

  193. 

  194. <dl class="method">
    195. 

  195. <dt id="pypdevsbbl.generic.collectors.Collector.max">
    196. 

  196. <code class="descname">max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.max"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.max" title="Permalink to this definition">¶</a></dt>
    197. 

  197. <dd><p>Conveniance method to obtain the maximal value.</p>
    198. 

  198. <table class="docutils field-list" frame="void" rules="none">
    199. 

  199. <col class="field-name" />
    200. 

  200. <col class="field-body" />
    201. 

  201. <tbody valign="top">
    202. 

  202. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The maximal value that arrived.</td>
    203. 

  203. </tr>
    204. 

  204. </tbody>
    205. 

  205. </table>
    206. 

  206. </dd></dl>
    207. 

  207. 

  208. <dl class="method">
    209. 

  209. <dt id="pypdevsbbl.generic.collectors.Collector.count">
    210. 

  210. <code class="descname">count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.count" title="Permalink to this definition">¶</a></dt>
    211. 

  211. <dd><p>Conveniance method to obtain the amount of items.</p>
    212. 

  212. <table class="docutils field-list" frame="void" rules="none">
    213. 

  213. <col class="field-name" />
    214. 

  214. <col class="field-body" />
    215. 

  215. <tbody valign="top">
    216. 

  216. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The amount of items that have arrived.</td>
    217. 

  217. </tr>
    218. 

  218. </tbody>
    219. 

  219. </table>
    220. 

  220. </dd></dl>
    221. 

  221. 

  222. <dl class="method">
    223. 

  223. <dt id="pypdevsbbl.generic.collectors.Collector.sum">
    224. 

  224. <code class="descname">sum</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.sum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.sum" title="Permalink to this definition">¶</a></dt>
    225. 

  225. <dd><p>Conveniance method to obtain the sum.</p>
    226. 

  226. <table class="docutils field-list" frame="void" rules="none">
    227. 

  227. <col class="field-name" />
    228. 

  228. <col class="field-body" />
    229. 

  229. <tbody valign="top">
    230. 

  230. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The sum of the items that have arrived.</td>
    231. 

  231. </tr>
    232. 

  232. </tbody>
    233. 

  233. </table>
    234. 

  234. </dd></dl>
    235. 

  235. 

  236. <dl class="method">
    237. 

  237. <dt id="pypdevsbbl.generic.collectors.Collector.sumOfSquares">
    238. 

  238. <code class="descname">sumOfSquares</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.sumOfSquares"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.sumOfSquares" title="Permalink to this definition">¶</a></dt>
    239. 

  239. <dd><p>Conveniance method to obtain the sum of squares.</p>
    240. 

  240. <table class="docutils field-list" frame="void" rules="none">
    241. 

  241. <col class="field-name" />
    242. 

  242. <col class="field-body" />
    243. 

  243. <tbody valign="top">
    244. 

  244. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The sum of squares of the items that have arrived.</td>
    245. 

  245. </tr>
    246. 

  246. </tbody>
    247. 

  247. </table>
    248. 

  248. </dd></dl>
    249. 

  249. 

  250. <dl class="method">
    251. 

  251. <dt id="pypdevsbbl.generic.collectors.Collector.mean">
    252. 

  252. <code class="descname">mean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.mean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.mean" title="Permalink to this definition">¶</a></dt>
    253. 

  253. <dd><p>Get the mean of all values that have arrived.</p>
    254. 

  254. <p>It is computed as <span class="math notranslate nohighlight">\(\mu = \dfrac{\sum_i i}{n}\)</span>, with
    255. 

  255. <span class="math notranslate nohighlight">\(i\)</span> an item that arrived.</p>
    256. 

  256. <table class="docutils field-list" frame="void" rules="none">
    257. 

  257. <col class="field-name" />
    258. 

  258. <col class="field-body" />
    259. 

  259. <tbody valign="top">
    260. 

  260. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The mean or 0 if no items have arrived.</td>
    261. 

  261. </tr>
    262. 

  262. </tbody>
    263. 

  263. </table>
    264. 

  264. </dd></dl>
    265. 

  265. 

  266. <dl class="method">
    267. 

  267. <dt id="pypdevsbbl.generic.collectors.Collector.variance">
    268. 

  268. <code class="descname">variance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.variance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.variance" title="Permalink to this definition">¶</a></dt>
    269. 

  269. <dd><p>Get the variance of all values that have arrived.</p>
    270. 

  270. <p>It is computed as
    271. 

  271. <span class="math notranslate nohighlight">\(\sigma^2 = \dfrac{\sum_i i^2}{n} + \mu^2 - \dfrac{2\mu\sum_i i}{n}\)</span>,
    272. 

  272. with <span class="math notranslate nohighlight">\(i\)</span> an item that arrived.</p>
    273. 

  273. <table class="docutils field-list" frame="void" rules="none">
    274. 

  274. <col class="field-name" />
    275. 

  275. <col class="field-body" />
    276. 

  276. <tbody valign="top">
    277. 

  277. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The variance or 0 if no items have arrived.</td>
    278. 

  278. </tr>
    279. 

  279. </tbody>
    280. 

  280. </table>
    281. 

  281. </dd></dl>
    282. 

  282. 

  283. <dl class="method">
    284. 

  284. <dt id="pypdevsbbl.generic.collectors.Collector.std">
    285. 

  285. <code class="descname">std</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Collector.std"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Collector.std" title="Permalink to this definition">¶</a></dt>
    286. 

  286. <dd><p>Get the standard derivation of all values that have arrived.</p>
    287. 

  287. <p>It is computed as <span class="math notranslate nohighlight">\(\sigma = \sqrt{v}\)</span>, with
    288. 

  288. <span class="math notranslate nohighlight">\(v\)</span> the result from the <a class="reference internal" href="#pypdevsbbl.generic.collectors.Collector.variance" title="pypdevsbbl.generic.collectors.Collector.variance"><code class="xref py py-meth docutils literal notranslate"><span class="pre">variance()</span></code></a> function.</p>
    289. 

  289. <table class="docutils field-list" frame="void" rules="none">
    290. 

  290. <col class="field-name" />
    291. 

  291. <col class="field-body" />
    292. 

  292. <tbody valign="top">
    293. 

  293. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The standard derivation or 0 if no items have arrived.</td>
    294. 

  294. </tr>
    295. 

  295. </tbody>
    296. 

  296. </table>
    297. 

  297. </dd></dl>
    298. 

  298. 

  299. </dd></dl>
    300. 

  300. 

  301. <dl class="class">
    302. 

  302. <dt id="pypdevsbbl.generic.collectors.EstimateCollector">
    303. 

  303. <em class="property">class </em><code class="descclassname">pypdevsbbl.generic.collectors.</code><code class="descname">EstimateCollector</code><span class="sig-paren">(</span><em>name: str</em>, <em>b: int = 4</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector" title="Permalink to this definition">¶</a></dt>
    304. 

  304. <dd><p>Bases: <a class="reference internal" href="#pypdevsbbl.generic.collectors.BaseCollector" title="pypdevsbbl.generic.collectors.BaseCollector"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.collectors.BaseCollector</span></code></a></p>
    305. 

  305. <p>Collects information about items that arrive.</p>
    306. 

  306. <p>The EstimateCollector block is a block that keeps track of everything that
    307. 

  307. passes through, allowing it to yield important information.</p>
    308. 

  308. <p>Whereas the <a class="reference internal" href="#pypdevsbbl.generic.collectors.Collector" title="pypdevsbbl.generic.collectors.Collector"><code class="xref py py-class docutils literal notranslate"><span class="pre">Collector</span></code></a> can collect general information data, this
    309. 

  309. collector will use the <cite>P-squared Algorithm for Dynamic Calculation of
    310. 

  310. Quantiles and Histograms without Scoring Observations</cite>.</p>
    311. 

  311. <p>It has a <a class="reference internal" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState" title="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState"><code class="xref py py-class docutils literal notranslate"><span class="pre">CollectorState</span></code></a> class, which is used to handle the information
    312. 

  312. of passed-through items. Besides the <code class="docutils literal notranslate"><span class="pre">PythonPDEVS</span></code>-functionality, it also
    313. 

  313. has a function that can obtain all boxplot- and histogram-data, called
    314. 

  314. <a class="reference internal" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.histoplot" title="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.histoplot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">CollectorState.histoplot()</span></code></a>.</p>
    315. 

  315. <div class="admonition seealso">
    316. 

  316. <p class="first admonition-title">See also</p>
    317. 

  317. <ul class="last simple">
    318. 

  318. <li><a class="reference internal" href="pypdevsbbl.extra.mathutils.html#pypdevsbbl.extra.mathutils.histogram" title="pypdevsbbl.extra.mathutils.histogram"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pypdevsbbl.extra.mathutils.histogram()</span></code></a></li>
    319. 

  319. <li><a class="reference internal" href="pypdevsbbl.extra.mathutils.html#pypdevsbbl.extra.mathutils.histostep" title="pypdevsbbl.extra.mathutils.histostep"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pypdevsbbl.extra.mathutils.histostep()</span></code></a></li>
    320. 

  320. </ul>
    321. 

  321. </div>
    322. 

  322. <div align="center" class="align-center"><img alt="_images/estimate-collector.svg" src="_images/estimate-collector.svg" /></div>
    323. 

  323. <table class="docutils field-list" frame="void" rules="none">
    324. 

  324. <col class="field-name" />
    325. 

  325. <col class="field-body" />
    326. 

  326. <tbody valign="top">
    327. 

  327. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    328. 

  328. <li><strong>name</strong> (<em>str</em>) – The name of the EstimateCollector.</li>
    329. 

  329. <li><strong>b</strong> (<em>int</em>) – The amount of cells you want for the histogram.
    330. 

  330. 4 is often used, because it yields [min, Q1, median, Q3, max].
    331. 

  331. When 1 or less, the histogram will only keep track of the min
    332. 

  332. and the max. Defaults to 4.</li>
    333. 

  333. </ul>
    334. 

  334. </td>
    335. 

  335. </tr>
    336. 

  336. <tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><p class="first">See <a class="reference internal" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState" title="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState"><code class="xref py py-class docutils literal notranslate"><span class="pre">EstimateCollector.CollectorState</span></code></a>.</p>
    337. 

  337. </td>
    338. 

  338. </tr>
    339. 

  339. <tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first last simple">
    340. 

  340. <li><strong>input</strong> (<em>numeric</em>) – Obtains values.
    341. 

  341. Note that <code class="docutils literal notranslate"><span class="pre">INFINITY</span></code> inputs will shape the data in an undefined way.</li>
    342. 

  342. <li><strong>clear</strong> (<em>any</em>) – Clears the contents of the block.</li>
    343. 

  343. </ul>
    344. 

  344. </td>
    345. 

  345. </tr>
    346. 

  346. </tbody>
    347. 

  347. </table>
    348. 

  348. <dl class="class">
    349. 

  349. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState">
    350. 

  350. <em class="property">class </em><code class="descname">CollectorState</code><span class="sig-paren">(</span><em>b=4</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState" title="Permalink to this definition">¶</a></dt>
    351. 

  351. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    352. 

  352. <p>Helperclass for the EstimateCollector.</p>
    353. 

  353. <div class="admonition note">
    354. 

  354. <p class="first admonition-title">Note</p>
    355. 

  355. <p class="last">This class allows for the creation of boxplots and histogram, thanks to the
    356. 

  356. <a class="reference internal" href="pypdevsbbl.extra.mathutils.html#module-pypdevsbbl.extra.mathutils" title="pypdevsbbl.extra.mathutils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.extra.mathutils</span></code></a> module. This makes use of the <code class="docutils literal notranslate"><span class="pre">_hq</span></code>, <code class="docutils literal notranslate"><span class="pre">_hq0</span></code>,
    357. 

  357. <code class="docutils literal notranslate"><span class="pre">_hn</span></code> and <code class="docutils literal notranslate"><span class="pre">_hn0</span></code> attributes. Changing these will make it so the histogram,
    358. 

  358. min, max, median, Q1 and Q3 also changes, so please… <strong>DON’T</strong>.</p>
    359. 

  359. </div>
    360. 

  360. <p>For the sake of the P^2 algorithm, b (number of cells) is chosen to be 4.</p>
    361. 

  361. <table class="docutils field-list" frame="void" rules="none">
    362. 

  362. <col class="field-name" />
    363. 

  363. <col class="field-body" />
    364. 

  364. <tbody valign="top">
    365. 

  365. <tr class="field-odd field"><th class="field-name">Variables:</th><td class="field-body"><ul class="first simple">
    366. 

  366. <li><strong>N</strong> (<em>int</em>) – The total number of items that have arrived.</li>
    367. 

  367. <li><strong>N0</strong> (<em>int</em>) – The total number of non-zero items that have arrived.</li>
    368. 

  368. <li><strong>_b</strong> (<em>int</em>) – The amount of cells in the histogram.</li>
    369. 

  369. <li><strong>_hq</strong> (<em>list</em>) – Datavalues of the bars in the histogram of all items.
    370. 

  370. <strong>DON’T CHANGE THIS LIST!</strong></li>
    371. 

  371. <li><strong>_hq0</strong> (<em>list</em>) – Datavalues of the bars in the histogram of all non-zero items.
    372. 

  372. <strong>DON’T CHANGE THIS LIST!</strong></li>
    373. 

  373. <li><strong>_hn</strong> (<em>list</em>) – Positions of the bars in the histogram of all items.
    374. 

  374. <strong>DON’T CHANGE THIS LIST!</strong></li>
    375. 

  375. <li><strong>_hn0</strong> (<em>list</em>) – Positions of the bars in the histogram of all non-zero items.
    376. 

  376. <strong>DON’T CHANGE THIS LIST!</strong></li>
    377. 

  377. </ul>
    378. 

  378. </td>
    379. 

  379. </tr>
    380. 

  380. <tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first last"><strong>b</strong> (<em>int</em>) – The amount of cells you want for the histogram.
    381. 

  381. When 1 or less, the histogram will only keep track of the min and
    382. 

  382. the max. Defaults to 4.</p>
    383. 

  383. </td>
    384. 

  384. </tr>
    385. 

  385. </tbody>
    386. 

  386. </table>
    387. 

  387. <dl class="method">
    388. 

  388. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState._hstep">
    389. 

  389. <code class="descname">_hstep</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState._hstep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState._hstep" title="Permalink to this definition">¶</a></dt>
    390. 

  390. <dd><p>Do the histostep function of the mathutils on this state.</p>
    391. 

  391. <p>Additionally, this will do some size checks to make sure histostep can be executed correctly.
    392. 

  392. The general histogram will change.</p>
    393. 

  393. <div class="admonition seealso">
    394. 

  394. <p class="first admonition-title">See also</p>
    395. 

  395. <p class="last"><a class="reference internal" href="pypdevsbbl.extra.mathutils.html#pypdevsbbl.extra.mathutils.histogram" title="pypdevsbbl.extra.mathutils.histogram"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pypdevsbbl.extra.mathutils.histogram()</span></code></a></p>
    396. 

  396. </div>
    397. 

  397. <div class="admonition warning">
    398. 

  398. <p class="first admonition-title">Warning</p>
    399. 

  399. <p class="last">Only use this function if you know what you’re doing.</p>
    400. 

  400. </div>
    401. 

  401. <table class="docutils field-list" frame="void" rules="none">
    402. 

  402. <col class="field-name" />
    403. 

  403. <col class="field-body" />
    404. 

  404. <tbody valign="top">
    405. 

  405. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>val</strong> (<em>numeric</em>) – A value that passes through and must update the histogram.</td>
    406. 

  406. </tr>
    407. 

  407. </tbody>
    408. 

  408. </table>
    409. 

  409. </dd></dl>
    410. 

  410. 

  411. <dl class="method">
    412. 

  412. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState._hstep0">
    413. 

  413. <code class="descname">_hstep0</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState._hstep0"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState._hstep0" title="Permalink to this definition">¶</a></dt>
    414. 

  414. <dd><p>Do the histostep function of the mathutils on this state.</p>
    415. 

  415. <p>Additionally, this will do some size checks to make sure histostep can be executed correctly.
    416. 

  416. The non-zero histogram will change.</p>
    417. 

  417. <div class="admonition seealso">
    418. 

  418. <p class="first admonition-title">See also</p>
    419. 

  419. <p class="last"><a class="reference internal" href="pypdevsbbl.extra.mathutils.html#pypdevsbbl.extra.mathutils.histogram" title="pypdevsbbl.extra.mathutils.histogram"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pypdevsbbl.extra.mathutils.histogram()</span></code></a></p>
    420. 

  420. </div>
    421. 

  421. <div class="admonition warning">
    422. 

  422. <p class="first admonition-title">Warning</p>
    423. 

  423. <p class="last">Only use this function if you know what you’re doing.</p>
    424. 

  424. </div>
    425. 

  425. <table class="docutils field-list" frame="void" rules="none">
    426. 

  426. <col class="field-name" />
    427. 

  427. <col class="field-body" />
    428. 

  428. <tbody valign="top">
    429. 

  429. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>val</strong> (<em>numeric</em>) – A non-zero value that passes through and must update the histogram.</td>
    430. 

  430. </tr>
    431. 

  431. </tbody>
    432. 

  432. </table>
    433. 

  433. </dd></dl>
    434. 

  434. 

  435. <dl class="method">
    436. 

  436. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.min">
    437. 

  437. <code class="descname">min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState.min"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.min" title="Permalink to this definition">¶</a></dt>
    438. 

  438. <dd><p>Get the smallest value that has arrived.</p>
    439. 

  439. <table class="docutils field-list" frame="void" rules="none">
    440. 

  440. <col class="field-name" />
    441. 

  441. <col class="field-body" />
    442. 

  442. <tbody valign="top">
    443. 

  443. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The smallest value, or INFINITY if no values have arrived yet.</td>
    444. 

  444. </tr>
    445. 

  445. </tbody>
    446. 

  446. </table>
    447. 

  447. </dd></dl>
    448. 

  448. 

  449. <dl class="method">
    450. 

  450. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.min0">
    451. 

  451. <code class="descname">min0</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState.min0"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.min0" title="Permalink to this definition">¶</a></dt>
    452. 

  452. <dd><p>Get the smallest non-zero value that has arrived.</p>
    453. 

  453. <table class="docutils field-list" frame="void" rules="none">
    454. 

  454. <col class="field-name" />
    455. 

  455. <col class="field-body" />
    456. 

  456. <tbody valign="top">
    457. 

  457. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The smallest non-zero value, or INFINITY if no values have arrived yet.</td>
    458. 

  458. </tr>
    459. 

  459. </tbody>
    460. 

  460. </table>
    461. 

  461. </dd></dl>
    462. 

  462. 

  463. <dl class="method">
    464. 

  464. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.max">
    465. 

  465. <code class="descname">max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState.max"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.max" title="Permalink to this definition">¶</a></dt>
    466. 

  466. <dd><p>Get the largest value that has arrived.</p>
    467. 

  467. <table class="docutils field-list" frame="void" rules="none">
    468. 

  468. <col class="field-name" />
    469. 

  469. <col class="field-body" />
    470. 

  470. <tbody valign="top">
    471. 

  471. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The largest value, or -INFINITY if no values have arrived yet.</td>
    472. 

  472. </tr>
    473. 

  473. </tbody>
    474. 

  474. </table>
    475. 

  475. </dd></dl>
    476. 

  476. 

  477. <dl class="method">
    478. 

  478. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.max0">
    479. 

  479. <code class="descname">max0</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState.max0"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.max0" title="Permalink to this definition">¶</a></dt>
    480. 

  480. <dd><p>Get the largest non-zero value that has arrived.</p>
    481. 

  481. <table class="docutils field-list" frame="void" rules="none">
    482. 

  482. <col class="field-name" />
    483. 

  483. <col class="field-body" />
    484. 

  484. <tbody valign="top">
    485. 

  485. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The largest non-zero value, or -INFINITY if no values have arrived yet.</td>
    486. 

  486. </tr>
    487. 

  487. </tbody>
    488. 

  488. </table>
    489. 

  489. </dd></dl>
    490. 

  490. 

  491. <dl class="method">
    492. 

  492. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.histoplot">
    493. 

  493. <code class="descname">histoplot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.CollectorState.histoplot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.CollectorState.histoplot" title="Permalink to this definition">¶</a></dt>
    494. 

  494. <dd><p>Obtain all boxplot and histogram data from the state.</p>
    495. 

  495. <p>This function is meant to be used as an unpacking of all data and only
    496. 

  496. reads from the state. In fact, its result is a <em>copy</em> of the actual data,
    497. 

  497. making sure it remains immutable.</p>
    498. 

  498. <table class="docutils field-list" frame="void" rules="none">
    499. 

  499. <col class="field-name" />
    500. 

  500. <col class="field-body" />
    501. 

  501. <tbody valign="top">
    502. 

  502. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
    503. 

  503. <dt>A 4-tuple (q, h, q0, h0), where</dt>
    504. 

  504. <dd><ul class="first last simple">
    505. 

  505. <li>q (list):             Datavalues of the bars in the histogram of all items.</li>
    506. 

  506. <li>h (list):             Heights of the bars in the histogram, w.r.t. the item count.</li>
    507. 

  507. <li>q0 (list):    Datavalues of the bars in the histogram of all non-zero items.</li>
    508. 

  508. <li>h0 (list):    Heights of the bars in the histogram, w.r.t. the non-zero item count.</li>
    509. 

  509. </ul>
    510. 

  510. </dd>
    511. 

  511. </dl>
    512. 

  512. </td>
    513. 

  513. </tr>
    514. 

  514. </tbody>
    515. 

  515. </table>
    516. 

  516. <p class="rubric">Examples</p>
    517. 

  517. <ul class="simple">
    518. 

  518. <li>To plot the histogram of all items, use q as x-values and h as its y-values.</li>
    519. 

  519. <li>To plot the histogram of all non-zero items, use q0 as x-values and h0 as its y-values.</li>
    520. 

  520. <li>To plot the boxplot of all items, unpack q and use it as input in the
    521. 

  521. mathutils.draw_boxplot function (and plot it thereafter).</li>
    522. 

  522. <li>To plot the boxplot of all non-zero items, unpack q0 and use it as input in the
    523. 

  523. mathutils.draw_boxplot function (and plot it thereafter).</li>
    524. 

  524. </ul>
    525. 

  525. </dd></dl>
    526. 

  526. 

  527. </dd></dl>
    528. 

  528. 

  529. <dl class="method">
    530. 

  530. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.plot">
    531. 

  531. <code class="descname">plot</code><span class="sig-paren">(</span><em>axis</em>, <em>type='hist'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.plot" title="Permalink to this definition">¶</a></dt>
    532. 

  532. <dd><p>Plots the data of the collector.</p>
    533. 

  533. <table class="docutils field-list" frame="void" rules="none">
    534. 

  534. <col class="field-name" />
    535. 

  535. <col class="field-body" />
    536. 

  536. <tbody valign="top">
    537. 

  537. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    538. 

  538. <li><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</li>
    539. 

  539. <li><strong>type</strong> – <p>A string indicating which plot to create.
    540. 

  540. Defaults to <cite>‘hist’</cite>.</p>
    541. 

  541. <p>For the histogram, use any of
    542. 

  542. <code class="docutils literal notranslate"><span class="pre">['hist',</span> <span class="pre">'histogram',</span> <span class="pre">'bars',</span> <span class="pre">'H',</span> <span class="pre">'h',</span> <span class="pre">0]</span></code>.</p>
    543. 

  543. <p>For the boxplot, use any of
    544. 

  544. <code class="docutils literal notranslate"><span class="pre">['bxpt',</span> <span class="pre">'boxplot',</span> <span class="pre">'box',</span> <span class="pre">'B',</span> <span class="pre">'b',</span> <span class="pre">1]</span></code></p>
    545. 

  545. </li>
    546. 

  546. </ul>
    547. 

  547. </td>
    548. 

  548. </tr>
    549. 

  549. </tbody>
    550. 

  550. </table>
    551. 

  551. </dd></dl>
    552. 

  552. 

  553. <dl class="method">
    554. 

  554. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.plot_boxplot">
    555. 

  555. <code class="descname">plot_boxplot</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.plot_boxplot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.plot_boxplot" title="Permalink to this definition">¶</a></dt>
    556. 

  556. <dd><p>Plots the data of the collector as a boxplot.</p>
    557. 

  557. <table class="docutils field-list" frame="void" rules="none">
    558. 

  558. <col class="field-name" />
    559. 

  559. <col class="field-body" />
    560. 

  560. <tbody valign="top">
    561. 

  561. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</td>
    562. 

  562. </tr>
    563. 

  563. </tbody>
    564. 

  564. </table>
    565. 

  565. </dd></dl>
    566. 

  566. 

  567. <dl class="method">
    568. 

  568. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.plot_histogram">
    569. 

  569. <code class="descname">plot_histogram</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.plot_histogram"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.plot_histogram" title="Permalink to this definition">¶</a></dt>
    570. 

  570. <dd><p>Plots the data of the collector as a histogram.</p>
    571. 

  571. <table class="docutils field-list" frame="void" rules="none">
    572. 

  572. <col class="field-name" />
    573. 

  573. <col class="field-body" />
    574. 

  574. <tbody valign="top">
    575. 

  575. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</td>
    576. 

  576. </tr>
    577. 

  577. </tbody>
    578. 

  578. </table>
    579. 

  579. </dd></dl>
    580. 

  580. 

  581. <dl class="method">
    582. 

  582. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.extTransition">
    583. 

  583. <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/collectors.html#EstimateCollector.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.extTransition" title="Permalink to this definition">¶</a></dt>
    584. 

  584. <dd></dd></dl>
    585. 

  585. 

  586. <dl class="method">
    587. 

  587. <dt id="pypdevsbbl.generic.collectors.EstimateCollector.clearContents">
    588. 

  588. <code class="descname">clearContents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#EstimateCollector.clearContents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.EstimateCollector.clearContents" title="Permalink to this definition">¶</a></dt>
    589. 

  589. <dd></dd></dl>
    590. 

  590. 

  591. </dd></dl>
    592. 

  592. 

  593. <dl class="class">
    594. 

  594. <dt id="pypdevsbbl.generic.collectors.TableCollector">
    595. 

  595. <em class="property">class </em><code class="descclassname">pypdevsbbl.generic.collectors.</code><code class="descname">TableCollector</code><span class="sig-paren">(</span><em>name: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#TableCollector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.TableCollector" title="Permalink to this definition">¶</a></dt>
    596. 

  596. <dd><p>Bases: <a class="reference internal" href="#pypdevsbbl.generic.collectors.BaseCollector" title="pypdevsbbl.generic.collectors.BaseCollector"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.collectors.BaseCollector</span></code></a></p>
    597. 

  597. <p>Builds a table of all collected data.</p>
    598. 

  598. <p>Contrary to the other collectors, the TableCollector will create
    599. 

  599. a table from ALL data that arrived. This implies that the usage
    600. 

  600. of this component will allocate a lot of memory and, if you’re using
    601. 

  601. mere numerical data, will be overkill. Nevertheless, if your data is
    602. 

  602. not numerical, or you require to know when certain data arrived, this
    603. 

  603. collector is the one you need.</p>
    604. 

  604. <p>For every item that arrives, it will add another record in a table,
    605. 

  605. which is accessible as a dictionary (see the <a class="reference internal" href="#pypdevsbbl.generic.collectors.TableCollector.table" title="pypdevsbbl.generic.collectors.TableCollector.table"><code class="xref py py-meth docutils literal notranslate"><span class="pre">table()</span></code></a> method).</p>
    606. 

  606. <div align="center" class="align-center"><img alt="_images/table-collector.svg" src="_images/table-collector.svg" /></div>
    607. 

  607. <table class="docutils field-list" frame="void" rules="none">
    608. 

  608. <col class="field-name" />
    609. 

  609. <col class="field-body" />
    610. 

  610. <tbody valign="top">
    611. 

  611. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>name</strong> (<em>str</em>) – The name for the TableizeCollector.</p>
    612. 

  612. </td>
    613. 

  613. </tr>
    614. 

  614. <tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><p class="first"><strong>table</strong> (<em>list</em>) – The table, as a pair/tuple of (<cite>elapsed time</cite>, <cite>item</cite>)</p>
    615. 

  615. </td>
    616. 

  616. </tr>
    617. 

  617. <tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first last simple">
    618. 

  618. <li><strong>input</strong> (<em>any</em>) – Obtains values.</li>
    619. 

  619. <li><strong>clear</strong> (<em>any</em>) – Clears the contents of the block.</li>
    620. 

  620. </ul>
    621. 

  621. </td>
    622. 

  622. </tr>
    623. 

  623. </tbody>
    624. 

  624. </table>
    625. 

  625. <dl class="method">
    626. 

  626. <dt id="pypdevsbbl.generic.collectors.TableCollector.clearContents">
    627. 

  627. <code class="descname">clearContents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#TableCollector.clearContents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.TableCollector.clearContents" title="Permalink to this definition">¶</a></dt>
    628. 

  628. <dd></dd></dl>
    629. 

  629. 

  630. <dl class="method">
    631. 

  631. <dt id="pypdevsbbl.generic.collectors.TableCollector.extTransition">
    632. 

  632. <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/collectors.html#TableCollector.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.TableCollector.extTransition" title="Permalink to this definition">¶</a></dt>
    633. 

  633. <dd></dd></dl>
    634. 

  634. 

  635. <dl class="method">
    636. 

  636. <dt id="pypdevsbbl.generic.collectors.TableCollector.plot">
    637. 

  637. <code class="descname">plot</code><span class="sig-paren">(</span><em>axis</em>, <em>kwargs=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#TableCollector.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.TableCollector.plot" title="Permalink to this definition">¶</a></dt>
    638. 

  638. <dd><p>Plots the data of the collector.</p>
    639. 

  639. <table class="docutils field-list" frame="void" rules="none">
    640. 

  640. <col class="field-name" />
    641. 

  641. <col class="field-body" />
    642. 

  642. <tbody valign="top">
    643. 

  643. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    644. 

  644. <li><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</li>
    645. 

  645. <li><strong>kwargs</strong> – Dictionary of keyword arguments to pass to the
    646. 

  646. <code class="xref py py-meth docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.plot()</span></code> function.
    647. 

  647. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code> (= no arguments).</li>
    648. 

  648. </ul>
    649. 

  649. </td>
    650. 

  650. </tr>
    651. 

  651. </tbody>
    652. 

  652. </table>
    653. 

  653. </dd></dl>
    654. 

  654. 

  655. <dl class="method">
    656. 

  656. <dt id="pypdevsbbl.generic.collectors.TableCollector.table">
    657. 

  657. <code class="descname">table</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#TableCollector.table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.TableCollector.table" title="Permalink to this definition">¶</a></dt>
    658. 

  658. <dd><p>Fetches the table that was built upto this point in time.</p>
    659. 

  659. <dl class="docutils">
    660. 

  660. <dt>This table will be returned as a dict, in the form of</dt>
    661. 

  661. <dd><cite>elapsed time</cite> -&gt; <cite>item</cite></dd>
    662. 

  662. </dl>
    663. 

  663. <table class="docutils field-list" frame="void" rules="none">
    664. 

  664. <col class="field-name" />
    665. 

  665. <col class="field-body" />
    666. 

  666. <tbody valign="top">
    667. 

  667. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The table.</td>
    668. 

  668. </tr>
    669. 

  669. </tbody>
    670. 

  670. </table>
    671. 

  671. </dd></dl>
    672. 

  672. 

  673. </dd></dl>
    674. 

  674. 

  675. <dl class="class">
    676. 

  676. <dt id="pypdevsbbl.generic.collectors.Counter">
    677. 

  677. <em class="property">class </em><code class="descclassname">pypdevsbbl.generic.collectors.</code><code class="descname">Counter</code><span class="sig-paren">(</span><em>name: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter" title="Permalink to this definition">¶</a></dt>
    678. 

  678. <dd><p>Bases: <a class="reference internal" href="#pypdevsbbl.generic.collectors.BaseCollector" title="pypdevsbbl.generic.collectors.BaseCollector"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.collectors.BaseCollector</span></code></a></p>
    679. 

  679. <p>Counts the amount of arrived messages.</p>
    680. 

  680. <div align="center" class="align-center"><img alt="_images/counter.svg" src="_images/counter.svg" /></div>
    681. 

  681. <table class="docutils field-list" frame="void" rules="none">
    682. 

  682. <col class="field-name" />
    683. 

  683. <col class="field-body" />
    684. 

  684. <tbody valign="top">
    685. 

  685. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>name</strong> (<em>str</em>) – The name of the block.</p>
    686. 

  686. </td>
    687. 

  687. </tr>
    688. 

  688. <tr class="field-even field"><th class="field-name">State:</th><td class="field-body"><ul class="first simple">
    689. 

  689. <li><strong>item</strong> (<em>any</em>) – The current item.</li>
    690. 

  690. <li><strong>count</strong> (<em>int</em>) – The current count.</li>
    691. 

  691. </ul>
    692. 

  692. </td>
    693. 

  693. </tr>
    694. 

  694. <tr class="field-odd field"><th class="field-name">Input Ports:</th><td class="field-body"><ul class="first simple">
    695. 

  695. <li><strong>input</strong> (<em>any</em>) – The items that need to be counted.</li>
    696. 

  696. <li><strong>clear</strong> (<em>any</em>) – Clears the contents of the block.</li>
    697. 

  697. </ul>
    698. 

  698. </td>
    699. 

  699. </tr>
    700. 

  700. <tr class="field-even field"><th class="field-name">Output Ports:</th><td class="field-body"><ul class="first last simple">
    701. 

  701. <li><strong>output</strong> (<em>any</em>) – The item that was counted.</li>
    702. 

  702. <li><strong>count</strong> (<em>int</em>) – How many items have been counted, including the one
    703. 

  703. outputted on the <cite>output</cite> port.</li>
    704. 

  704. </ul>
    705. 

  705. </td>
    706. 

  706. </tr>
    707. 

  707. </tbody>
    708. 

  708. </table>
    709. 

  709. <dl class="method">
    710. 

  710. <dt id="pypdevsbbl.generic.collectors.Counter.plot">
    711. 

  711. <code class="descname">plot</code><span class="sig-paren">(</span><em>axis</em>, <em>pos=(0.5</em>, <em>0.5)</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.plot" title="Permalink to this definition">¶</a></dt>
    712. 

  712. <dd><p>Plots the counted info</p>
    713. 

  713. <table class="docutils field-list" frame="void" rules="none">
    714. 

  714. <col class="field-name" />
    715. 

  715. <col class="field-body" />
    716. 

  716. <tbody valign="top">
    717. 

  717. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    718. 

  718. <li><strong>axis</strong> – The <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code> axis to plot on.</li>
    719. 

  719. <li><strong>pos</strong> – The position to plot the data. Must be
    720. 

  720. in [0, 1] for both x and y to be visible.
    721. 

  721. Defaults to <code class="docutils literal notranslate"><span class="pre">(0.5,</span> <span class="pre">0.5)</span></code>.</li>
    722. 

  722. </ul>
    723. 

  723. </td>
    724. 

  724. </tr>
    725. 

  725. </tbody>
    726. 

  726. </table>
    727. 

  727. </dd></dl>
    728. 

  728. 

  729. <dl class="method">
    730. 

  730. <dt id="pypdevsbbl.generic.collectors.Counter.clearContents">
    731. 

  731. <code class="descname">clearContents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter.clearContents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.clearContents" title="Permalink to this definition">¶</a></dt>
    732. 

  732. <dd></dd></dl>
    733. 

  733. 

  734. <dl class="method">
    735. 

  735. <dt id="pypdevsbbl.generic.collectors.Counter.timeAdvance">
    736. 

  736. <code class="descname">timeAdvance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter.timeAdvance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.timeAdvance" title="Permalink to this definition">¶</a></dt>
    737. 

  737. <dd></dd></dl>
    738. 

  738. 

  739. <dl class="method">
    740. 

  740. <dt id="pypdevsbbl.generic.collectors.Counter.extTransition">
    741. 

  741. <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/collectors.html#Counter.extTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.extTransition" title="Permalink to this definition">¶</a></dt>
    742. 

  742. <dd></dd></dl>
    743. 

  743. 

  744. <dl class="method">
    745. 

  745. <dt id="pypdevsbbl.generic.collectors.Counter.outputFnc">
    746. 

  746. <code class="descname">outputFnc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter.outputFnc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.outputFnc" title="Permalink to this definition">¶</a></dt>
    747. 

  747. <dd></dd></dl>
    748. 

  748. 

  749. <dl class="method">
    750. 

  750. <dt id="pypdevsbbl.generic.collectors.Counter.intTransition">
    751. 

  751. <code class="descname">intTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/generic/collectors.html#Counter.intTransition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.generic.collectors.Counter.intTransition" title="Permalink to this definition">¶</a></dt>
    752. 

  752. <dd></dd></dl>
    753. 

  753. 

  754. </dd></dl>
    755. 

  755. 

  756. </div>
    757. 

  757. 

  758. 

  759.           </div>
    760. 

  760.         </div>
    761. 

  761.       </div>
    762. 

  762.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    763. 

  763.         <div class="sphinxsidebarwrapper">
    764. 

  764.   <h4>Previous topic</h4>
    765. 

  765.   <p class="topless"><a href="pypdevsbbl.generic.html"
    766. 

  766.                         title="previous chapter">pypdevsbbl.generic package</a></p>
    767. 

  767.   <h4>Next topic</h4>
    768. 

  768.   <p class="topless"><a href="pypdevsbbl.generic.generators.html"
    769. 

  769.                         title="next chapter">pypdevsbbl.generic.generators module</a></p>
    770. 

  770. <div id="searchbox" style="display: none" role="search">
    771. 

  771.   <h3>Quick search</h3>
    772. 

  772.     <div class="searchformwrapper">
    773. 

  773.     <form class="search" action="search.html" method="get">
    774. 

  774.       <input type="text" name="q" />
    775. 

  775.       <input type="submit" value="Go" />
    776. 

  776.       <input type="hidden" name="check_keywords" value="yes" />
    777. 

  777.       <input type="hidden" name="area" value="default" />
    778. 

  778.     </form>
    779. 

  779.     </div>
    780. 

  780. </div>
    781. 

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

  782.         </div>
    783. 

  783.       </div>
    784. 

  784.       <div class="clearer"></div>
    785. 

  785.     </div>
    786. 

  786.     <div class="related" role="navigation" aria-label="related navigation">
    787. 

  787.       <h3>Navigation</h3>
    788. 

  788.       <ul>
    789. 

  789.         <li class="right" style="margin-right: 10px">
    790. 

  790.           <a href="genindex.html" title="General Index"
    791. 

  791.              >index</a></li>
    792. 

  792.         <li class="right" >
    793. 

  793.           <a href="py-modindex.html" title="Python Module Index"
    794. 

  794.              >modules</a> |</li>
    795. 

  795.         <li class="right" >
    796. 

  796.           <a href="pypdevsbbl.generic.generators.html" title="pypdevsbbl.generic.generators module"
    797. 

  797.              >next</a> |</li>
    798. 

  798.         <li class="right" >
    799. 

  799.           <a href="pypdevsbbl.generic.html" title="pypdevsbbl.generic package"
    800. 

  800.              >previous</a> |</li>
    801. 

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

  802.           <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
    803. 

  803.           <li class="nav-item nav-item-2"><a href="pypdevsbbl.generic.html" >pypdevsbbl.generic package</a> &#187;</li> 
    804. 

  804.       </ul>
    805. 

  805.     </div>
    806. 

  806.     <div class="footer" role="contentinfo">
    807. 

  807.         &#169; Copyright 2020, Randy Paredis.
    808. 

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

  809.     </div>
    810. 

  810.   </body>
    811. 

  811. </html>
    812.