CBD.lib.std.html 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>CBD.lib.std module &mdash; CBD Simulation Development Kit documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
  10. <link rel="stylesheet" href="_static/style.css" type="text/css" />
  11. <link rel="index" title="Index" href="genindex.html" />
  12. <link rel="search" title="Search" href="search.html" />
  13. <link rel="next" title="CBD.CBD module" href="CBD.CBD.html" />
  14. <link rel="prev" title="CBD.lib.interface.plotting module" href="CBD.lib.interface.plotting.html" />
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
  16. <script src="_static/js/googleanalytics.min.js"></script>
  17. <script src="_static/js/modernizr.min.js"></script>
  18. <!-- Preload the theme fonts -->
  19. <link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  20. <link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  21. <link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  22. <link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  23. <link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  24. <link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  25. <!-- Preload the katex fonts -->
  26. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  27. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  28. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  29. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  30. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  31. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  32. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  33. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  34. </head>
  35. <div class="container-fluid header-holder tutorials-header" id="header-holder">
  36. <div class="container">
  37. <div class="header-container">
  38. <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
  39. <div class="main-menu">
  40. <ul>
  41. <li>
  42. <div class="ecosystem-dropdown">
  43. <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
  44. Ecosystem
  45. </a>
  46. <div class="ecosystem-dropdown-menu">
  47. <a class="nav-dropdown-item" href="https://alchemy.host">
  48. <span class=dropdown-title>Alchemy</span>
  49. <p>Experiments logging & visualization</p>
  50. </a>
  51. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
  52. <span class=dropdown-title>Catalyst</span>
  53. <p>Accelerated deep learning R&D</p>
  54. </a>
  55. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
  56. <span class=dropdown-title>Reaction</span>
  57. <p>Convenient deep learning models serving</p>
  58. </a>
  59. </div>
  60. </div>
  61. </li>
  62. <li>
  63. <div class="projects-dropdown">
  64. <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
  65. Projects
  66. </a>
  67. <div class="projects-dropdown-menu">
  68. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
  69. <span class=dropdown-title>Codestyle</span>
  70. <p>Joint R&D codestyle</p>
  71. </a>
  72. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
  73. <span class=dropdown-title>Catalyst.Neuro</span>
  74. <p>Catalyst.Team and TReNDS collaborative project</p>
  75. </a>
  76. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
  77. <span class=dropdown-title>Classification</span>
  78. <p>Image classification pipeline with transfer learning</p>
  79. </a>
  80. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
  81. <span class=dropdown-title>Detection</span>
  82. <p>Object detection pipeline</p>
  83. </a>
  84. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
  85. <span class=dropdown-title>Segmentation</span>
  86. <p>Image semantic segmentation pipeline</p>
  87. </a>
  88. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
  89. <span class=dropdown-title>Catalyst.GAN</span>
  90. <p>GAN pipelines</p>
  91. </a>
  92. </div>
  93. </div>
  94. </li>
  95. <li>
  96. <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
  97. </li>
  98. </ul>
  99. </div>
  100. <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
  101. </div>
  102. </div>
  103. </div>
  104. <body class="catalyst-body">
  105. <div class="table-of-contents-link-wrapper">
  106. <span>Table of Contents</span>
  107. <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
  108. </div>
  109. <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
  110. <div class="catalyst-side-scroll">
  111. <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  112. <div class="catalyst-left-menu-search">
  113. <div role="search">
  114. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  115. <input type="text" name="q" placeholder="Search Docs" />
  116. <input type="hidden" name="check_keywords" value="yes" />
  117. <input type="hidden" name="area" value="default" />
  118. </form>
  119. </div>
  120. </div>
  121. <p class="caption"><span class="caption-text">Setup</span></p>
  122. <ul>
  123. <li class="toctree-l1"><a class="reference internal" href="install.html">How to install the CBD framework?</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="running.html">How to run a CBD simulation?</a></li>
  125. <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
  126. </ul>
  127. <p class="caption"><span class="caption-text">Simple Examples</span></p>
  128. <ul>
  129. <li class="toctree-l1"><a class="reference internal" href="examples/SinGen.html">Sine Generator</a></li>
  130. <li class="toctree-l1"><a class="reference internal" href="examples/EvenNumberGen.html">Hierarchical Even Number Generator</a></li>
  131. <li class="toctree-l1"><a class="reference internal" href="examples/Fibonacci.html">Fibonacci Sequence Generator</a></li>
  132. <li class="toctree-l1"><a class="reference internal" href="examples/LCG.html">Linear Congruential Generator</a></li>
  133. </ul>
  134. <p class="caption"><span class="caption-text">Advanced Examples</span></p>
  135. <ul>
  136. <li class="toctree-l1"><a class="reference internal" href="examples/RealTime.html">Realtime Simulation</a></li>
  137. <li class="toctree-l1"><a class="reference internal" href="examples/LivePlot.html">Live Plotting of Data During the Simulation</a></li>
  138. </ul>
  139. <p class="caption"><span class="caption-text">Internal Documentation</span></p>
  140. <ul class="current">
  141. <li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
  142. </ul>
  143. </div>
  144. </div>
  145. </nav>
  146. <div class="catalyst-container">
  147. <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
  148. <div class="catalyst-breadcrumbs-wrapper">
  149. <div role="navigation" aria-label="breadcrumbs navigation">
  150. <ul class="catalyst-breadcrumbs">
  151. <li>
  152. <a href="index.html">
  153. Docs
  154. </a> &gt;
  155. </li>
  156. <li><a href="CBD.html">CBD package</a> &gt;</li>
  157. <li><a href="CBD.lib.html">Standard CBD Library (BBL)</a> &gt;</li>
  158. <li>CBD.lib.std module</li>
  159. <li class="catalyst-breadcrumbs-aside">
  160. </li>
  161. </ul>
  162. </div>
  163. </div>
  164. <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
  165. Shortcuts
  166. </div>
  167. </div>
  168. <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
  169. <div class="catalyst-content-left">
  170. <div class="rst-content">
  171. <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
  172. <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
  173. <div class="section" id="module-CBD.lib.std">
  174. <span id="cbd-lib-std-module"></span><h1>CBD.lib.std module<a class="headerlink" href="#module-CBD.lib.std" title="Permalink to this headline">¶</a></h1>
  175. <p>This file contains the standard library for CBD building blocks.</p>
  176. <dl class="class">
  177. <dt id="CBD.lib.std.ConstantBlock">
  178. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ConstantBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>value=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock" title="Permalink to this definition">¶</a></dt>
  179. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  180. <p>The constant block will always output its constant value</p>
  181. <dl class="method">
  182. <dt id="CBD.lib.std.ConstantBlock.getValue">
  183. <code class="descname">getValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.getValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.getValue" title="Permalink to this definition">¶</a></dt>
  184. <dd></dd></dl>
  185. <dl class="method">
  186. <dt id="CBD.lib.std.ConstantBlock.setValue">
  187. <code class="descname">setValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.setValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.setValue" title="Permalink to this definition">¶</a></dt>
  188. <dd></dd></dl>
  189. <dl class="method">
  190. <dt id="CBD.lib.std.ConstantBlock.compute">
  191. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.compute" title="Permalink to this definition">¶</a></dt>
  192. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  193. signal.</p>
  194. <table class="docutils field-list" frame="void" rules="none">
  195. <col class="field-name" />
  196. <col class="field-body" />
  197. <tbody valign="top">
  198. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  199. </tr>
  200. </tbody>
  201. </table>
  202. </dd></dl>
  203. </dd></dl>
  204. <dl class="class">
  205. <dt id="CBD.lib.std.NegatorBlock">
  206. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">NegatorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NegatorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NegatorBlock" title="Permalink to this definition">¶</a></dt>
  207. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  208. <p>The negator block will output the value of the input multiplied with -1</p>
  209. <dl class="method">
  210. <dt id="CBD.lib.std.NegatorBlock.compute">
  211. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NegatorBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NegatorBlock.compute" title="Permalink to this definition">¶</a></dt>
  212. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  213. signal.</p>
  214. <table class="docutils field-list" frame="void" rules="none">
  215. <col class="field-name" />
  216. <col class="field-body" />
  217. <tbody valign="top">
  218. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. </dd></dl>
  223. </dd></dl>
  224. <dl class="class">
  225. <dt id="CBD.lib.std.InverterBlock">
  226. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">InverterBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#InverterBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.InverterBlock" title="Permalink to this definition">¶</a></dt>
  227. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  228. <p>The invertblock will output 1/IN</p>
  229. <dl class="method">
  230. <dt id="CBD.lib.std.InverterBlock.compute">
  231. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#InverterBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.InverterBlock.compute" title="Permalink to this definition">¶</a></dt>
  232. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  233. signal.</p>
  234. <table class="docutils field-list" frame="void" rules="none">
  235. <col class="field-name" />
  236. <col class="field-body" />
  237. <tbody valign="top">
  238. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. </dd></dl>
  243. </dd></dl>
  244. <dl class="class">
  245. <dt id="CBD.lib.std.AdderBlock">
  246. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AdderBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AdderBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AdderBlock" title="Permalink to this definition">¶</a></dt>
  247. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  248. <p>The adderblock will add the 2 inputs</p>
  249. <dl class="method">
  250. <dt id="CBD.lib.std.AdderBlock.compute">
  251. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AdderBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AdderBlock.compute" title="Permalink to this definition">¶</a></dt>
  252. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  253. signal.</p>
  254. <table class="docutils field-list" frame="void" rules="none">
  255. <col class="field-name" />
  256. <col class="field-body" />
  257. <tbody valign="top">
  258. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. </dd></dl>
  263. </dd></dl>
  264. <dl class="class">
  265. <dt id="CBD.lib.std.ProductBlock">
  266. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ProductBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ProductBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ProductBlock" title="Permalink to this definition">¶</a></dt>
  267. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  268. <p>The product block will multiply the two inputs</p>
  269. <dl class="method">
  270. <dt id="CBD.lib.std.ProductBlock.compute">
  271. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ProductBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ProductBlock.compute" title="Permalink to this definition">¶</a></dt>
  272. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  273. signal.</p>
  274. <table class="docutils field-list" frame="void" rules="none">
  275. <col class="field-name" />
  276. <col class="field-body" />
  277. <tbody valign="top">
  278. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  279. </tr>
  280. </tbody>
  281. </table>
  282. </dd></dl>
  283. </dd></dl>
  284. <dl class="class">
  285. <dt id="CBD.lib.std.ModuloBlock">
  286. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ModuloBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ModuloBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ModuloBlock" title="Permalink to this definition">¶</a></dt>
  287. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  288. <p>A basic block that computes the IN1 modulo IN2</p>
  289. <dl class="method">
  290. <dt id="CBD.lib.std.ModuloBlock.compute">
  291. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ModuloBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ModuloBlock.compute" title="Permalink to this definition">¶</a></dt>
  292. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  293. signal.</p>
  294. <table class="docutils field-list" frame="void" rules="none">
  295. <col class="field-name" />
  296. <col class="field-body" />
  297. <tbody valign="top">
  298. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  299. </tr>
  300. </tbody>
  301. </table>
  302. </dd></dl>
  303. </dd></dl>
  304. <dl class="class">
  305. <dt id="CBD.lib.std.RootBlock">
  306. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">RootBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#RootBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.RootBlock" title="Permalink to this definition">¶</a></dt>
  307. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  308. <p>A basic block that computes the IN2-th root from IN1</p>
  309. <dl class="method">
  310. <dt id="CBD.lib.std.RootBlock.compute">
  311. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#RootBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.RootBlock.compute" title="Permalink to this definition">¶</a></dt>
  312. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  313. signal.</p>
  314. <table class="docutils field-list" frame="void" rules="none">
  315. <col class="field-name" />
  316. <col class="field-body" />
  317. <tbody valign="top">
  318. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  319. </tr>
  320. </tbody>
  321. </table>
  322. </dd></dl>
  323. </dd></dl>
  324. <dl class="class">
  325. <dt id="CBD.lib.std.AbsBlock">
  326. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AbsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AbsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AbsBlock" title="Permalink to this definition">¶</a></dt>
  327. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  328. <p>The abs block will output the absolute value of the input.</p>
  329. <dl class="method">
  330. <dt id="CBD.lib.std.AbsBlock.compute">
  331. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AbsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AbsBlock.compute" title="Permalink to this definition">¶</a></dt>
  332. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  333. signal.</p>
  334. <table class="docutils field-list" frame="void" rules="none">
  335. <col class="field-name" />
  336. <col class="field-body" />
  337. <tbody valign="top">
  338. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. </dd></dl>
  343. </dd></dl>
  344. <dl class="class">
  345. <dt id="CBD.lib.std.IntBlock">
  346. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">IntBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntBlock" title="Permalink to this definition">¶</a></dt>
  347. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  348. <p>The int block will output the integer value (floored) of the input.</p>
  349. <dl class="method">
  350. <dt id="CBD.lib.std.IntBlock.compute">
  351. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntBlock.compute" title="Permalink to this definition">¶</a></dt>
  352. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  353. signal.</p>
  354. <table class="docutils field-list" frame="void" rules="none">
  355. <col class="field-name" />
  356. <col class="field-body" />
  357. <tbody valign="top">
  358. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  359. </tr>
  360. </tbody>
  361. </table>
  362. </dd></dl>
  363. </dd></dl>
  364. <dl class="class">
  365. <dt id="CBD.lib.std.ClampBlock">
  366. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ClampBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>min=-1</em>, <em>max=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ClampBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ClampBlock" title="Permalink to this definition">¶</a></dt>
  367. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  368. <p>The clamp block will clamp the input between min and max.</p>
  369. <dl class="method">
  370. <dt id="CBD.lib.std.ClampBlock.compute">
  371. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ClampBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ClampBlock.compute" title="Permalink to this definition">¶</a></dt>
  372. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  373. signal.</p>
  374. <table class="docutils field-list" frame="void" rules="none">
  375. <col class="field-name" />
  376. <col class="field-body" />
  377. <tbody valign="top">
  378. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  379. </tr>
  380. </tbody>
  381. </table>
  382. </dd></dl>
  383. </dd></dl>
  384. <dl class="class">
  385. <dt id="CBD.lib.std.GenericBlock">
  386. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">GenericBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>block_operator=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock" title="Permalink to this definition">¶</a></dt>
  387. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  388. <p>The generic block will evaluate the operator on the input
  389. operator is the name (a string) of a Python function from the math library
  390. which will be called when the block is evaluated
  391. by default, initialized to None</p>
  392. <dl class="method">
  393. <dt id="CBD.lib.std.GenericBlock.getBlockOperator">
  394. <code class="descname">getBlockOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock.getBlockOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock.getBlockOperator" title="Permalink to this definition">¶</a></dt>
  395. <dd></dd></dl>
  396. <dl class="method">
  397. <dt id="CBD.lib.std.GenericBlock.compute">
  398. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock.compute" title="Permalink to this definition">¶</a></dt>
  399. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  400. signal.</p>
  401. <table class="docutils field-list" frame="void" rules="none">
  402. <col class="field-name" />
  403. <col class="field-body" />
  404. <tbody valign="top">
  405. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  406. </tr>
  407. </tbody>
  408. </table>
  409. </dd></dl>
  410. </dd></dl>
  411. <dl class="class">
  412. <dt id="CBD.lib.std.MultiplexerBlock">
  413. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">MultiplexerBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#MultiplexerBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.MultiplexerBlock" title="Permalink to this definition">¶</a></dt>
  414. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  415. <p>The multiplexer block will output the signal from IN1 if select == 0; otherwise
  416. the signal from IN2 is outputted.</p>
  417. <dl class="method">
  418. <dt id="CBD.lib.std.MultiplexerBlock.compute">
  419. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#MultiplexerBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.MultiplexerBlock.compute" title="Permalink to this definition">¶</a></dt>
  420. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  421. signal.</p>
  422. <table class="docutils field-list" frame="void" rules="none">
  423. <col class="field-name" />
  424. <col class="field-body" />
  425. <tbody valign="top">
  426. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  427. </tr>
  428. </tbody>
  429. </table>
  430. </dd></dl>
  431. </dd></dl>
  432. <dl class="class">
  433. <dt id="CBD.lib.std.LessThanBlock">
  434. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LessThanBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanBlock" title="Permalink to this definition">¶</a></dt>
  435. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  436. <p>A simple block that will test if the IN1 is smaller than IN2 (output == 1 if true else 0)</p>
  437. <dl class="method">
  438. <dt id="CBD.lib.std.LessThanBlock.compute">
  439. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanBlock.compute" title="Permalink to this definition">¶</a></dt>
  440. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  441. signal.</p>
  442. <table class="docutils field-list" frame="void" rules="none">
  443. <col class="field-name" />
  444. <col class="field-body" />
  445. <tbody valign="top">
  446. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  447. </tr>
  448. </tbody>
  449. </table>
  450. </dd></dl>
  451. </dd></dl>
  452. <dl class="class">
  453. <dt id="CBD.lib.std.EqualsBlock">
  454. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">EqualsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#EqualsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.EqualsBlock" title="Permalink to this definition">¶</a></dt>
  455. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  456. <p>A simple block that will test if the IN1 is equal to IN2 (output == 1 if true else 0)</p>
  457. <dl class="method">
  458. <dt id="CBD.lib.std.EqualsBlock.compute">
  459. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#EqualsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.EqualsBlock.compute" title="Permalink to this definition">¶</a></dt>
  460. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  461. signal.</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"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  467. </tr>
  468. </tbody>
  469. </table>
  470. </dd></dl>
  471. </dd></dl>
  472. <dl class="class">
  473. <dt id="CBD.lib.std.LessThanOrEqualsBlock">
  474. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LessThanOrEqualsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanOrEqualsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanOrEqualsBlock" title="Permalink to this definition">¶</a></dt>
  475. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  476. <p>A simple block that will test if the IN1 is smaller than or equals to IN2 (output == 1 if true else 0)</p>
  477. <dl class="method">
  478. <dt id="CBD.lib.std.LessThanOrEqualsBlock.compute">
  479. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanOrEqualsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanOrEqualsBlock.compute" title="Permalink to this definition">¶</a></dt>
  480. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  481. signal.</p>
  482. <table class="docutils field-list" frame="void" rules="none">
  483. <col class="field-name" />
  484. <col class="field-body" />
  485. <tbody valign="top">
  486. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  487. </tr>
  488. </tbody>
  489. </table>
  490. </dd></dl>
  491. </dd></dl>
  492. <dl class="class">
  493. <dt id="CBD.lib.std.NotBlock">
  494. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">NotBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NotBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NotBlock" title="Permalink to this definition">¶</a></dt>
  495. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  496. <p>A simple Not block that will set a 0 to 1 and vice versa</p>
  497. <dl class="method">
  498. <dt id="CBD.lib.std.NotBlock.compute">
  499. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NotBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NotBlock.compute" title="Permalink to this definition">¶</a></dt>
  500. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  501. signal.</p>
  502. <table class="docutils field-list" frame="void" rules="none">
  503. <col class="field-name" />
  504. <col class="field-body" />
  505. <tbody valign="top">
  506. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  507. </tr>
  508. </tbody>
  509. </table>
  510. </dd></dl>
  511. </dd></dl>
  512. <dl class="class">
  513. <dt id="CBD.lib.std.OrBlock">
  514. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">OrBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>numberOfInputs=2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock" title="Permalink to this definition">¶</a></dt>
  515. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  516. <p>A simple Or block with possibly multiple inputlines</p>
  517. <dl class="method">
  518. <dt id="CBD.lib.std.OrBlock.compute">
  519. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock.compute" title="Permalink to this definition">¶</a></dt>
  520. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  521. signal.</p>
  522. <table class="docutils field-list" frame="void" rules="none">
  523. <col class="field-name" />
  524. <col class="field-body" />
  525. <tbody valign="top">
  526. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  527. </tr>
  528. </tbody>
  529. </table>
  530. </dd></dl>
  531. <dl class="method">
  532. <dt id="CBD.lib.std.OrBlock.getNumberOfInputs">
  533. <code class="descname">getNumberOfInputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock.getNumberOfInputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock.getNumberOfInputs" title="Permalink to this definition">¶</a></dt>
  534. <dd></dd></dl>
  535. </dd></dl>
  536. <dl class="class">
  537. <dt id="CBD.lib.std.AndBlock">
  538. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AndBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>numberOfInputs=2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock" title="Permalink to this definition">¶</a></dt>
  539. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  540. <p>A simple And block with possibly multiple inputlines</p>
  541. <dl class="method">
  542. <dt id="CBD.lib.std.AndBlock.compute">
  543. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock.compute" title="Permalink to this definition">¶</a></dt>
  544. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  545. signal.</p>
  546. <table class="docutils field-list" frame="void" rules="none">
  547. <col class="field-name" />
  548. <col class="field-body" />
  549. <tbody valign="top">
  550. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. </dd></dl>
  555. <dl class="method">
  556. <dt id="CBD.lib.std.AndBlock.getNumberOfInputs">
  557. <code class="descname">getNumberOfInputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock.getNumberOfInputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock.getNumberOfInputs" title="Permalink to this definition">¶</a></dt>
  558. <dd></dd></dl>
  559. </dd></dl>
  560. <dl class="class">
  561. <dt id="CBD.lib.std.DelayBlock">
  562. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">DelayBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock" title="Permalink to this definition">¶</a></dt>
  563. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  564. <p>A delay block that takes the last value from the list
  565. IC: Initial Condition</p>
  566. <dl class="method">
  567. <dt id="CBD.lib.std.DelayBlock.getDependencies">
  568. <code class="descname">getDependencies</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock.getDependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock.getDependencies" title="Permalink to this definition">¶</a></dt>
  569. <dd><p>Helper function to help the creation of the dependency graph.</p>
  570. <table class="docutils field-list" frame="void" rules="none">
  571. <col class="field-name" />
  572. <col class="field-body" />
  573. <tbody valign="top">
  574. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The current simulation’s iteration, for which
  575. the dependency graph must be constructed.</td>
  576. </tr>
  577. </tbody>
  578. </table>
  579. </dd></dl>
  580. <dl class="method">
  581. <dt id="CBD.lib.std.DelayBlock.compute">
  582. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock.compute" title="Permalink to this definition">¶</a></dt>
  583. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  584. signal.</p>
  585. <table class="docutils field-list" frame="void" rules="none">
  586. <col class="field-name" />
  587. <col class="field-body" />
  588. <tbody valign="top">
  589. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  590. </tr>
  591. </tbody>
  592. </table>
  593. </dd></dl>
  594. </dd></dl>
  595. <dl class="class">
  596. <dt id="CBD.lib.std.TimeBlock">
  597. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">TimeBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#TimeBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.TimeBlock" title="Permalink to this definition">¶</a></dt>
  598. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  599. <p>Outputs the current time of the simulation</p>
  600. <dl class="method">
  601. <dt id="CBD.lib.std.TimeBlock.compute">
  602. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#TimeBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.TimeBlock.compute" title="Permalink to this definition">¶</a></dt>
  603. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  604. signal.</p>
  605. <table class="docutils field-list" frame="void" rules="none">
  606. <col class="field-name" />
  607. <col class="field-body" />
  608. <tbody valign="top">
  609. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  610. </tr>
  611. </tbody>
  612. </table>
  613. </dd></dl>
  614. </dd></dl>
  615. <dl class="class">
  616. <dt id="CBD.lib.std.LoggingBlock">
  617. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LoggingBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>string</em>, <em>lev=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LoggingBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LoggingBlock" title="Permalink to this definition">¶</a></dt>
  618. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
  619. <p>A simple Logging block</p>
  620. <dl class="method">
  621. <dt id="CBD.lib.std.LoggingBlock.compute">
  622. <code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LoggingBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LoggingBlock.compute" title="Permalink to this definition">¶</a></dt>
  623. <dd><p>Computes this block’s operation, based on its inputs and store it as an output
  624. signal.</p>
  625. <table class="docutils field-list" frame="void" rules="none">
  626. <col class="field-name" />
  627. <col class="field-body" />
  628. <tbody valign="top">
  629. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
  630. </tr>
  631. </tbody>
  632. </table>
  633. </dd></dl>
  634. </dd></dl>
  635. <dl class="class">
  636. <dt id="CBD.lib.std.AddOneBlock">
  637. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AddOneBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AddOneBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AddOneBlock" title="Permalink to this definition">¶</a></dt>
  638. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
  639. <p>Block adds a one to the input (used a lot for mux)</p>
  640. </dd></dl>
  641. <dl class="class">
  642. <dt id="CBD.lib.std.DerivatorBlock">
  643. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">DerivatorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DerivatorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DerivatorBlock" title="Permalink to this definition">¶</a></dt>
  644. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
  645. <p>The derivator block is a CBD that calculates the derivative</p>
  646. </dd></dl>
  647. <dl class="class">
  648. <dt id="CBD.lib.std.IntegratorBlock">
  649. <em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">IntegratorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntegratorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntegratorBlock" title="Permalink to this definition">¶</a></dt>
  650. <dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
  651. <p>The integrator block is a CBD that calculates the integration.
  652. The block is implemented according to the trapezoid rule.</p>
  653. </dd></dl>
  654. </div>
  655. </article>
  656. </div>
  657. <footer>
  658. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  659. <a href="CBD.CBD.html" class="btn btn-neutral float-right" title="CBD.CBD module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
  660. <a href="CBD.lib.interface.plotting.html" class="btn btn-neutral" title="CBD.lib.interface.plotting module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
  661. </div>
  662. <hr>
  663. <div role="contentinfo">
  664. <p>
  665. &copy; Copyright 2020, Randy Paredis.
  666. </p>
  667. </div>
  668. <div>
  669. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  670. </div>
  671. </footer>
  672. </div>
  673. </div>
  674. <div class="catalyst-content-right" id="catalyst-content-right">
  675. <div class="catalyst-right-menu" id="catalyst-right-menu">
  676. <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
  677. <ul>
  678. <li><a class="reference internal" href="#">CBD.lib.std module</a></li>
  679. </ul>
  680. </div>
  681. </div>
  682. </div>
  683. </section>
  684. </div>
  685. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  686. <script type="text/javascript" src="_static/jquery.js"></script>
  687. <script type="text/javascript" src="_static/underscore.js"></script>
  688. <script type="text/javascript" src="_static/doctools.js"></script>
  689. <script type="text/javascript" src="_static/language_data.js"></script>
  690. <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>
  691. <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
  692. <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
  693. <script type="text/javascript" src="_static/js/theme.js"></script>
  694. <script type="text/javascript">
  695. jQuery(function () {
  696. SphinxRtdTheme.Navigation.enable(true);
  697. });
  698. </script>
  699. <!-- Begin Footer -->
  700. <footer class="site-footer" id="site-footer">
  701. <div class="container footer-container">
  702. <div class="footer-logo-wrapper">
  703. <a href="https://catalyst-team.com/" class="footer-logo"></a>
  704. </div>
  705. <div class="footer-links-wrapper">
  706. <div class="footer-links-col">
  707. <ul>
  708. <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
  709. <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
  710. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
  711. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
  712. </ul>
  713. </div>
  714. <div class="footer-links-col">
  715. <ul>
  716. <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
  717. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
  718. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
  719. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
  720. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
  721. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
  722. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
  723. </ul>
  724. </div>
  725. <div class="footer-links-col">
  726. <ul>
  727. <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
  728. <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
  729. <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
  730. <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
  731. </ul>
  732. </div>
  733. <div class="footer-links-col follow-us-col">
  734. <div class="footer-social-icons">
  735. <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
  736. <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
  737. <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
  738. </div>
  739. </div>
  740. </div>
  741. </div>
  742. </footer>
  743. <!-- End Footer -->
  744. <!-- Begin Mobile Menu -->
  745. <div class="mobile-main-menu">
  746. <div class="container-fluid">
  747. <div class="container">
  748. <div class="mobile-main-menu-header-container">
  749. <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
  750. <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
  751. </div>
  752. </div>
  753. </div>
  754. <div class="mobile-main-menu-links-container">
  755. <div class="main-menu">
  756. <ul>
  757. <li>
  758. <a href="">Get Started</a>
  759. </li>
  760. <li>
  761. <a href="https://github.com/catalyst-team/catalyst">Github</a>
  762. </li>
  763. </ul>
  764. </div>
  765. </div>
  766. </div>
  767. <!-- End Mobile Menu -->
  768. <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
  769. <script type="text/javascript">
  770. $(document).ready(function() {
  771. mobileMenu.bind();
  772. mobileTOC.bind();
  773. catalystAnchors.bind();
  774. sideMenus.bind();
  775. scrollToAnchor.bind();
  776. highlightNavigation.bind();
  777. mainMenuDropdown.bind();
  778. // Add class to links that have code blocks, since we cannot create links in code blocks
  779. $("article.catalyst-article a span.pre").each(function(e) {
  780. $(this).closest("a").addClass("has-code");
  781. });
  782. })
  783. </script>
  784. </body>
  785. </html>