Add condition based MethodFilter (#504)

kuznia-rdzeni · Dec 3, 2023 · c46cc65 · c46cc65
1 parent 5155204
commit c46cc65
Show file tree

Hide file tree

Showing 40 changed files with 253 additions and 248 deletions.
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/auto_graph.doctree b/.doctrees/auto_graph.doctree
diff --git a/.doctrees/current-graph.doctree b/.doctrees/current-graph.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/transactron.lib.doctree b/.doctrees/transactron.lib.doctree
diff --git a/_sources/auto_graph.rst.txt b/_sources/auto_graph.rst.txt
diff --git a/api.html b/api.html
@@ -240,7 +240,7 @@ <h2>transactron<a class="headerlink" href="#transactron" title="Permalink to thi
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/assumptions.html b/assumptions.html
@@ -104,7 +104,7 @@ <h1>List of assumptions made during development<a class="headerlink" href="#list
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/auto_graph.html b/auto_graph.html
diff --git a/components/icache.html b/components/icache.html
@@ -131,7 +131,7 @@ <h2>Address mapping example<a class="headerlink" href="#address-mapping-example"
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.frontend.html b/coreblocks.frontend.html
@@ -399,7 +399,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.fu.html b/coreblocks.fu.html
@@ -898,7 +898,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.fu.unsigned_multiplication.html b/coreblocks.fu.unsigned_multiplication.html
@@ -237,7 +237,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.html b/coreblocks.html
@@ -215,7 +215,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.params.html b/coreblocks.params.html
@@ -2675,7 +2675,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.peripherals.html b/coreblocks.peripherals.html
@@ -348,7 +348,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.scheduler.html b/coreblocks.scheduler.html
@@ -191,7 +191,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.stages.html b/coreblocks.stages.html
@@ -263,7 +263,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.structs_common.html b/coreblocks.structs_common.html
@@ -454,7 +454,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/coreblocks.utils.html b/coreblocks.utils.html
@@ -165,7 +165,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/current-graph.html b/current-graph.html
diff --git a/development-environment.html b/development-environment.html
@@ -178,7 +178,7 @@ <h3>build_docs.sh<a class="headerlink" href="#build-docs-sh" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/genindex.html b/genindex.html
@@ -2885,7 +2885,7 @@ <h2 id="Z">Z</h2>
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/home.html b/home.html
@@ -129,7 +129,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/index.html b/index.html
@@ -221,7 +221,7 @@ <h1>Coreblocks<a class="headerlink" href="#coreblocks" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/miscellany/exceptions-summary.html b/miscellany/exceptions-summary.html
@@ -271,7 +271,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/modules-coreblocks.html b/modules-coreblocks.html
@@ -184,7 +184,7 @@ <h1>coreblocks<a class="headerlink" href="#coreblocks" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/modules-transactron.html b/modules-transactron.html
@@ -126,7 +126,7 @@ <h1>transactron<a class="headerlink" href="#transactron" title="Permalink to thi
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/problem-checklist.html b/problem-checklist.html
@@ -105,7 +105,7 @@ <h1>Problem checklist<a class="headerlink" href="#problem-checklist" title="Perm
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/py-modindex.html b/py-modindex.html
@@ -458,7 +458,7 @@ <h1>Python Module Index</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/scheduler/overview.html b/scheduler/overview.html
@@ -146,7 +146,7 @@ <h2>More detailed description of each block<a class="headerlink" href="#more-det
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/search.html b/search.html
@@ -101,7 +101,7 @@
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/shared-structs/implementation/rs-impl.html b/shared-structs/implementation/rs-impl.html
@@ -252,7 +252,7 @@ <h3>Read and clean row<a class="headerlink" href="#read-and-clean-row" title="Pe
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/shared-structs/rs.html b/shared-structs/rs.html
@@ -222,7 +222,7 @@ <h2>External interface signals<a class="headerlink" href="#external-interface-si
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/synthesis/synthesis.html b/synthesis/synthesis.html
@@ -151,7 +151,7 @@ <h2>Benchmarks<a class="headerlink" href="#benchmarks" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/transactions.html b/transactions.html
@@ -409,7 +409,7 @@ <h3>Transaction and method nesting<a class="headerlink" href="#transaction-and-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/transactron.html b/transactron.html
@@ -1329,7 +1329,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/transactron.lib.html b/transactron.lib.html
@@ -732,9 +732,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 only when some condition is true. The condition function takes two
 parameters, a module and the input <cite>Record</cite> of the method. Non-zero
 return value is interpreted as true. Alternatively to using a function,
-a <cite>Method</cite> can be passed as a condition.</p>
-<p>Caveat: because of the limitations of transaction scheduling, the target
-method is locked for usage even if it is not called.</p>
+a <cite>Method</cite> can be passed as a condition.
+By default, the target method is locked for use even if it is not called.
+If this is not the desired effect, set <cite>use_condition</cite> to True, but this will
+cause that the provided method will be <cite>single_caller</cite> and all other <cite>condition</cite>
+drawbacks will be in place (e.g. risk of exponential complexity).</p>
 <dl class="field-list simple">
 <dt class="field-odd">Attributes</dt>
 <dd class="field-odd"><dl class="simple">
@@ -745,7 +747,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="transactron.lib.transformers.MethodFilter.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="transactron.html#transactron.core.TModule" title="transactron.core.TModule"><span class="pre">TModule</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Record</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.Value</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">enum.Enum</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.ValueCastable</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Value</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Enum</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ValueCastable</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.Value</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">enum.Enum</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.ValueCastable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">collections.abc.Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">RecordDict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#transactron.lib.transformers.MethodFilter.__init__" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="transactron.html#transactron.core.TModule" title="transactron.core.TModule"><span class="pre">TModule</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Record</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.Value</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">enum.Enum</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.ValueCastable</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Value</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Enum</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ValueCastable</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.Value</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">enum.Enum</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">amaranth.hdl.ast.ValueCastable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">collections.abc.Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">RecordDict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#transactron.lib.transformers.MethodFilter.__init__" title="Permalink to this definition"></a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><dl class="simple">
@@ -757,6 +759,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dt><strong>default: Value or dict, optional</strong></dt><dd><p>The default value returned from the filtered method when the condition
 is false. If omitted, zero is returned.</p>
 </dd>
+<dt><strong>use_condition</strong><span class="classifier">bool</span></dt><dd><p>Instead of <cite>m.If</cite> use simultaneus <cite>condition</cite> which allow to execute
+this filter if the condition is False and target is not ready.</p>
+</dd>
 </dl>
 </dd>
 </dl>
@@ -931,7 +936,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>
 

diff --git a/transactron.utils.html b/transactron.utils.html
@@ -426,7 +426,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 17:08 2023-12-03.
+      <span class="lastupdated">Last updated on 18:50 2023-12-03.
       </span></p>
   </div>