Docs preview for PR #2711.

Author: cuda-quantum-bot

pr-2711/_sources/applications/python/edge-detection.ipynb.txt

@@ -25,7 +25,7 @@
     "from matplotlib import style\n",
     "style.use('bmh')\n",
     "\n",
-    "cudaq.set_target('nvidia')"
+    "cudaq.set_target(\"nvidia\")"
    ]
   },
   {
@@ -91,7 +91,8 @@
     "\n",
     "$$ \\ket{img} = c_0 \\ket{00} + c_1 \\ket{01} + c_2 \\ket{10} + c_3 \\ket{11}$$\n",
     "\n",
-    "Below, is how to encode an image using QPIE in cudaq.\n"
+    "Below, is how to encode an image using QPIE in cudaq.\n",
+    "\n"
    ]
   },
   {

pr-2711/_sources/specification/cudaq/operations.rst.txt

@@ -96,7 +96,7 @@ The default set of quantum intrinsic operations for the cudaq::qubit type is as
  
       bool MEASURE_OP(qubit &q) noexcept;
       std::vector<bool> MEASURE_OP(qvector &q) noexcept;
-      double measure(cudaq::spin_op & term) noexcept { ... }
+      double measure(const cudaq::spin_op & term) noexcept { ... }
   }
 
 **[1]** For the default implementation of the :code:`cudaq::qubit` intrinsic operations, we let 

pr-2711/api/languages/cpp_api.html

@@ -2167,7 +2167,7 @@ <h2>Data Types<a class="headerlink" href="#data-types" title="Permalink to this
 <span class="sig-name descname"><span class="pre">final_expectation_values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cudaq.EvolveResult.final_expectation_values" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="py function">
 <dt class="sig sig-object py">
-<span class="sig-name descname"><span class="pre">final_expectation_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cudaq.EvolveResult" title="cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.EvolveResult"><span class="pre">cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.EvolveResult</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cudaq.ObserveResult" title="cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.ObserveResult"><span class="pre">cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.ObserveResult</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span></dt>
+<span class="sig-name descname"><span class="pre">final_expectation_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cudaq.EvolveResult" title="cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.EvolveResult"><span class="pre">cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.EvolveResult</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cudaq.ObserveResult" title="cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.ObserveResult"><span class="pre">cudaq.mlir._mlir_libs._quakeDialects.cudaq_runtime.ObserveResult</span></a><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></dt>
 <dd></dd></dl>
 
 <p>Stores the final expectation values, that is the results produced by calls to <a class="reference internal" href="#cudaq.observe" title="cudaq.observe"><code class="xref py py-func docutils literal notranslate"><span class="pre">observe()</span></code></a>, triggered by a call to <a class="reference internal" href="#cudaq.evolve" title="cudaq.evolve"><code class="xref py py-func docutils literal notranslate"><span class="pre">evolve()</span></code></a>. Each entry corresponds to one observable provided in the <a class="reference internal" href="#cudaq.evolve" title="cudaq.evolve"><code class="xref py py-func docutils literal notranslate"><span class="pre">evolve()</span></code></a> call. This value will be None if no observables were specified in the call.</p>

pr-2711/api/languages/python_api.html

@@ -796,7 +796,7 @@ <h1>ADAPT-QAOA algorithm<a class="headerlink" href="#ADAPT-QAOA-algorithm" title
 parameter</p>
 <p>3- Optimize all parameters currently in the Ansatz <span class="math notranslate nohighlight">\(\beta_m, \gamma_m = 1, 2, ...k\)</span> such that <span class="math notranslate nohighlight">\(\braket{\psi (k)|H_C|\psi(k)}\)</span> is minimized, and return to the second step.</p>
 <p>Below is a schematic representation of the ADAPT-QAOA algorithm explained above.</p>
-<div><p><img alt="33d292e3679f4eb882a2b057338ff30a" class="no-scaled-link" src="../../_images/adapt-qaoa.png" style="width: 600px;" /></p>
+<div><p><img alt="91180c6330aa44cca43097bde1644287" class="no-scaled-link" src="../../_images/adapt-qaoa.png" style="width: 600px;" /></p>
 </div><div class="nbinput nblast docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]:
 </pre></div>

pr-2711/applications/python/adapt_qaoa.html

@@ -853,7 +853,7 @@ <h2>XOR <span class="math notranslate nohighlight">\(\oplus\)</span><a class="he
 </section>
 <section id="Quantum-oracles">
 <h2>Quantum oracles<a class="headerlink" href="#Quantum-oracles" title="Permalink to this heading">¶</a></h2>
-<p><img alt="dc1acfb9da354f8d987360da8e9cc21b" class="no-scaled-link" src="../../_images/oracle.png" style="width: 300px; height: 150px;" /></p>
+<p><img alt="ee818b2300b84861a101d66290791f5a" class="no-scaled-link" src="../../_images/oracle.png" style="width: 300px; height: 150px;" /></p>
 <p>Suppose we have <span class="math notranslate nohighlight">\(f(x): \{0,1\} \longrightarrow \{0,1\}\)</span>. We can compute this function on a quantum computer using oracles which we treat as black box functions that yield the output with an appropriate sequence of logical gates.</p>
 <p>Above you see an oracle represented as <span class="math notranslate nohighlight">\(U_f\)</span> which allows us to transform the state <span class="math notranslate nohighlight">\(\ket{x}\ket{y}\)</span> into:</p>
 <div class="math notranslate nohighlight">
@@ -901,7 +901,7 @@ <h2>Quantum parallelism<a class="headerlink" href="#Quantum-parallelism" title="
 <h2>Deutsch’s Algorithm:<a class="headerlink" href="#Deutsch's-Algorithm:" title="Permalink to this heading">¶</a></h2>
 <p>Our aim is to find out if <span class="math notranslate nohighlight">\(f: \{0,1\} \longrightarrow \{0,1\}\)</span> is a constant or a balanced function? If constant, <span class="math notranslate nohighlight">\(f(0) = f(1)\)</span>, and if balanced, <span class="math notranslate nohighlight">\(f(0) \neq f(1)\)</span>.</p>
 <p>We step through the circuit diagram below and follow the math after the application of each gate.</p>
-<p><img alt="8945afdc87be440e9c486958fb196e6a" class="no-scaled-link" src="../../_images/deutsch.png" style="width: 500px; height: 210px;" /></p>
+<p><img alt="3e376c99bfb14f53bd45bdaeea8efef6" class="no-scaled-link" src="../../_images/deutsch.png" style="width: 500px; height: 210px;" /></p>
 <div class="math notranslate nohighlight">
 \[\ket{\psi_0}  =  \ket{01}
 \tag{1}\]</div>

pr-2711/applications/python/deutschs_algorithm.html

@@ -792,7 +792,7 @@ <h1>Quantum edge detection<a class="headerlink" href="#Quantum-edge-detection" t
 <span class="kn">from</span><span class="w"> </span><span class="nn">matplotlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">style</span>
 <span class="n">style</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s1">&#39;bmh&#39;</span><span class="p">)</span>
 
-<span class="n">cudaq</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="s1">&#39;nvidia&#39;</span><span class="p">)</span>
+<span class="n">cudaq</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="s2">&quot;nvidia&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 </div>
@@ -833,7 +833,7 @@ <h2>Image<a class="headerlink" href="#Image" title="Permalink to this heading">
 <section id="Quantum-Probability-Image-Encoding-(QPIE):">
 <h2>Quantum Probability Image Encoding (QPIE):<a class="headerlink" href="#Quantum-Probability-Image-Encoding-(QPIE):" title="Permalink to this heading">¶</a></h2>
 <p>Lets take as an example a classical 2x2 image (4 pixels). We can label each pixel with its position</p>
-<div><p><img alt="98397416673047ecb127d76194cfed83" class="no-scaled-link" src="../../_images/pixels-img.png" style="width: 200px;" /></p>
+<div><p><img alt="ac14afc48d8b4d1e973d6eeda957002a" class="no-scaled-link" src="../../_images/pixels-img.png" style="width: 200px;" /></p>
 </div><p>Each pixel will have its own color intensity represented along with its position label as an 8-bit black and white color. To convert the pixel intensity to probability amplitudes of a quantum state</p>
 <div class="math notranslate nohighlight">
 \[c_i = \frac{I_{yx}}{\sqrt(\sum I^2_{yx})}\]</div>

pr-2711/applications/python/edge-detection.html

@@ -25,7 +25,7 @@
     "from matplotlib import style\n",
     "style.use('bmh')\n",
     "\n",
-    "cudaq.set_target('nvidia')"
+    "cudaq.set_target(\"nvidia\")"
    ]
   },
   {
@@ -91,7 +91,8 @@
     "\n",
     "$$ \\ket{img} = c_0 \\ket{00} + c_1 \\ket{01} + c_2 \\ket{10} + c_3 \\ket{11}$$\n",
     "\n",
-    "Below, is how to encode an image using QPIE in cudaq.\n"
+    "Below, is how to encode an image using QPIE in cudaq.\n",
+    "\n"
    ]
   },
   {

pr-2711/applications/python/edge-detection.ipynb

@@ -781,9 +781,9 @@ <h1>Optimizing Performance<a class="headerlink" href="#Optimizing-Performance" t
 <section id="Gate-Fusion">
 <h2>Gate Fusion<a class="headerlink" href="#Gate-Fusion" title="Permalink to this heading">¶</a></h2>
 <p>Gate fusion is an optimization technique where consecutive gates are combined into a single gate operation to improve the efficiency of the simulation (See figure below). By targeting the <code class="docutils literal notranslate"><span class="pre">nvidia-mgpu</span></code> backend and setting the <code class="docutils literal notranslate"><span class="pre">CUDAQ_MGPU_FUSE</span></code> environment variable, you can select the degree of fusion that takes place. A full command line example would look like <code class="docutils literal notranslate"><span class="pre">CUDAQ_MGPU_FUSE=4</span> <span class="pre">python</span> <span class="pre">c2h2VQE.py</span> <span class="pre">--target</span> <span class="pre">nvidia</span> <span class="pre">--target-option</span> <span class="pre">fp64,mgpu</span></code></p>
-<p><img alt="06d70eed1d82422190e8dc3f359ea836" src="../../_images/gate-fuse.png" /></p>
+<p><img alt="cee0328fbfc14ca7933e2b59923d605a" src="../../_images/gate-fuse.png" /></p>
 <p>The importance of gate fusion is system dependent, but can have a large influence on the performance of the simulation. See the example below for a 24 qubit VQE experiment where changing the fusion level resulted in significant performance boosts.</p>
-<p><img alt="636e35b626a3403a8467ce99515e40aa" src="../../_images/gatefusion.png" /></p>
+<p><img alt="ccbf8d288b6c4583b5f85889c83065c3" src="../../_images/gatefusion.png" /></p>
 </section>
 </section>
 

pr-2711/applications/python/quantum_transformer.html

@@ -960,27 +960,37 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixE">cudaq::complex_matrix (C++ class)</a>
 </li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix4colsEv">cudaq::complex_matrix::cols (C++ function)</a>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix7adjointEv">cudaq::complex_matrix::adjoint (C++ function)</a>
 </li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix14complex_matrixEKNSt6size_tEKNSt6size_tE">cudaq::complex_matrix::complex_matrix (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix14complex_matrixEP10value_typeKNSt6size_tEKNSt6size_tE">[1]</a>
-</li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix4dataEv">cudaq::complex_matrix::data (C++ function)</a>
-</li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix4dumpERNSt7ostreamE">cudaq::complex_matrix::dump (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix4dumpEv">[1]</a>
+      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix4dumpERNSt7ostreamE">cudaq::complex_matrix::dump (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix4dumpEv">[1]</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix11eigenvaluesEv">cudaq::complex_matrix::eigenvalues (C++ function)</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix12eigenvectorsEv">cudaq::complex_matrix::eigenvectors (C++ function)</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix11exponentialEv">cudaq::complex_matrix::exponential (C++ function)</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix8identityEKNSt6size_tE">cudaq::complex_matrix::identity (C++ function)</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4I00EN5cudaq14complex_matrix9kroneckerE14complex_matrix8Iterable8Iterable">cudaq::complex_matrix::kronecker (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix9kroneckerERK14complex_matrixRK14complex_matrix">[1]</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix18minimal_eigenvalueEv">cudaq::complex_matrix::minimal_eigenvalue (C++ function)</a>
 </li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrixclENSt6size_tENSt6size_tE">cudaq::complex_matrix::operator() (C++ function)</a>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixclENSt6size_tENSt6size_tE">cudaq::complex_matrix::operator() (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrixclENSt6size_tENSt6size_tE">[1]</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixmlEN14complex_matrix10value_typeERK14complex_matrix">cudaq::complex_matrix::operator* (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixmlERK14complex_matrixRK14complex_matrix">[1]</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixmlERK14complex_matrixRKNSt6vectorIN14complex_matrix10value_typeEEE">[2]</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixplERK14complex_matrixRK14complex_matrix">cudaq::complex_matrix::operator+ (C++ function)</a>
 </li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrixmlER14complex_matrix">cudaq::complex_matrix::operator* (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrixmlERNSt6vectorI10value_typeEE">[1]</a>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixmiERK14complex_matrixRK14complex_matrix">cudaq::complex_matrix::operator- (C++ function)</a>
 </li>
-      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix4rowsEv">cudaq::complex_matrix::rows (C++ function)</a>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrixixERKNSt6vectorINSt6size_tEEE">cudaq::complex_matrix::operator[] (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrixixERKNSt6vectorINSt6size_tEEE">[1]</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix5powerEi">cudaq::complex_matrix::power (C++ function)</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix8set_zeroEv">cudaq::complex_matrix::set_zero (C++ function)</a>
+</li>
+      <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq14complex_matrix9to_stringEv">cudaq::complex_matrix::to_string (C++ function)</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix10value_typeE">cudaq::complex_matrix::value_type (C++ type)</a>
 </li>
@@ -1310,12 +1320,12 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq18phase_flip_channelE">cudaq::phase_flip_channel (C++ class)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPUE">cudaq::QPU (C++ class)</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU7enqueueER11QuantumTask">cudaq::QPU::enqueue (C++ function)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU15getConnectivityEv">cudaq::QPU::getConnectivity (C++ function)</a>
 </li>
       <li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq3QPU20getExecutionThreadIdEv">cudaq::QPU::getExecutionThreadId (C++ function)</a>

pr-2711/examples/python/performance_optimizations.html

@@ -859,7 +859,7 @@ <h2><span class="section-number">5.1. </span>Operations on <code class="code doc
 
 <span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">MEASURE_OP</span><span class="p">(</span><span class="n">qubit</span><span class="w"> </span><span class="o">&amp;</span><span class="n">q</span><span class="p">)</span><span class="w"> </span><span class="k">noexcept</span><span class="p">;</span>
 <span class="w">    </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="kt">bool</span><span class="o">&gt;</span><span class="w"> </span><span class="n">MEASURE_OP</span><span class="p">(</span><span class="n">qvector</span><span class="w"> </span><span class="o">&amp;</span><span class="n">q</span><span class="p">)</span><span class="w"> </span><span class="k">noexcept</span><span class="p">;</span>
-<span class="w">    </span><span class="kt">double</span><span class="w"> </span><span class="nf">measure</span><span class="p">(</span><span class="n">cudaq</span><span class="o">::</span><span class="n">spin_op</span><span class="w"> </span><span class="o">&amp;</span><span class="w"> </span><span class="n">term</span><span class="p">)</span><span class="w"> </span><span class="k">noexcept</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">}</span>
+<span class="w">    </span><span class="kt">double</span><span class="w"> </span><span class="nf">measure</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">cudaq</span><span class="o">::</span><span class="n">spin_op</span><span class="w"> </span><span class="o">&amp;</span><span class="w"> </span><span class="n">term</span><span class="p">)</span><span class="w"> </span><span class="k">noexcept</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">}</span>
 <span class="p">}</span>
 </pre></div>
 </div>

pr-2711/genindex.html

@@ -25,7 +25,7 @@
     "from matplotlib import style\n",
     "style.use('bmh')\n",
     "\n",
-    "cudaq.set_target('nvidia')"
+    "cudaq.set_target(\"nvidia\")"
    ]
   },
   {
@@ -91,7 +91,8 @@
     "\n",
     "$$ \\ket{img} = c_0 \\ket{00} + c_1 \\ket{01} + c_2 \\ket{10} + c_3 \\ket{11}$$\n",
     "\n",
-    "Below, is how to encode an image using QPIE in cudaq.\n"
+    "Below, is how to encode an image using QPIE in cudaq.\n",
+    "\n"
    ]
   },
   {