|
|
@@ -0,0 +1,405 @@
|
|
|
+
|
|
|
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
+
|
|
|
+<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
+ <head>
|
|
|
+ <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
|
|
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
+ <title>pypdevsbbl.extra.equations — Python(P)DEVS-BBL documentation</title>
|
|
|
+ <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
|
|
|
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
|
+ <link rel="stylesheet" type="text/css" href="../../../_static/custom.css" />
|
|
|
+ <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../_static/language_data.js"></script>
|
|
|
+ <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
+ <link rel="index" title="Index" href="../../../genindex.html" />
|
|
|
+ <link rel="search" title="Search" href="../../../search.html" />
|
|
|
+ </head><body>
|
|
|
+ <div class="related" role="navigation" aria-label="related navigation">
|
|
|
+ <h3>Navigation</h3>
|
|
|
+ <ul>
|
|
|
+ <li class="right" style="margin-right: 10px">
|
|
|
+ <a href="../../../genindex.html" title="General Index"
|
|
|
+ accesskey="I">index</a></li>
|
|
|
+ <li class="right" >
|
|
|
+ <a href="../../../py-modindex.html" title="Python Module Index"
|
|
|
+ >modules</a> |</li>
|
|
|
+ <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL documentation</a> »</li>
|
|
|
+ <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
|
+ <li class="nav-item nav-item-2"><a href="../extra.html" accesskey="U">pypdevsbbl.extra</a> »</li>
|
|
|
+ </ul>
|
|
|
+ </div>
|
|
|
+
|
|
|
+ <div class="document">
|
|
|
+ <div class="documentwrapper">
|
|
|
+ <div class="bodywrapper">
|
|
|
+ <div class="body" role="main">
|
|
|
+
|
|
|
+ <h1>Source code for pypdevsbbl.extra.equations</h1><div class="highlight"><pre>
|
|
|
+<span></span><span class="c1"># Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
|
|
|
+<span class="c1"># McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
|
|
+<span class="c1"># you may not use this file except in compliance with the License.</span>
|
|
|
+<span class="c1"># You may obtain a copy of the License at</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
|
|
|
+<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
|
|
|
+<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
|
|
+<span class="c1"># See the License for the specific language governing permissions and</span>
|
|
|
+<span class="c1"># limitations under the License.</span>
|
|
|
+
|
|
|
+<span class="sd">"""This file contains a set of mathematical equations as functions.</span>
|
|
|
+
|
|
|
+<span class="sd">These equations can be used as an input for the :class:`pypdevsbbl.generic.math.Equation`</span>
|
|
|
+<span class="sd">block for simplicity.</span>
|
|
|
+
|
|
|
+<span class="sd">Note:</span>
|
|
|
+<span class="sd"> The described functions were written with the idea of numerical values as</span>
|
|
|
+<span class="sd"> inputs. While it is advised to refrain from using non-numerical arguments,</span>
|
|
|
+<span class="sd"> it is allowed within *Python*. There are no guarantees on what might happen</span>
|
|
|
+<span class="sd"> if you decide to use non-numeric input.</span>
|
|
|
+<span class="sd">"""</span>
|
|
|
+
|
|
|
+<div class="viewcode-block" id="SUBTRACT"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.SUBTRACT">[docs]</a><span class="k">def</span> <span class="nf">SUBTRACT</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Subtracts two values.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The value to subtract from.</span>
|
|
|
+<span class="sd"> y (numeric): The value that subtracts.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x - y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">-</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="DIVIDE"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.DIVIDE">[docs]</a><span class="k">def</span> <span class="nf">DIVIDE</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Divides two values.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The numerator.</span>
|
|
|
+<span class="sd"> y (numeric): The denominator.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`\\dfrac{x}{y}`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">/</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="IDIVIDE"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.IDIVIDE">[docs]</a><span class="k">def</span> <span class="nf">IDIVIDE</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Integer divides two values.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The numerator.</span>
|
|
|
+<span class="sd"> y (numeric): The denominator.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`\\left\\lfloor\\dfrac{x}{y}\\right\\rfloor`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">//</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="MODULO"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.MODULO">[docs]</a><span class="k">def</span> <span class="nf">MODULO</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Modulo divides two values.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The numerator.</span>
|
|
|
+<span class="sd"> y (numeric): The denominator.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ mod } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">%</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="NEGATE"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.NEGATE">[docs]</a><span class="k">def</span> <span class="nf">NEGATE</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Negates a value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The value to negate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`- x`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="o">-</span><span class="n">x</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="INVERT"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.INVERT">[docs]</a><span class="k">def</span> <span class="nf">INVERT</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Inverts a value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The value to invert.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`\\dfrac{1}{x}`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="n">x</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="POWER"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.POWER">[docs]</a><span class="k">def</span> <span class="nf">POWER</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Raises x to the power of y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The base.</span>
|
|
|
+<span class="sd"> y (numeric): The power.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x^y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">**</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="AND"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.AND">[docs]</a><span class="k">def</span> <span class="nf">AND</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Boolean AND gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ AND } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="ow">and</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="OR"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.OR">[docs]</a><span class="k">def</span> <span class="nf">OR</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Boolean OR gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ OR } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="ow">or</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="BAND"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.BAND">[docs]</a><span class="k">def</span> <span class="nf">BAND</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Bitwise AND gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ & } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">&</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="BOR"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.BOR">[docs]</a><span class="k">def</span> <span class="nf">BOR</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Bitwise OR gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ | } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">|</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="NOT"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.NOT">[docs]</a><span class="k">def</span> <span class="nf">NOT</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Boolean NOT gate of x.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The value to invert.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`\\textrm{NOT } x`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="ow">not</span> <span class="n">x</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="XOR"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.XOR">[docs]</a><span class="k">def</span> <span class="nf">XOR</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""The XOR gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ XOR } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">^</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="NOR"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.NOR">[docs]</a><span class="k">def</span> <span class="nf">NOR</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""The NOR gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ NOR } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="ow">not</span> <span class="p">(</span><span class="n">x</span> <span class="ow">or</span> <span class="n">y</span><span class="p">)</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="XNOR"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.XNOR">[docs]</a><span class="k">def</span> <span class="nf">XNOR</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""The XNOR or XAND gate between x and y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side of the gate.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side of the gate.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ XNOR } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="ow">not</span> <span class="p">(</span><span class="n">x</span> <span class="o">^</span> <span class="n">y</span><span class="p">)</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="LT"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.LT">[docs]</a><span class="k">def</span> <span class="nf">LT</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x is less than y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The smaller value.</span>
|
|
|
+<span class="sd"> y (numeric): The larger value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x < y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o"><</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="LE"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.LE">[docs]</a><span class="k">def</span> <span class="nf">LE</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x is less than or equal to y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The smaller value.</span>
|
|
|
+<span class="sd"> y (numeric): The larger value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\leq y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o"><=</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+<span class="c1"># Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
|
|
|
+<span class="c1"># McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
|
|
+<span class="c1"># you may not use this file except in compliance with the License.</span>
|
|
|
+<span class="c1"># You may obtain a copy of the License at</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
|
+<span class="c1">#</span>
|
|
|
+<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
|
|
|
+<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
|
|
|
+<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
|
|
+<span class="c1"># See the License for the specific language governing permissions and</span>
|
|
|
+<span class="c1"># limitations under the License.</span>
|
|
|
+
|
|
|
+<span class="n">LEQ</span> <span class="o">=</span> <span class="n">LE</span>
|
|
|
+<span class="sd">"""Synonym of :meth:`LE`."""</span>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="GT"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.GT">[docs]</a><span class="k">def</span> <span class="nf">GT</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x is greater than y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The larger value.</span>
|
|
|
+<span class="sd"> y (numeric): The smaller value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x > y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">></span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="GE"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.GE">[docs]</a><span class="k">def</span> <span class="nf">GE</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x is greater than or equal to y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The larger value.</span>
|
|
|
+<span class="sd"> y (numeric): The smaller value.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\geq y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">>=</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+<span class="n">GEQ</span> <span class="o">=</span> <span class="n">GE</span>
|
|
|
+<span class="sd">"""Synonym of :meth:`GE`."""</span>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="EQ"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.EQ">[docs]</a><span class="k">def</span> <span class="nf">EQ</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x equals y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x == y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="o">==</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+<span class="n">EQUALS</span> <span class="o">=</span> <span class="n">EQ</span>
|
|
|
+<span class="sd">"""Synonym of :meth:`EQ`."""</span>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="IDENTICAL"><a class="viewcode-back" href="../../../pypdevsbbl.extra.equations.html#pypdevsbbl.extra.equations.IDENTICAL">[docs]</a><span class="k">def</span> <span class="nf">IDENTICAL</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Checks if x is identical to y.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> x (numeric): The left hand side.</span>
|
|
|
+<span class="sd"> y (numeric): The right hand side.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> :math:`x \\textrm{ is } y`</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">return</span> <span class="n">x</span> <span class="ow">is</span> <span class="n">y</span></div>
|
|
|
+
|
|
|
+</pre></div>
|
|
|
+
|
|
|
+ </div>
|
|
|
+ </div>
|
|
|
+ </div>
|
|
|
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
+ <div class="sphinxsidebarwrapper">
|
|
|
+<div id="searchbox" style="display: none" role="search">
|
|
|
+ <h3>Quick search</h3>
|
|
|
+ <div class="searchformwrapper">
|
|
|
+ <form class="search" action="../../../search.html" method="get">
|
|
|
+ <input type="text" name="q" />
|
|
|
+ <input type="submit" value="Go" />
|
|
|
+ <input type="hidden" name="check_keywords" value="yes" />
|
|
|
+ <input type="hidden" name="area" value="default" />
|
|
|
+ </form>
|
|
|
+ </div>
|
|
|
+</div>
|
|
|
+<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
|
+ </div>
|
|
|
+ </div>
|
|
|
+ <div class="clearer"></div>
|
|
|
+ </div>
|
|
|
+ <div class="related" role="navigation" aria-label="related navigation">
|
|
|
+ <h3>Navigation</h3>
|
|
|
+ <ul>
|
|
|
+ <li class="right" style="margin-right: 10px">
|
|
|
+ <a href="../../../genindex.html" title="General Index"
|
|
|
+ >index</a></li>
|
|
|
+ <li class="right" >
|
|
|
+ <a href="../../../py-modindex.html" title="Python Module Index"
|
|
|
+ >modules</a> |</li>
|
|
|
+ <li class="nav-item nav-item-0"><a href="../../../index.html">Python(P)DEVS-BBL documentation</a> »</li>
|
|
|
+ <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
|
+ <li class="nav-item nav-item-2"><a href="../extra.html" >pypdevsbbl.extra</a> »</li>
|
|
|
+ </ul>
|
|
|
+ </div>
|
|
|
+ <div class="footer" role="contentinfo">
|
|
|
+ © Copyright 2020, Randy Paredis.
|
|
|
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
|
|
|
+ </div>
|
|
|
+ </body>
|
|
|
+</html>
|
