Docs preview for PR #1797.

pr-1797/_sources/api/default_ops.rst.txt

@@ -351,10 +351,6 @@ This operation applies the universal three-parameters operator to target qubit.
  // | exp(iφ) * sin(θ/2) exp(i(λ + φ)) * cos(θ/2) |
  u3(M_PI, M_PI, M_PI_2, q);
 
-.. note:: 
-
- The `u3` operation is currently supported in simulation only.
-
 
 Adjoint and Controlled Operations
 ==================================

pr-1797/_sources/api/languages/cpp_api.rst.txt

@@ -72,6 +72,8 @@ Common
 
 .. doxygenclass:: nvqir::TensorNetSimulationState
 
+.. doxygenclass:: cudaq::RemoteSimulationState
+
 .. doxygenclass:: cudaq::registry::RegisteredType
  :members:
 

pr-1797/api/default_ops.html

@@ -849,10 +849,6 @@ <h3><code class="code docutils literal notranslate"><span class="pre">u3</span><
 </div>
 </div>
 </div>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>The <code class="code docutils literal notranslate"><span class="pre">u3</span></code> operation is currently supported in simulation only.</p>
-</div>
 </section>
 </section>
 <section id="adjoint-and-controlled-operations">

pr-1797/api/languages/cpp_api.html

@@ -1197,6 +1197,24 @@ <h2>Common<a class="headerlink" href="#common" title="Permalink to this heading"
 <dd><p>Pointer to simulation-specific simulation data. </p>
 </dd></dl>
 
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N5cudaq16ExecutionContext13amplitudeMapsE">
+<span class="target" id="classcudaq_1_1ExecutionContext_1a225ca6c6264dc4bab3ebffd1d23252c5"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">complex</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">amplitudeMaps</span></span></span><a class="headerlink" href="#_CPPv4N5cudaq16ExecutionContext13amplitudeMapsE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>A map of basis-state amplitudes. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N5cudaq16ExecutionContext20overlapComputeStatesE">
+<span class="target" id="classcudaq_1_1ExecutionContext_1aa33674ead54268a410e60557fdaeb8e0"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq15SimulationStateE" title="cudaq::SimulationState"><span class="n"><span class="pre">SimulationState</span></span></a><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq15SimulationStateE" title="cudaq::SimulationState"><span class="n"><span class="pre">SimulationState</span></span></a><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">overlapComputeStates</span></span></span><a class="headerlink" href="#_CPPv4N5cudaq16ExecutionContext20overlapComputeStatesE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>List of pairs of states to compute the overlap. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N5cudaq16ExecutionContext13overlapResultE">
+<span class="target" id="classcudaq_1_1ExecutionContext_1a82f52405385514432d039465fde1ddee"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">complex</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">overlapResult</span></span></span><a class="headerlink" href="#_CPPv4N5cudaq16ExecutionContext13overlapResultE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Overlap results. </p>
+</dd></dl>
+
 <dl class="cpp var">
 <dt class="sig sig-object cpp" id="_CPPv4N5cudaq16ExecutionContext11kernelTraceE">
 <span class="target" id="classcudaq_1_1ExecutionContext_1a832079b8beaec29c27462f27704d6386"></span><a class="reference internal" href="#_CPPv4N5cudaq5TraceE" title="cudaq::Trace"><span class="n"><span class="pre">Trace</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kernelTrace</span></span></span><a class="headerlink" href="#_CPPv4N5cudaq16ExecutionContext11kernelTraceE" title="Permalink to this definition">¶</a><br /></dt>
@@ -1819,7 +1837,7 @@ <h2>Common<a class="headerlink" href="#common" title="Permalink to this heading"
 <dt class="sig sig-object cpp" id="_CPPv4N5cudaq15SimulationStateE">
 <span class="target" id="classcudaq_1_1SimulationState"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SimulationState</span></span></span><a class="headerlink" href="#_CPPv4N5cudaq15SimulationStateE" title="Permalink to this definition">¶</a><br /></dt>
 <dd><p>The <code class="docutils literal notranslate"><a class="reference internal" href="#classcudaq_1_1SimulationState"><span class="std std-ref"><span class="pre">SimulationState</span></span></a></code> interface provides and extension point for concrete circuit simulation sub-types to describe their underlying quantum state data in an efficient manner. The <code class="docutils literal notranslate"><a class="reference internal" href="#classcudaq_1_1SimulationState"><span class="std std-ref"><span class="pre">SimulationState</span></span></a></code> provides a handle on the data for clients, with data remaining on GPU device or CPU memory. The primary goal of this type and its sub-types is to minimize data transfers for the state. </p>
-<p>Subclassed by <a class="reference internal" href="#classcudaq_1_1CusvState"><span class="std std-ref">cudaq::CusvState&lt; ScalarType &gt;</span></a>, <a class="reference internal" href="#classnvqir_1_1MPSSimulationState"><span class="std std-ref">nvqir::MPSSimulationState</span></a>, <a class="reference internal" href="#classnvqir_1_1TensorNetSimulationState"><span class="std std-ref">nvqir::TensorNetSimulationState</span></a></p>
+<p>Subclassed by <a class="reference internal" href="#classcudaq_1_1CusvState"><span class="std std-ref">cudaq::CusvState&lt; ScalarType &gt;</span></a>, <a class="reference internal" href="#classcudaq_1_1RemoteSimulationState"><span class="std std-ref">cudaq::RemoteSimulationState</span></a>, <a class="reference internal" href="#classnvqir_1_1MPSSimulationState"><span class="std std-ref">nvqir::MPSSimulationState</span></a>, <a class="reference internal" href="#classnvqir_1_1TensorNetSimulationState"><span class="std std-ref">nvqir::TensorNetSimulationState</span></a></p>
 </dd></dl>
 
 <dl class="cpp struct">
@@ -1895,6 +1913,12 @@ <h2>Common<a class="headerlink" href="#common" title="Permalink to this heading"
 <span class="target" id="classnvqir_1_1TensorNetSimulationState"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TensorNetSimulationState</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5cudaq15SimulationStateE" title="cudaq::SimulationState"><span class="n"><span class="pre">SimulationState</span></span></a><a class="headerlink" href="#_CPPv4N5nvqir24TensorNetSimulationStateE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
+<dl class="cpp class">
+<dt class="sig sig-object cpp" id="_CPPv4N5cudaq21RemoteSimulationStateE">
+<span class="target" id="classcudaq_1_1RemoteSimulationState"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RemoteSimulationState</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5cudaq15SimulationStateE" title="cudaq::SimulationState"><span class="n"><span class="pre">SimulationState</span></span></a><a class="headerlink" href="#_CPPv4N5cudaq21RemoteSimulationStateE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Implementation of <code class="docutils literal notranslate"><a class="reference internal" href="#classcudaq_1_1SimulationState"><span class="std std-ref"><span class="pre">SimulationState</span></span></a></code> for remote simulator backends. </p>
+</dd></dl>
+
 <dl class="cpp class">
 <dt class="sig sig-object cpp" id="_CPPv4I0EN5cudaq8registry14RegisteredTypeE">
 <span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="classcudaq_1_1registry_1_1RegisteredType"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RegisteredType</span></span></span><a class="headerlink" href="#_CPPv4I0EN5cudaq8registry14RegisteredTypeE" title="Permalink to this definition">¶</a><br /></dt>
@@ -2744,6 +2768,12 @@ <h2>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this
 <dd><p>Return the amplitude of the given computational basis state. </p>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5cudaq5state10amplitudesERKNSt6vectorINSt6vectorIiEEEE">
+<span class="target" id="classcudaq_1_1state_1a3341e4701bfc271215631ac9a7c73c82"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">complex</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">amplitudes</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">basisStates</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq5state10amplitudesERKNSt6vectorINSt6vectorIiEEEE" title="Permalink to this definition">¶</a><br /></dt>
+<dd><p>Return the amplitudes of the given list of computational basis states. </p>
+</dd></dl>
+
 </div>
 <div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p>