StatisticsTracer.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <title>pypdevsbbl.tracers.StatisticsTracer &#8212; Python(P)DEVS-BBL documentation</title>
  8. <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
  9. <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  10. <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
  11. <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
  12. <script type="text/javascript" src="../../../_static/jquery.js"></script>
  13. <script type="text/javascript" src="../../../_static/underscore.js"></script>
  14. <script type="text/javascript" src="../../../_static/doctools.js"></script>
  15. <script type="text/javascript" src="../../../_static/language_data.js"></script>
  16. <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>
  17. <link rel="index" title="Index" href="../../../genindex.html" />
  18. <link rel="search" title="Search" href="../../../search.html" />
  19. </head><body>
  20. <div class="related" role="navigation" aria-label="related navigation">
  21. <h3>Navigation</h3>
  22. <ul>
  23. <li class="right" style="margin-right: 10px">
  24. <a href="../../../genindex.html" title="General Index"
  25. accesskey="I">index</a></li>
  26. <li class="right" >
  27. <a href="../../../py-modindex.html" title="Python Module Index"
  28. >modules</a> |</li>
  29. <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  30. <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
  31. <li class="nav-item nav-item-2"><a href="../tracers.html" accesskey="U">pypdevsbbl.tracers</a> &#187;</li>
  32. </ul>
  33. </div>
  34. <div class="document">
  35. <div class="documentwrapper">
  36. <div class="bodywrapper">
  37. <div class="body" role="main">
  38. <h1>Source code for pypdevsbbl.tracers.StatisticsTracer</h1><div class="highlight"><pre>
  39. <span></span><span class="c1"># Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
  40. <span class="c1"># McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
  41. <span class="c1">#</span>
  42. <span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
  43. <span class="c1"># you may not use this file except in compliance with the License.</span>
  44. <span class="c1"># You may obtain a copy of the License at</span>
  45. <span class="c1">#</span>
  46. <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
  47. <span class="c1">#</span>
  48. <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
  49. <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
  50. <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
  51. <span class="c1"># See the License for the specific language governing permissions and</span>
  52. <span class="c1"># limitations under the License.</span>
  53. <span class="sd">&quot;&quot;&quot;This file contains the tracer for statistical data.&quot;&quot;&quot;</span>
  54. <span class="kn">from</span> <span class="nn">pypdevsbbl.tracers</span> <span class="kn">import</span> <span class="n">BaseTracer</span>
  55. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  56. <span class="kn">from</span> <span class="nn">pypdevs.DEVS</span> <span class="kn">import</span> <span class="n">CoupledDEVS</span>
  57. <span class="kn">from</span> <span class="nn">pypdevs.minimal</span> <span class="kn">import</span> <span class="n">CoupledDEVS</span> <span class="k">as</span> <span class="n">minCoupledDEVS</span>
  58. <div class="viewcode-block" id="StatisticsTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer">[docs]</a><span class="k">class</span> <span class="nc">StatisticsTracer</span><span class="p">(</span><span class="n">BaseTracer</span><span class="p">):</span>
  59. <span class="sd">&quot;&quot;&quot;Gathers information about the messages in a (sub)model.</span>
  60. <span class="sd"> It can compute:</span>
  61. <span class="sd"> - The average time of messages in the system.</span>
  62. <span class="sd"> - The average amount of messages in the system for a certain</span>
  63. <span class="sd"> time period.</span>
  64. <span class="sd"> - The (amount of) messages that entered the system.</span>
  65. <span class="sd"> - The (amount of) messages that left the system.</span>
  66. <span class="sd"> - The (amount of) messages that were newly generated.</span>
  67. <span class="sd"> - The (amount of) messages that were discarded or left behind.</span>
  68. <span class="sd"> The internal depiction of a message is a tiplet:</span>
  69. <span class="sd"> ``(message, arrival time, departure time)``.</span>
  70. <span class="sd"> Note:</span>
  71. <span class="sd"> The tracer makes use of the :meth:`id` function to determine</span>
  72. <span class="sd"> which message entered and left. When your messages may change</span>
  73. <span class="sd"> order (when using a different queueing discipline or so), make</span>
  74. <span class="sd"> sure the messages can be uniquely identified afterwards.</span>
  75. <span class="sd"> It would also be non-sensical to have a</span>
  76. <span class="sd"> :class:`pypdevsbbl.generic.generators.ConstantGenerator` generate a</span>
  77. <span class="sd"> single value and change the order in which they arrive. All</span>
  78. <span class="sd"> messages are the same, so how would you determine they have</span>
  79. <span class="sd"> a different order of arrival?</span>
  80. <span class="sd"> Args:</span>
  81. <span class="sd"> uid: A unique identifier for distributed simulation.</span>
  82. <span class="sd"> Will be set automatically.</span>
  83. <span class="sd"> server: The server that runs the distributed simulation.</span>
  84. <span class="sd"> Will be set automatically.</span>
  85. <span class="sd"> filename (str): The name of the file to write the results to.</span>
  86. <span class="sd"> When ``None``, all results will be written to the</span>
  87. <span class="sd"> standard output.</span>
  88. <span class="sd"> inports (list): A list of the input ports to listen on for events</span>
  89. <span class="sd"> that enter the system. These may be ports of a</span>
  90. <span class="sd"> coupled DEVS.</span>
  91. <span class="sd"> outports (list): A list of the output ports to listen on for events</span>
  92. <span class="sd"> that leave the system. These may be ports of a</span>
  93. <span class="sd"> coupled DEVS.</span>
  94. <span class="sd"> &quot;&quot;&quot;</span>
  95. <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">inports</span><span class="p">,</span> <span class="n">outports</span><span class="p">):</span>
  96. <span class="nb">super</span><span class="p">(</span><span class="n">StatisticsTracer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">uid</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
  97. <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">inports</span><span class="p">:</span>
  98. <span class="k">if</span> <span class="ow">not</span> <span class="n">p</span><span class="o">.</span><span class="n">is_input</span><span class="p">:</span>
  99. <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Inport must be an input port in </span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">host_DEVS</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
  100. <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">outports</span><span class="p">:</span>
  101. <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">is_input</span><span class="p">:</span>
  102. <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Outport must be an output port in </span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">host_DEVS</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
  103. <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="o">=</span> <span class="p">{}</span>
  104. <span class="c1"># Internally solve coupled DEVS</span>
  105. <span class="c1"># This is needed because of the flattening the DEVS simulator applies.</span>
  106. <span class="bp">self</span><span class="o">.</span><span class="n">inports</span> <span class="o">=</span> <span class="p">[]</span>
  107. <span class="bp">self</span><span class="o">.</span><span class="n">inDEVS</span> <span class="o">=</span> <span class="p">[]</span>
  108. <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">inports</span><span class="p">:</span>
  109. <span class="k">if</span> <span class="n">port</span><span class="o">.</span><span class="n">type</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">&#39;INPORT&#39;</span><span class="p">:</span>
  110. <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Can only listen on inports for messages that enter the submodel.&quot;</span><span class="p">)</span>
  111. <span class="n">dvs</span> <span class="o">=</span> <span class="n">port</span><span class="o">.</span><span class="n">host_DEVS</span>
  112. <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">dvs</span><span class="p">),</span> <span class="p">(</span><span class="n">CoupledDEVS</span><span class="p">,</span> <span class="n">minCoupledDEVS</span><span class="p">)):</span>
  113. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">port</span><span class="o">.</span><span class="n">outline</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># Useless to listen on a port that&#39;s not connected</span>
  114. <span class="c1"># The message will be inputted to all connected ports, so only listening on one port</span>
  115. <span class="c1"># should be sufficient.</span>
  116. <span class="c1"># All ports in the port.outline list are INPORTs by definition.</span>
  117. <span class="n">p</span> <span class="o">=</span> <span class="n">port</span><span class="o">.</span><span class="n">outline</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  118. <span class="bp">self</span><span class="o">.</span><span class="n">inports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
  119. <span class="bp">self</span><span class="o">.</span><span class="n">inDEVS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">host_DEVS</span><span class="p">)</span>
  120. <span class="k">else</span><span class="p">:</span> <span class="c1"># Default fuctionality</span>
  121. <span class="bp">self</span><span class="o">.</span><span class="n">inports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
  122. <span class="bp">self</span><span class="o">.</span><span class="n">inDEVS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dvs</span><span class="p">)</span>
  123. <span class="bp">self</span><span class="o">.</span><span class="n">outports</span> <span class="o">=</span> <span class="p">[]</span>
  124. <span class="bp">self</span><span class="o">.</span><span class="n">outDEVS</span> <span class="o">=</span> <span class="p">[]</span>
  125. <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">outports</span><span class="p">:</span>
  126. <span class="k">if</span> <span class="n">port</span><span class="o">.</span><span class="n">type</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">&#39;OUTPORT&#39;</span><span class="p">:</span>
  127. <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Can only listen on outports for messages that leave the submodel.&quot;</span><span class="p">)</span>
  128. <span class="n">dvs</span> <span class="o">=</span> <span class="n">port</span><span class="o">.</span><span class="n">host_DEVS</span>
  129. <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">dvs</span><span class="p">),</span> <span class="p">(</span><span class="n">CoupledDEVS</span><span class="p">,</span> <span class="n">minCoupledDEVS</span><span class="p">)):</span>
  130. <span class="c1"># All messages arriving on this port will be outputted, so we have a set of outputs</span>
  131. <span class="c1"># All ports in the port.inline list are OUTPORTs by definition.</span>
  132. <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">port</span><span class="o">.</span><span class="n">inline</span><span class="p">:</span>
  133. <span class="bp">self</span><span class="o">.</span><span class="n">outports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
  134. <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">host_DEVS</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">outDEVS</span><span class="p">:</span>
  135. <span class="bp">self</span><span class="o">.</span><span class="n">outDEVS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">host_DEVS</span><span class="p">)</span>
  136. <span class="k">else</span><span class="p">:</span> <span class="c1"># Default functionality</span>
  137. <span class="bp">self</span><span class="o">.</span><span class="n">outports</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
  138. <span class="bp">self</span><span class="o">.</span><span class="n">inDEVS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dvs</span><span class="p">)</span>
  139. <div class="viewcode-block" id="StatisticsTracer.startTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.startTracer">[docs]</a> <span class="k">def</span> <span class="nf">startTracer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recover</span><span class="p">):</span>
  140. <span class="nb">super</span><span class="p">(</span><span class="n">StatisticsTracer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">startTracer</span><span class="p">(</span><span class="n">recover</span><span class="p">)</span>
  141. <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;STATISTICS:</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
  142. <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;===========</span><span class="se">\n\t</span><span class="s2">RUNNING...&quot;</span><span class="p">)</span></div>
  143. <div class="viewcode-block" id="StatisticsTracer.stopTracer"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.stopTracer">[docs]</a> <span class="k">def</span> <span class="nf">stopTracer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  144. <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\r\t</span><span class="s2">SUMMARY:</span><span class="se">\t\n</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">summary</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\t\t</span><span class="s1">&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
  145. <span class="nb">super</span><span class="p">(</span><span class="n">StatisticsTracer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">stopTracer</span><span class="p">()</span></div>
  146. <div class="viewcode-block" id="StatisticsTracer.traceExternal"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceExternal">[docs]</a> <span class="k">def</span> <span class="nf">traceExternal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
  147. <span class="sd">&quot;&quot;&quot;Trace messages that enter the system.&quot;&quot;&quot;</span>
  148. <span class="n">dvs</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">model</span>
  149. <span class="k">if</span> <span class="n">dvs</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">inDEVS</span><span class="p">:</span>
  150. <span class="n">inps</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">my_input</span>
  151. <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">inports</span><span class="p">:</span>
  152. <span class="k">if</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">inps</span><span class="p">:</span>
  153. <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">inps</span><span class="p">[</span><span class="n">port</span><span class="p">]:</span>
  154. <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">p</span><span class="p">),</span> <span class="p">[</span><span class="n">p</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">])[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">time_last</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div>
  155. <div class="viewcode-block" id="StatisticsTracer.traceInternal"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceInternal">[docs]</a> <span class="k">def</span> <span class="nf">traceInternal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aDEVS</span><span class="p">):</span>
  156. <span class="sd">&quot;&quot;&quot;Trace messages that leave the system.&quot;&quot;&quot;</span>
  157. <span class="n">dvs</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">model</span>
  158. <span class="k">if</span> <span class="n">dvs</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">outDEVS</span><span class="p">:</span>
  159. <span class="n">outs</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">my_output</span>
  160. <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">outports</span><span class="p">:</span>
  161. <span class="k">if</span> <span class="n">port</span> <span class="ow">in</span> <span class="n">outs</span><span class="p">:</span>
  162. <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">outs</span><span class="p">[</span><span class="n">port</span><span class="p">]:</span>
  163. <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="nb">id</span><span class="p">(</span><span class="n">p</span><span class="p">),</span> <span class="p">[</span><span class="n">p</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">])[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">aDEVS</span><span class="o">.</span><span class="n">time_last</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div>
  164. <div class="viewcode-block" id="StatisticsTracer.summary"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.summary">[docs]</a> <span class="k">def</span> <span class="nf">summary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s1">&#39;</span><span class="se">\t</span><span class="s1">&#39;</span><span class="p">):</span>
  165. <span class="sd">&quot;&quot;&quot;Gets the current stats as a string.&quot;&quot;&quot;</span>
  166. <span class="n">summ</span> <span class="o">=</span> <span class="p">[</span>
  167. <span class="s2">&quot;Average Time in System: </span><span class="si">%.5f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">average_time_in_system</span><span class="p">(),</span>
  168. <span class="s2">&quot;Average Num of Messages per Time Unit: </span><span class="si">%.5f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">average_num</span><span class="p">(),</span>
  169. <span class="s2">&quot;Total Throughput: </span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_passed</span><span class="p">(),</span>
  170. <span class="s2">&quot;Total Amount of Arrivals: </span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_entries</span><span class="p">(),</span>
  171. <span class="s2">&quot;Total Amount of Departures: </span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_exits</span><span class="p">(),</span>
  172. <span class="s2">&quot;Amount of Newly Generated Messages: </span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_new</span><span class="p">(),</span>
  173. <span class="s2">&quot;Amount of Bequeathed Messages: </span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_bequeathed</span><span class="p">()</span>
  174. <span class="p">]</span>
  175. <span class="k">return</span> <span class="n">prefix</span> <span class="o">+</span> <span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="n">prefix</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">summ</span><span class="p">)</span></div>
  176. <div class="viewcode-block" id="StatisticsTracer.average_time_in_system"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_time_in_system">[docs]</a> <span class="k">def</span> <span class="nf">average_time_in_system</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  177. <span class="sd">&quot;&quot;&quot;Reports the average time a message remained in the system.</span>
  178. <span class="sd"> Note:</span>
  179. <span class="sd"> This ignores all newly created and bequeathed messages.</span>
  180. <span class="sd"> &quot;&quot;&quot;</span>
  181. <span class="n">msgs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">passed</span><span class="p">()</span>
  182. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">msgs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
  183. <span class="k">return</span> <span class="mi">0</span>
  184. <span class="n">avg</span> <span class="o">=</span> <span class="mi">0</span>
  185. <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">msgs</span><span class="p">:</span>
  186. <span class="n">avg</span> <span class="o">+=</span> <span class="n">d</span> <span class="o">-</span> <span class="n">a</span>
  187. <span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">avg</span><span class="p">)</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">msgs</span><span class="p">)</span></div>
  188. <div class="viewcode-block" id="StatisticsTracer.average_num"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_num">[docs]</a> <span class="k">def</span> <span class="nf">average_num</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dx</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  189. <span class="sd">&quot;&quot;&quot;Reports the average amount of messages for a certain time period.</span>
  190. <span class="sd"> Note:</span>
  191. <span class="sd"> This ignores all newly created and bequeathed messages.</span>
  192. <span class="sd"> Args:</span>
  193. <span class="sd"> dx (numeric): The time period to look over. Defaults to 1.</span>
  194. <span class="sd"> start (numeric): The point in time to start measuring from.</span>
  195. <span class="sd"> When ``None``, it will use the first seen</span>
  196. <span class="sd"> arrival as a starting point. Defaults to 0</span>
  197. <span class="sd"> (= usually the start of the simulation).</span>
  198. <span class="sd"> end (numeric): The point in time to end measuring at. When</span>
  199. <span class="sd"> ``None``, it will use the last seen departure</span>
  200. <span class="sd"> as an end point. This point is inclusive in</span>
  201. <span class="sd"> the range. Defaults to ``None``.</span>
  202. <span class="sd"> &quot;&quot;&quot;</span>
  203. <span class="c1"># Create dictionaries for all arrival and departures</span>
  204. <span class="n">msgs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">passed</span><span class="p">()</span>
  205. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">msgs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
  206. <span class="k">return</span> <span class="mi">0</span>
  207. <span class="n">arr</span> <span class="o">=</span> <span class="p">{}</span>
  208. <span class="n">dep</span> <span class="o">=</span> <span class="p">{}</span>
  209. <span class="k">for</span> <span class="n">v</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">msgs</span><span class="p">:</span>
  210. <span class="n">arr</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">v</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">d</span><span class="p">))</span>
  211. <span class="n">dep</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">v</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">d</span><span class="p">))</span>
  212. <span class="c1"># Dicts are not sorted</span>
  213. <span class="n">sarr</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
  214. <span class="n">sdep</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">dep</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
  215. <span class="n">times</span> <span class="o">=</span> <span class="p">[]</span>
  216. <span class="n">prev</span> <span class="o">=</span> <span class="p">[]</span>
  217. <span class="n">last</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">arr</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="k">if</span> <span class="n">start</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">start</span>
  218. <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">last</span> <span class="o">+</span> <span class="n">dx</span><span class="p">,</span> <span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="n">dep</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="k">if</span> <span class="n">end</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">end</span><span class="p">)</span> <span class="o">+</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">dx</span><span class="p">,</span> <span class="n">dx</span><span class="p">):</span>
  219. <span class="n">curr</span> <span class="o">=</span> <span class="n">prev</span>
  220. <span class="c1"># Add all arriving messages in the time period</span>
  221. <span class="k">for</span> <span class="n">sa</span> <span class="ow">in</span> <span class="p">(</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">sarr</span> <span class="k">if</span> <span class="n">last</span> <span class="o">&lt;=</span> <span class="n">x</span> <span class="o">&lt;</span> <span class="n">t</span><span class="p">):</span>
  222. <span class="n">curr</span> <span class="o">+=</span> <span class="n">arr</span><span class="p">[</span><span class="n">sa</span><span class="p">]</span>
  223. <span class="c1"># Remove all departing messages in the time period</span>
  224. <span class="k">for</span> <span class="n">sd</span> <span class="ow">in</span> <span class="p">(</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">sdep</span> <span class="k">if</span> <span class="n">last</span> <span class="o">&lt;=</span> <span class="n">x</span> <span class="o">&lt;</span> <span class="n">t</span><span class="p">):</span>
  225. <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">dep</span><span class="p">[</span><span class="n">sd</span><span class="p">]:</span>
  226. <span class="n">curr</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
  227. <span class="n">prev</span> <span class="o">=</span> <span class="n">curr</span><span class="p">[:]</span>
  228. <span class="n">times</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">curr</span><span class="p">)</span>
  229. <span class="n">last</span> <span class="o">=</span> <span class="n">t</span>
  230. <span class="k">return</span> <span class="nb">sum</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="n">times</span><span class="p">))</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">times</span><span class="p">)</span></div>
  231. <div class="viewcode-block" id="StatisticsTracer.entries"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.entries">[docs]</a> <span class="k">def</span> <span class="nf">entries</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  232. <span class="sd">&quot;&quot;&quot;Reports all messages that entered the system.&quot;&quot;&quot;</span>
  233. <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span></div>
  234. <div class="viewcode-block" id="StatisticsTracer.n_entries"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_entries">[docs]</a> <span class="k">def</span> <span class="nf">n_entries</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  235. <span class="sd">&quot;&quot;&quot;Reports the amount of messages that entered the system.&quot;&quot;&quot;</span>
  236. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">entries</span><span class="p">())</span></div>
  237. <div class="viewcode-block" id="StatisticsTracer.exits"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.exits">[docs]</a> <span class="k">def</span> <span class="nf">exits</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  238. <span class="sd">&quot;&quot;&quot;Reports all messages that left the system.&quot;&quot;&quot;</span>
  239. <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span></div>
  240. <div class="viewcode-block" id="StatisticsTracer.n_exits"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_exits">[docs]</a> <span class="k">def</span> <span class="nf">n_exits</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  241. <span class="sd">&quot;&quot;&quot;Reports the amount of messages that left the system.&quot;&quot;&quot;</span>
  242. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">exits</span><span class="p">())</span></div>
  243. <div class="viewcode-block" id="StatisticsTracer.passed"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.passed">[docs]</a> <span class="k">def</span> <span class="nf">passed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  244. <span class="sd">&quot;&quot;&quot;Reports all messages that passed through the system.&quot;&quot;&quot;</span>
  245. <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span></div>
  246. <div class="viewcode-block" id="StatisticsTracer.n_passed"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_passed">[docs]</a> <span class="k">def</span> <span class="nf">n_passed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  247. <span class="sd">&quot;&quot;&quot;Reports the amount of messages that passed through the system.&quot;&quot;&quot;</span>
  248. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">passed</span><span class="p">())</span></div>
  249. <div class="viewcode-block" id="StatisticsTracer.new"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.new">[docs]</a> <span class="k">def</span> <span class="nf">new</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  250. <span class="sd">&quot;&quot;&quot;Reports all messages that were generated in the submodel.&quot;&quot;&quot;</span>
  251. <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">]</span></div>
  252. <div class="viewcode-block" id="StatisticsTracer.n_new"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_new">[docs]</a> <span class="k">def</span> <span class="nf">n_new</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  253. <span class="sd">&quot;&quot;&quot;Reports the amount of messages that were generated in the submodel.&quot;&quot;&quot;</span>
  254. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">new</span><span class="p">())</span></div>
  255. <div class="viewcode-block" id="StatisticsTracer.bequeathed"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.bequeathed">[docs]</a> <span class="k">def</span> <span class="nf">bequeathed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  256. <span class="sd">&quot;&quot;&quot;Reports all messages that were dropped or left behind in the submodel.&quot;&quot;&quot;</span>
  257. <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">[</span><span class="n">x</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">]</span></div>
  258. <div class="viewcode-block" id="StatisticsTracer.n_bequeathed"><a class="viewcode-back" href="../../../pypdevsbbl.tracers.StatisticsTracer.html#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_bequeathed">[docs]</a> <span class="k">def</span> <span class="nf">n_bequeathed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  259. <span class="sd">&quot;&quot;&quot;Reports the amount of messages that were dropped or left behind in the submodel.&quot;&quot;&quot;</span>
  260. <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bequeathed</span><span class="p">())</span></div>
  261. <span class="n">forgotten</span> <span class="o">=</span> <span class="n">bequeathed</span>
  262. <span class="sd">&quot;&quot;&quot;Alias for :meth:`bequeathed`, because, although less accurate, it is easier to remember.&quot;&quot;&quot;</span>
  263. <span class="n">n_forgotten</span> <span class="o">=</span> <span class="n">n_bequeathed</span>
  264. <span class="sd">&quot;&quot;&quot;Alias for :meth:`n_bequeathed`, because, although less accurate, it is easier to remember.&quot;&quot;&quot;</span></div>
  265. </pre></div>
  266. </div>
  267. </div>
  268. </div>
  269. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  270. <div class="sphinxsidebarwrapper">
  271. <div id="searchbox" style="display: none" role="search">
  272. <h3>Quick search</h3>
  273. <div class="searchformwrapper">
  274. <form class="search" action="../../../search.html" method="get">
  275. <input type="text" name="q" />
  276. <input type="submit" value="Go" />
  277. <input type="hidden" name="check_keywords" value="yes" />
  278. <input type="hidden" name="area" value="default" />
  279. </form>
  280. </div>
  281. </div>
  282. <script type="text/javascript">$('#searchbox').show(0);</script>
  283. </div>
  284. </div>
  285. <div class="clearer"></div>
  286. </div>
  287. <div class="related" role="navigation" aria-label="related navigation">
  288. <h3>Navigation</h3>
  289. <ul>
  290. <li class="right" style="margin-right: 10px">
  291. <a href="../../../genindex.html" title="General Index"
  292. >index</a></li>
  293. <li class="right" >
  294. <a href="../../../py-modindex.html" title="Python Module Index"
  295. >modules</a> |</li>
  296. <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  297. <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
  298. <li class="nav-item nav-item-2"><a href="../tracers.html" >pypdevsbbl.tracers</a> &#187;</li>
  299. </ul>
  300. </div>
  301. <div class="footer" role="contentinfo">
  302. &#169; Copyright 2020, Randy Paredis.
  303. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
  304. </div>
  305. </body>
  306. </html>