pypdevsbbl.extra.equations.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561
  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.extra.equations module &#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. <link rel="next" title="pypdevsbbl.extra.fileutils module" href="pypdevsbbl.extra.fileutils.html" />
  20. <link rel="prev" title="pypdevsbbl.extra.rngstreams.distributions module" href="pypdevsbbl.extra.rngstreams.distributions.html" />
  21. </head><body>
  22. <div class="related" role="navigation" aria-label="related navigation">
  23. <h3>Navigation</h3>
  24. <ul>
  25. <li class="right" style="margin-right: 10px">
  26. <a href="genindex.html" title="General Index"
  27. accesskey="I">index</a></li>
  28. <li class="right" >
  29. <a href="py-modindex.html" title="Python Module Index"
  30. >modules</a> |</li>
  31. <li class="right" >
  32. <a href="pypdevsbbl.extra.fileutils.html" title="pypdevsbbl.extra.fileutils module"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="pypdevsbbl.extra.rngstreams.distributions.html" title="pypdevsbbl.extra.rngstreams.distributions module"
  36. accesskey="P">previous</a> |</li>
  37. <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  38. <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
  39. <li class="nav-item nav-item-2"><a href="pypdevsbbl.extra.html" accesskey="U">pypdevsbbl.extra package</a> &#187;</li>
  40. </ul>
  41. </div>
  42. <div class="document">
  43. <div class="documentwrapper">
  44. <div class="bodywrapper">
  45. <div class="body" role="main">
  46. <div class="section" id="module-pypdevsbbl.extra.equations">
  47. <span id="pypdevsbbl-extra-equations-module"></span><h1>pypdevsbbl.extra.equations module<a class="headerlink" href="#module-pypdevsbbl.extra.equations" title="Permalink to this headline">¶</a></h1>
  48. <p>This file contains a set of mathematical equations as functions.</p>
  49. <p>These equations can be used as an input for the <a class="reference internal" href="pypdevsbbl.generic.math.html#pypdevsbbl.generic.math.Equation" title="pypdevsbbl.generic.math.Equation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.math.Equation</span></code></a>
  50. block for simplicity.</p>
  51. <div class="admonition note">
  52. <p class="first admonition-title">Note</p>
  53. <p class="last">The described functions were written with the idea of numerical values as
  54. inputs. While it is advised to refrain from using non-numerical arguments,
  55. it is allowed within <em>Python</em>. There are no guarantees on what might happen
  56. if you decide to use non-numeric input.</p>
  57. </div>
  58. <dl class="function">
  59. <dt id="pypdevsbbl.extra.equations.SUBTRACT">
  60. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">SUBTRACT</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#SUBTRACT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.SUBTRACT" title="Permalink to this definition">¶</a></dt>
  61. <dd><p>Subtracts two values.</p>
  62. <table class="docutils field-list" frame="void" rules="none">
  63. <col class="field-name" />
  64. <col class="field-body" />
  65. <tbody valign="top">
  66. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  67. <li><strong>x</strong> (<em>numeric</em>) – The value to subtract from.</li>
  68. <li><strong>y</strong> (<em>numeric</em>) – The value that subtracts.</li>
  69. </ul>
  70. </td>
  71. </tr>
  72. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x - y\)</span></p>
  73. </td>
  74. </tr>
  75. </tbody>
  76. </table>
  77. </dd></dl>
  78. <dl class="function">
  79. <dt id="pypdevsbbl.extra.equations.DIVIDE">
  80. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">DIVIDE</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#DIVIDE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.DIVIDE" title="Permalink to this definition">¶</a></dt>
  81. <dd><p>Divides two values.</p>
  82. <table class="docutils field-list" frame="void" rules="none">
  83. <col class="field-name" />
  84. <col class="field-body" />
  85. <tbody valign="top">
  86. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  87. <li><strong>x</strong> (<em>numeric</em>) – The numerator.</li>
  88. <li><strong>y</strong> (<em>numeric</em>) – The denominator.</li>
  89. </ul>
  90. </td>
  91. </tr>
  92. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(\dfrac{x}{y}\)</span></p>
  93. </td>
  94. </tr>
  95. </tbody>
  96. </table>
  97. </dd></dl>
  98. <dl class="function">
  99. <dt id="pypdevsbbl.extra.equations.IDIVIDE">
  100. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">IDIVIDE</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#IDIVIDE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.IDIVIDE" title="Permalink to this definition">¶</a></dt>
  101. <dd><p>Integer divides two values.</p>
  102. <table class="docutils field-list" frame="void" rules="none">
  103. <col class="field-name" />
  104. <col class="field-body" />
  105. <tbody valign="top">
  106. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  107. <li><strong>x</strong> (<em>numeric</em>) – The numerator.</li>
  108. <li><strong>y</strong> (<em>numeric</em>) – The denominator.</li>
  109. </ul>
  110. </td>
  111. </tr>
  112. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(\left\lfloor\dfrac{x}{y}\right\rfloor\)</span></p>
  113. </td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. </dd></dl>
  118. <dl class="function">
  119. <dt id="pypdevsbbl.extra.equations.MODULO">
  120. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">MODULO</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#MODULO"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.MODULO" title="Permalink to this definition">¶</a></dt>
  121. <dd><p>Modulo divides two values.</p>
  122. <table class="docutils field-list" frame="void" rules="none">
  123. <col class="field-name" />
  124. <col class="field-body" />
  125. <tbody valign="top">
  126. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  127. <li><strong>x</strong> (<em>numeric</em>) – The numerator.</li>
  128. <li><strong>y</strong> (<em>numeric</em>) – The denominator.</li>
  129. </ul>
  130. </td>
  131. </tr>
  132. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ mod } y\)</span></p>
  133. </td>
  134. </tr>
  135. </tbody>
  136. </table>
  137. </dd></dl>
  138. <dl class="function">
  139. <dt id="pypdevsbbl.extra.equations.NEGATE">
  140. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">NEGATE</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#NEGATE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.NEGATE" title="Permalink to this definition">¶</a></dt>
  141. <dd><p>Negates a value.</p>
  142. <table class="docutils field-list" frame="void" rules="none">
  143. <col class="field-name" />
  144. <col class="field-body" />
  145. <tbody valign="top">
  146. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> (<em>numeric</em>) – The value to negate.</td>
  147. </tr>
  148. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><span class="math notranslate nohighlight">\(- x\)</span></td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. </dd></dl>
  153. <dl class="function">
  154. <dt id="pypdevsbbl.extra.equations.INVERT">
  155. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">INVERT</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#INVERT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.INVERT" title="Permalink to this definition">¶</a></dt>
  156. <dd><p>Inverts a value.</p>
  157. <table class="docutils field-list" frame="void" rules="none">
  158. <col class="field-name" />
  159. <col class="field-body" />
  160. <tbody valign="top">
  161. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> (<em>numeric</em>) – The value to invert.</td>
  162. </tr>
  163. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><span class="math notranslate nohighlight">\(\dfrac{1}{x}\)</span></td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. </dd></dl>
  168. <dl class="function">
  169. <dt id="pypdevsbbl.extra.equations.POWER">
  170. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">POWER</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#POWER"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.POWER" title="Permalink to this definition">¶</a></dt>
  171. <dd><p>Raises x to the power of y.</p>
  172. <table class="docutils field-list" frame="void" rules="none">
  173. <col class="field-name" />
  174. <col class="field-body" />
  175. <tbody valign="top">
  176. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  177. <li><strong>x</strong> (<em>numeric</em>) – The base.</li>
  178. <li><strong>y</strong> (<em>numeric</em>) – The power.</li>
  179. </ul>
  180. </td>
  181. </tr>
  182. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x^y\)</span></p>
  183. </td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. </dd></dl>
  188. <dl class="function">
  189. <dt id="pypdevsbbl.extra.equations.AND">
  190. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">AND</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#AND"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.AND" title="Permalink to this definition">¶</a></dt>
  191. <dd><p>Boolean AND gate between x and y.</p>
  192. <table class="docutils field-list" frame="void" rules="none">
  193. <col class="field-name" />
  194. <col class="field-body" />
  195. <tbody valign="top">
  196. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  197. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  198. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  199. </ul>
  200. </td>
  201. </tr>
  202. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ AND } y\)</span></p>
  203. </td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. </dd></dl>
  208. <dl class="function">
  209. <dt id="pypdevsbbl.extra.equations.OR">
  210. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">OR</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#OR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.OR" title="Permalink to this definition">¶</a></dt>
  211. <dd><p>Boolean OR gate between x and y.</p>
  212. <table class="docutils field-list" frame="void" rules="none">
  213. <col class="field-name" />
  214. <col class="field-body" />
  215. <tbody valign="top">
  216. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  217. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  218. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  219. </ul>
  220. </td>
  221. </tr>
  222. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ OR } y\)</span></p>
  223. </td>
  224. </tr>
  225. </tbody>
  226. </table>
  227. </dd></dl>
  228. <dl class="function">
  229. <dt id="pypdevsbbl.extra.equations.BAND">
  230. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">BAND</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#BAND"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.BAND" title="Permalink to this definition">¶</a></dt>
  231. <dd><p>Bitwise AND gate between x and y.</p>
  232. <table class="docutils field-list" frame="void" rules="none">
  233. <col class="field-name" />
  234. <col class="field-body" />
  235. <tbody valign="top">
  236. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  237. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  238. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  239. </ul>
  240. </td>
  241. </tr>
  242. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ &amp; } y\)</span></p>
  243. </td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. </dd></dl>
  248. <dl class="function">
  249. <dt id="pypdevsbbl.extra.equations.BOR">
  250. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">BOR</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#BOR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.BOR" title="Permalink to this definition">¶</a></dt>
  251. <dd><p>Bitwise OR gate between x and y.</p>
  252. <table class="docutils field-list" frame="void" rules="none">
  253. <col class="field-name" />
  254. <col class="field-body" />
  255. <tbody valign="top">
  256. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  257. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  258. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  259. </ul>
  260. </td>
  261. </tr>
  262. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ | } y\)</span></p>
  263. </td>
  264. </tr>
  265. </tbody>
  266. </table>
  267. </dd></dl>
  268. <dl class="function">
  269. <dt id="pypdevsbbl.extra.equations.NOT">
  270. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">NOT</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#NOT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.NOT" title="Permalink to this definition">¶</a></dt>
  271. <dd><p>Boolean NOT gate of x.</p>
  272. <table class="docutils field-list" frame="void" rules="none">
  273. <col class="field-name" />
  274. <col class="field-body" />
  275. <tbody valign="top">
  276. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> (<em>numeric</em>) – The value to invert.</td>
  277. </tr>
  278. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><span class="math notranslate nohighlight">\(\textrm{NOT } x\)</span></td>
  279. </tr>
  280. </tbody>
  281. </table>
  282. </dd></dl>
  283. <dl class="function">
  284. <dt id="pypdevsbbl.extra.equations.XOR">
  285. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">XOR</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#XOR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.XOR" title="Permalink to this definition">¶</a></dt>
  286. <dd><p>The XOR gate between x and y.</p>
  287. <table class="docutils field-list" frame="void" rules="none">
  288. <col class="field-name" />
  289. <col class="field-body" />
  290. <tbody valign="top">
  291. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  292. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  293. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  294. </ul>
  295. </td>
  296. </tr>
  297. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ XOR } y\)</span></p>
  298. </td>
  299. </tr>
  300. </tbody>
  301. </table>
  302. </dd></dl>
  303. <dl class="function">
  304. <dt id="pypdevsbbl.extra.equations.NOR">
  305. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">NOR</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#NOR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.NOR" title="Permalink to this definition">¶</a></dt>
  306. <dd><p>The NOR gate between x and y.</p>
  307. <table class="docutils field-list" frame="void" rules="none">
  308. <col class="field-name" />
  309. <col class="field-body" />
  310. <tbody valign="top">
  311. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  312. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  313. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  314. </ul>
  315. </td>
  316. </tr>
  317. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ NOR } y\)</span></p>
  318. </td>
  319. </tr>
  320. </tbody>
  321. </table>
  322. </dd></dl>
  323. <dl class="function">
  324. <dt id="pypdevsbbl.extra.equations.XNOR">
  325. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">XNOR</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#XNOR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.XNOR" title="Permalink to this definition">¶</a></dt>
  326. <dd><p>The XNOR or XAND gate between x and y.</p>
  327. <table class="docutils field-list" frame="void" rules="none">
  328. <col class="field-name" />
  329. <col class="field-body" />
  330. <tbody valign="top">
  331. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  332. <li><strong>x</strong> (<em>numeric</em>) – The left hand side of the gate.</li>
  333. <li><strong>y</strong> (<em>numeric</em>) – The right hand side of the gate.</li>
  334. </ul>
  335. </td>
  336. </tr>
  337. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ XNOR } y\)</span></p>
  338. </td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. </dd></dl>
  343. <dl class="function">
  344. <dt id="pypdevsbbl.extra.equations.LT">
  345. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">LT</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#LT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.LT" title="Permalink to this definition">¶</a></dt>
  346. <dd><p>Checks if x is less than y.</p>
  347. <table class="docutils field-list" frame="void" rules="none">
  348. <col class="field-name" />
  349. <col class="field-body" />
  350. <tbody valign="top">
  351. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  352. <li><strong>x</strong> (<em>numeric</em>) – The smaller value.</li>
  353. <li><strong>y</strong> (<em>numeric</em>) – The larger value.</li>
  354. </ul>
  355. </td>
  356. </tr>
  357. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x &lt; y\)</span></p>
  358. </td>
  359. </tr>
  360. </tbody>
  361. </table>
  362. </dd></dl>
  363. <dl class="function">
  364. <dt id="pypdevsbbl.extra.equations.LE">
  365. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">LE</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#LE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.LE" title="Permalink to this definition">¶</a></dt>
  366. <dd><p>Checks if x is less than or equal to y.</p>
  367. <table class="docutils field-list" frame="void" rules="none">
  368. <col class="field-name" />
  369. <col class="field-body" />
  370. <tbody valign="top">
  371. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  372. <li><strong>x</strong> (<em>numeric</em>) – The smaller value.</li>
  373. <li><strong>y</strong> (<em>numeric</em>) – The larger value.</li>
  374. </ul>
  375. </td>
  376. </tr>
  377. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \leq y\)</span></p>
  378. </td>
  379. </tr>
  380. </tbody>
  381. </table>
  382. </dd></dl>
  383. <dl class="function">
  384. <dt id="pypdevsbbl.extra.equations.LEQ">
  385. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">LEQ</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#pypdevsbbl.extra.equations.LEQ" title="Permalink to this definition">¶</a></dt>
  386. <dd><p>Synonym of <a class="reference internal" href="#pypdevsbbl.extra.equations.LE" title="pypdevsbbl.extra.equations.LE"><code class="xref py py-meth docutils literal notranslate"><span class="pre">LE()</span></code></a>.</p>
  387. </dd></dl>
  388. <dl class="function">
  389. <dt id="pypdevsbbl.extra.equations.GT">
  390. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">GT</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#GT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.GT" title="Permalink to this definition">¶</a></dt>
  391. <dd><p>Checks if x is greater than y.</p>
  392. <table class="docutils field-list" frame="void" rules="none">
  393. <col class="field-name" />
  394. <col class="field-body" />
  395. <tbody valign="top">
  396. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  397. <li><strong>x</strong> (<em>numeric</em>) – The larger value.</li>
  398. <li><strong>y</strong> (<em>numeric</em>) – The smaller value.</li>
  399. </ul>
  400. </td>
  401. </tr>
  402. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x &gt; y\)</span></p>
  403. </td>
  404. </tr>
  405. </tbody>
  406. </table>
  407. </dd></dl>
  408. <dl class="function">
  409. <dt id="pypdevsbbl.extra.equations.GE">
  410. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">GE</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#GE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.GE" title="Permalink to this definition">¶</a></dt>
  411. <dd><p>Checks if x is greater than or equal to y.</p>
  412. <table class="docutils field-list" frame="void" rules="none">
  413. <col class="field-name" />
  414. <col class="field-body" />
  415. <tbody valign="top">
  416. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  417. <li><strong>x</strong> (<em>numeric</em>) – The larger value.</li>
  418. <li><strong>y</strong> (<em>numeric</em>) – The smaller value.</li>
  419. </ul>
  420. </td>
  421. </tr>
  422. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \geq y\)</span></p>
  423. </td>
  424. </tr>
  425. </tbody>
  426. </table>
  427. </dd></dl>
  428. <dl class="function">
  429. <dt id="pypdevsbbl.extra.equations.GEQ">
  430. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">GEQ</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#pypdevsbbl.extra.equations.GEQ" title="Permalink to this definition">¶</a></dt>
  431. <dd><p>Synonym of <a class="reference internal" href="#pypdevsbbl.extra.equations.GE" title="pypdevsbbl.extra.equations.GE"><code class="xref py py-meth docutils literal notranslate"><span class="pre">GE()</span></code></a>.</p>
  432. </dd></dl>
  433. <dl class="function">
  434. <dt id="pypdevsbbl.extra.equations.EQ">
  435. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">EQ</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#EQ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.EQ" title="Permalink to this definition">¶</a></dt>
  436. <dd><p>Checks if x equals y.</p>
  437. <table class="docutils field-list" frame="void" rules="none">
  438. <col class="field-name" />
  439. <col class="field-body" />
  440. <tbody valign="top">
  441. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  442. <li><strong>x</strong> (<em>numeric</em>) – The left hand side.</li>
  443. <li><strong>y</strong> (<em>numeric</em>) – The right hand side.</li>
  444. </ul>
  445. </td>
  446. </tr>
  447. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x == y\)</span></p>
  448. </td>
  449. </tr>
  450. </tbody>
  451. </table>
  452. </dd></dl>
  453. <dl class="function">
  454. <dt id="pypdevsbbl.extra.equations.EQUALS">
  455. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">EQUALS</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#pypdevsbbl.extra.equations.EQUALS" title="Permalink to this definition">¶</a></dt>
  456. <dd><p>Synonym of <a class="reference internal" href="#pypdevsbbl.extra.equations.EQ" title="pypdevsbbl.extra.equations.EQ"><code class="xref py py-meth docutils literal notranslate"><span class="pre">EQ()</span></code></a>.</p>
  457. </dd></dl>
  458. <dl class="function">
  459. <dt id="pypdevsbbl.extra.equations.IDENTICAL">
  460. <code class="descclassname">pypdevsbbl.extra.equations.</code><code class="descname">IDENTICAL</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/extra/equations.html#IDENTICAL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.extra.equations.IDENTICAL" title="Permalink to this definition">¶</a></dt>
  461. <dd><p>Checks if x is identical to y.</p>
  462. <table class="docutils field-list" frame="void" rules="none">
  463. <col class="field-name" />
  464. <col class="field-body" />
  465. <tbody valign="top">
  466. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  467. <li><strong>x</strong> (<em>numeric</em>) – The left hand side.</li>
  468. <li><strong>y</strong> (<em>numeric</em>) – The right hand side.</li>
  469. </ul>
  470. </td>
  471. </tr>
  472. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><span class="math notranslate nohighlight">\(x \textrm{ is } y\)</span></p>
  473. </td>
  474. </tr>
  475. </tbody>
  476. </table>
  477. </dd></dl>
  478. </div>
  479. </div>
  480. </div>
  481. </div>
  482. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  483. <div class="sphinxsidebarwrapper">
  484. <h4>Previous topic</h4>
  485. <p class="topless"><a href="pypdevsbbl.extra.rngstreams.distributions.html"
  486. title="previous chapter">pypdevsbbl.extra.rngstreams.distributions module</a></p>
  487. <h4>Next topic</h4>
  488. <p class="topless"><a href="pypdevsbbl.extra.fileutils.html"
  489. title="next chapter">pypdevsbbl.extra.fileutils module</a></p>
  490. <div id="searchbox" style="display: none" role="search">
  491. <h3>Quick search</h3>
  492. <div class="searchformwrapper">
  493. <form class="search" action="search.html" method="get">
  494. <input type="text" name="q" />
  495. <input type="submit" value="Go" />
  496. <input type="hidden" name="check_keywords" value="yes" />
  497. <input type="hidden" name="area" value="default" />
  498. </form>
  499. </div>
  500. </div>
  501. <script type="text/javascript">$('#searchbox').show(0);</script>
  502. </div>
  503. </div>
  504. <div class="clearer"></div>
  505. </div>
  506. <div class="related" role="navigation" aria-label="related navigation">
  507. <h3>Navigation</h3>
  508. <ul>
  509. <li class="right" style="margin-right: 10px">
  510. <a href="genindex.html" title="General Index"
  511. >index</a></li>
  512. <li class="right" >
  513. <a href="py-modindex.html" title="Python Module Index"
  514. >modules</a> |</li>
  515. <li class="right" >
  516. <a href="pypdevsbbl.extra.fileutils.html" title="pypdevsbbl.extra.fileutils module"
  517. >next</a> |</li>
  518. <li class="right" >
  519. <a href="pypdevsbbl.extra.rngstreams.distributions.html" title="pypdevsbbl.extra.rngstreams.distributions module"
  520. >previous</a> |</li>
  521. <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  522. <li class="nav-item nav-item-1"><a href="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
  523. <li class="nav-item nav-item-2"><a href="pypdevsbbl.extra.html" >pypdevsbbl.extra package</a> &#187;</li>
  524. </ul>
  525. </div>
  526. <div class="footer" role="contentinfo">
  527. &#169; Copyright 2020, Randy Paredis.
  528. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
  529. </div>
  530. </body>
  531. </html>