Deploy preview for PR 994 🛫

pr-preview/pr-994/reference/bloqade/ir/index.html

@@ -5,23 +5,23 @@
 </span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=p>&lt;</span><span class=nc>value</span><span class=p>&gt;</span> <span class=o>::=</span> &#39;left value&#39; | &#39;right value&#39; | <span class=p>&lt;</span><span class=nc>scalar expr</span><span class=p>&gt;</span>
 </span></code></pre></div> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.AnalogCircuit class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">AnalogCircuit</span> <a href=#bloqade.ir.AnalogCircuit class=headerlink title="Permanent link">&para;</a></h2> <div class="doc doc-contents "> <p>AnalogCircuit is a dummy type that bundle register and sequence together.</p> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 id=bloqade.ir.AnalogCircuit.register class="doc doc-heading"> <span class="doc doc-object-name doc-attribute-name">register</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#bloqade.ir.AnalogCircuit.register class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>register</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p>Get the register of the program.</p> <p><span class=doc-section-title>Returns:</span></p> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> </td> <td> <div class=doc-md-description> <p>register (Union["AtomArrangement", "ParallelRegister"])</p> </div> </td> </tr> </tbody> </table> <details class=note open> <summary>Note</summary> <p>If the program is built with [<code>parallelize()</code>][bloqade.builder.emit.Emit.parallelize], The the register will be a [<code>ParallelRegister</code>][bloqade.ir.location.base.ParallelRegister]. Otherwise it will be a [<code>AtomArrangement</code>][bloqade.ir.location.base.AtomArrangement].</p> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=bloqade.ir.AnalogCircuit.show class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">show</span> <a href=#bloqade.ir.AnalogCircuit.show class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nf>show</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
-</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the program</p> <p><span class=doc-section-title>Parameters:</span></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> <code>**assignments</code> </td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the program</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/analog_circuit.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-120>120</a></span>
-<span class=normal><a href=#__codelineno-0-121>121</a></span>
+</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the program</p> <p><span class=doc-section-title>Parameters:</span></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> <code>**assignments</code> </td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the program</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/analog_circuit.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-121>121</a></span>
 <span class=normal><a href=#__codelineno-0-122>122</a></span>
 <span class=normal><a href=#__codelineno-0-123>123</a></span>
 <span class=normal><a href=#__codelineno-0-124>124</a></span>
 <span class=normal><a href=#__codelineno-0-125>125</a></span>
 <span class=normal><a href=#__codelineno-0-126>126</a></span>
 <span class=normal><a href=#__codelineno-0-127>127</a></span>
-<span class=normal><a href=#__codelineno-0-128>128</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-120><a id=__codelineno-0-120 name=__codelineno-0-120></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
-</span><span id=__span-0-121><a id=__codelineno-0-121 name=__codelineno-0-121></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;Interactive visualization of the program</span>
-</span><span id=__span-0-122><a id=__codelineno-0-122 name=__codelineno-0-122></a>
-</span><span id=__span-0-123><a id=__codelineno-0-123 name=__codelineno-0-123></a><span class=sd>    Args:</span>
-</span><span id=__span-0-124><a id=__codelineno-0-124 name=__codelineno-0-124></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
-</span><span id=__span-0-125><a id=__codelineno-0-125 name=__codelineno-0-125></a><span class=sd>            existing variables in the program</span>
-</span><span id=__span-0-126><a id=__codelineno-0-126 name=__codelineno-0-126></a>
-</span><span id=__span-0-127><a id=__codelineno-0-127 name=__codelineno-0-127></a><span class=sd>    &quot;&quot;&quot;</span>
-</span><span id=__span-0-128><a id=__codelineno-0-128 name=__codelineno-0-128></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
+<span class=normal><a href=#__codelineno-0-128>128</a></span>
+<span class=normal><a href=#__codelineno-0-129>129</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-121><a id=__codelineno-0-121 name=__codelineno-0-121></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
+</span><span id=__span-0-122><a id=__codelineno-0-122 name=__codelineno-0-122></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;Interactive visualization of the program</span>
+</span><span id=__span-0-123><a id=__codelineno-0-123 name=__codelineno-0-123></a>
+</span><span id=__span-0-124><a id=__codelineno-0-124 name=__codelineno-0-124></a><span class=sd>    Args:</span>
+</span><span id=__span-0-125><a id=__codelineno-0-125 name=__codelineno-0-125></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
+</span><span id=__span-0-126><a id=__codelineno-0-126 name=__codelineno-0-126></a><span class=sd>            existing variables in the program</span>
+</span><span id=__span-0-127><a id=__codelineno-0-127 name=__codelineno-0-127></a>
+</span><span id=__span-0-128><a id=__codelineno-0-128 name=__codelineno-0-128></a><span class=sd>    &quot;&quot;&quot;</span>
+</span><span id=__span-0-129><a id=__codelineno-0-129 name=__codelineno-0-129></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.AtomArrangement class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">AtomArrangement</span> <a href=#bloqade.ir.AtomArrangement class=headerlink title="Permanent link">&para;</a></h2> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nf>AtomArrangement</span><span class=p>(</span><span class=n>parent</span><span class=o>=</span><span class=kc>None</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title=bloqade.builder.start.ProgramStart href=../builder/start/#bloqade.builder.start.ProgramStart>ProgramStart</a></code></p> <details class=quote> <summary>Source code in <code>src/bloqade/builder/base.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-10>10</a></span>
 <span class=normal><a href=#__codelineno-0-11>11</a></span>
@@ -775,25 +775,25 @@
 </span><span id=__span-0-326><a id=__codelineno-0-326 name=__codelineno-0-326></a>    <span class=nb>object</span><span class=o>.</span><span class=fm>__setattr__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=s2>&quot;duration&quot;</span><span class=p>,</span> <span class=n>cast</span><span class=p>(</span><span class=n>duration</span><span class=p>))</span>
 </span></code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.Field class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">Field</span> <a href=#bloqade.ir.Field class=headerlink title="Permanent link">&para;</a></h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=bloqade.ir.control.field.FieldExpr>FieldExpr</span></code></p> <p>Field node in the IR. Which contains collection(s) of <a class="autorefs autorefs-internal" href=control/waveform/#bloqade.ir.control.waveform.Waveform><code>Waveform</code></a></p> <div class="language-bnf highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=p>&lt;</span><span class=nc>field</span><span class=p>&gt;</span> <span class=o>::=</span> (&#39;field&#39; <span class=p>&lt;</span><span class=nc>spatial modulation</span><span class=p>&gt;</span>  <span class=p>&lt;</span><span class=nc>padded waveform</span><span class=p>&gt;</span>)*
 </span></code></pre></div> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h3 id=bloqade.ir.Field.show class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">show</span> <a href=#bloqade.ir.Field.show class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nf>show</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
-</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the Field</p> <p><span class=doc-section-title>Parameters:</span></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> <code>**assignments</code> </td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the Field</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/control/field.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-257>257</a></span>
-<span class=normal><a href=#__codelineno-0-258>258</a></span>
-<span class=normal><a href=#__codelineno-0-259>259</a></span>
-<span class=normal><a href=#__codelineno-0-260>260</a></span>
-<span class=normal><a href=#__codelineno-0-261>261</a></span>
-<span class=normal><a href=#__codelineno-0-262>262</a></span>
-<span class=normal><a href=#__codelineno-0-263>263</a></span>
+</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the Field</p> <p><span class=doc-section-title>Parameters:</span></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> <code>**assignments</code> </td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the Field</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/control/field.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-263>263</a></span>
 <span class=normal><a href=#__codelineno-0-264>264</a></span>
 <span class=normal><a href=#__codelineno-0-265>265</a></span>
-<span class=normal><a href=#__codelineno-0-266>266</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-257><a id=__codelineno-0-257 name=__codelineno-0-257></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
-</span><span id=__span-0-258><a id=__codelineno-0-258 name=__codelineno-0-258></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;</span>
-</span><span id=__span-0-259><a id=__codelineno-0-259 name=__codelineno-0-259></a><span class=sd>    Interactive visualization of the Field</span>
-</span><span id=__span-0-260><a id=__codelineno-0-260 name=__codelineno-0-260></a>
-</span><span id=__span-0-261><a id=__codelineno-0-261 name=__codelineno-0-261></a><span class=sd>    Args:</span>
-</span><span id=__span-0-262><a id=__codelineno-0-262 name=__codelineno-0-262></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
-</span><span id=__span-0-263><a id=__codelineno-0-263 name=__codelineno-0-263></a><span class=sd>            existing variables in the Field</span>
-</span><span id=__span-0-264><a id=__codelineno-0-264 name=__codelineno-0-264></a>
-</span><span id=__span-0-265><a id=__codelineno-0-265 name=__codelineno-0-265></a><span class=sd>    &quot;&quot;&quot;</span>
-</span><span id=__span-0-266><a id=__codelineno-0-266 name=__codelineno-0-266></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
+<span class=normal><a href=#__codelineno-0-266>266</a></span>
+<span class=normal><a href=#__codelineno-0-267>267</a></span>
+<span class=normal><a href=#__codelineno-0-268>268</a></span>
+<span class=normal><a href=#__codelineno-0-269>269</a></span>
+<span class=normal><a href=#__codelineno-0-270>270</a></span>
+<span class=normal><a href=#__codelineno-0-271>271</a></span>
+<span class=normal><a href=#__codelineno-0-272>272</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-263><a id=__codelineno-0-263 name=__codelineno-0-263></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
+</span><span id=__span-0-264><a id=__codelineno-0-264 name=__codelineno-0-264></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;</span>
+</span><span id=__span-0-265><a id=__codelineno-0-265 name=__codelineno-0-265></a><span class=sd>    Interactive visualization of the Field</span>
+</span><span id=__span-0-266><a id=__codelineno-0-266 name=__codelineno-0-266></a>
+</span><span id=__span-0-267><a id=__codelineno-0-267 name=__codelineno-0-267></a><span class=sd>    Args:</span>
+</span><span id=__span-0-268><a id=__codelineno-0-268 name=__codelineno-0-268></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
+</span><span id=__span-0-269><a id=__codelineno-0-269 name=__codelineno-0-269></a><span class=sd>            existing variables in the Field</span>
+</span><span id=__span-0-270><a id=__codelineno-0-270 name=__codelineno-0-270></a>
+</span><span id=__span-0-271><a id=__codelineno-0-271 name=__codelineno-0-271></a><span class=sd>    &quot;&quot;&quot;</span>
+</span><span id=__span-0-272><a id=__codelineno-0-272 name=__codelineno-0-272></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.Honeycomb class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">Honeycomb</span> <a href=#bloqade.ir.Honeycomb class=headerlink title="Permanent link">&para;</a></h2> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=nf>Honeycomb</span><span class=p>(</span><span class=n>L1</span><span class=p>,</span> <span class=n>L2</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=o>*</span><span class=p>,</span> <span class=n>lattice_spacing</span><span class=o>=</span><span class=mf>1.0</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title=bloqade.ir.location.bravais.BoundedBravais href=location/bravais/#bloqade.ir.location.bravais.BoundedBravais>BoundedBravais</a></code></p> <p>Honeycomb lattice.</p> <ul> <li>2D lattice</li> <li>primitive (cell) vector(s)<ul> <li>a1 = (1, 0)</li> <li>a2 = (&frac12;, sqrt(3)/2)</li> </ul> </li> <li>unit cell (2 atom(s))<ul> <li>loc1 (0, 0)</li> <li>loc2 (&frac12;, 1/(2*sqrt(3))</li> </ul> </li> </ul> <p><span class=doc-section-title>Parameters:</span></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class=doc-section-item> <td> <code>L1</code> </td> <td> <code>int</code> </td> <td> <div class=doc-md-description> <p>number of unit cells in linear direction. n_atoms = L1 * L1 * 2.</p> </div> </td> <td> <em>required</em> </td> </tr> <tr class=doc-section-item> <td> <code>L2</code> </td> <td> <code><span title=beartype.typing.Optional>Optional</span>[int]</code> </td> <td> <div class=doc-md-description> <p>number of unit cells in direction a2. n_atoms = L1 * L2 * 2, default is L1.</p> </div> </td> <td> <code>None</code> </td> </tr> <tr class=doc-section-item> <td> <code>lattice_spacing</code> </td> <td> <code>(<a class="autorefs autorefs-internal" title=bloqade.ir.Scalar href=#bloqade.ir.Scalar>Scalar</a>, Real)</code> </td> <td> <div class=doc-md-description> <p>lattice spacing. Defaults to 1.0.</p> </div> </td> <td> <code>1.0</code> </td> </tr> </tbody> </table> <ul> <li>Possible Next: continue with <code>.</code> to see possible next step in auto-prompt supported setting (IPython, IDE ...)</li> </ul> <details class=quote> <summary>Source code in <code>src/bloqade/ir/location/bravais.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-420>420</a></span>
 <span class=normal><a href=#__codelineno-0-421>421</a></span>