Jazzy: Update docs folder

indisoluble · Dec 12, 2021 · d5d1e7e · d5d1e7e
1 parent bd858a6
commit d5d1e7e
Show file tree

Hide file tree

Showing 194 changed files with 3,776 additions and 2,388 deletions.
diff --git a/docs/Enums.html b/docs/Enums.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -537,25 +540,26 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:21SwiftQuantumComputing20MakeStatevectorErrorO"></a>
-                    <a name="//apple_ref/swift/Enum/MakeStatevectorError" class="dashAnchor"></a>
-                    <a class="token" href="#/s:21SwiftQuantumComputing20MakeStatevectorErrorO">MakeStatevectorError</a>
+                    <a name="/s:21SwiftQuantumComputing25GroupedProbabilitiesErrorO"></a>
+                    <a name="//apple_ref/swift/Enum/GroupedProbabilitiesError" class="dashAnchor"></a>
+                    <a class="token" href="#/s:21SwiftQuantumComputing25GroupedProbabilitiesErrorO">GroupedProbabilitiesError</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Errors throwed by <code><a href="Protocols/CircuitStatevectorFactory.html#/s:21SwiftQuantumComputing25CircuitStatevectorFactoryP04makeE06vectors6ResultOyAA0dE0_pAA04MakeE5ErrorOGAA6VectorV_tF">CircuitStatevectorFactory.makeStatevector(vector:)</a></code></p>
+                        <p>Errors throwed by
+<code><a href="Protocols/CircuitProbabilities.html#/s:21SwiftQuantumComputing20CircuitProbabilitiesPAAE07groupedE08byQubits012summarizedByH030roundingSummaryToDecimalPlacess6ResultOySDySSSd11probability_SDySSSdG7summarytGAA07GroupedE5ErrorOGSaySiG_AQSiSgtF">CircuitProbabilities.groupedProbabilities(byQubits:summarizedByQubits:roundingSummaryToDecimalPlaces:)</a></code>.</p>
 
-                        <a href="Enums/MakeStatevectorError.html" class="slightly-smaller">See more</a>
+                        <a href="Enums/GroupedProbabilitiesError.html" class="slightly-smaller">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MakeStatevectorError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">GroupedProbabilitiesError</span> <span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">Hashable</span></code></pre>
 
                         </div>
                       </div>
@@ -565,26 +569,25 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:21SwiftQuantumComputing25GroupedProbabilitiesErrorO"></a>
-                    <a name="//apple_ref/swift/Enum/GroupedProbabilitiesError" class="dashAnchor"></a>
-                    <a class="token" href="#/s:21SwiftQuantumComputing25GroupedProbabilitiesErrorO">GroupedProbabilitiesError</a>
+                    <a name="/s:21SwiftQuantumComputing28SummarizedProbabilitiesErrorO"></a>
+                    <a name="//apple_ref/swift/Enum/SummarizedProbabilitiesError" class="dashAnchor"></a>
+                    <a class="token" href="#/s:21SwiftQuantumComputing28SummarizedProbabilitiesErrorO">SummarizedProbabilitiesError</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Errors throwed by
-<code><a href="Protocols/CircuitStatevector.html#/s:21SwiftQuantumComputing18CircuitStatevectorPAAE20groupedProbabilities8byQubits012summarizedByI030roundingSummaryToDecimalPlacess6ResultOySDySSSd11probability_SDySSSdG7summarytGAA07GroupedG5ErrorOGSaySiG_AQSiSgtF">CircuitStatevector.groupedProbabilities(byQubits:summarizedByQubits:roundingSummaryToDecimalPlaces:)</a></code>.</p>
+                        <p>Errors throwed by <code><a href="Protocols/CircuitProbabilities.html#/s:21SwiftQuantumComputing20CircuitProbabilitiesPAAE010summarizedE08byQubitss6ResultOySDySSSdGAA010SummarizedE5ErrorOGSaySiG_tF">CircuitProbabilities.summarizedProbabilities(byQubits:)</a></code>.</p>
 
-                        <a href="Enums/GroupedProbabilitiesError.html" class="slightly-smaller">See more</a>
+                        <a href="Enums/SummarizedProbabilitiesError.html" class="slightly-smaller">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">GroupedProbabilitiesError</span> <span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">Hashable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SummarizedProbabilitiesError</span> <span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">Hashable</span></code></pre>
 
                         </div>
                       </div>
@@ -594,25 +597,25 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:21SwiftQuantumComputing28SummarizedProbabilitiesErrorO"></a>
-                    <a name="//apple_ref/swift/Enum/SummarizedProbabilitiesError" class="dashAnchor"></a>
-                    <a class="token" href="#/s:21SwiftQuantumComputing28SummarizedProbabilitiesErrorO">SummarizedProbabilitiesError</a>
+                    <a name="/s:21SwiftQuantumComputing20MakeStatevectorErrorO"></a>
+                    <a name="//apple_ref/swift/Enum/MakeStatevectorError" class="dashAnchor"></a>
+                    <a class="token" href="#/s:21SwiftQuantumComputing20MakeStatevectorErrorO">MakeStatevectorError</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Errors throwed by <code><a href="Protocols/CircuitStatevector.html#/s:21SwiftQuantumComputing18CircuitStatevectorPAAE23summarizedProbabilities8byQubitss6ResultOySDySSSdGAA010SummarizedG5ErrorOGSaySiG_tF">CircuitStatevector.summarizedProbabilities(byQubits:)</a></code>.</p>
+                        <p>Errors throwed by <code><a href="Protocols/CircuitStatevectorFactory.html#/s:21SwiftQuantumComputing25CircuitStatevectorFactoryP04makeE06vectors6ResultOyAA0dE0_pAA04MakeE5ErrorOGAA6VectorV_tF">CircuitStatevectorFactory.makeStatevector(vector:)</a></code></p>
 
-                        <a href="Enums/SummarizedProbabilitiesError.html" class="slightly-smaller">See more</a>
+                        <a href="Enums/MakeStatevectorError.html" class="slightly-smaller">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SummarizedProbabilitiesError</span> <span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">Hashable</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MakeStatevectorError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
 
                         </div>
                       </div>
@@ -919,7 +922,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/DecomposeGatesError.html b/docs/Enums/DecomposeGatesError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -399,7 +402,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/DensityMatrixError.html b/docs/Enums/DensityMatrixError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -507,7 +510,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/DrawCircuitError.html b/docs/Enums/DrawCircuitError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -535,7 +538,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/EvolveCircuitError.html b/docs/Enums/EvolveCircuitError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -480,7 +483,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/GateError.html b/docs/Enums/GateError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -508,7 +511,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/GroupedProbabilitiesError.html b/docs/Enums/GroupedProbabilitiesError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -356,7 +359,7 @@ <h1>GroupedProbabilitiesError</h1>
                 </div>
               </div>
             <p>Errors throwed by
-<code><a href="../Protocols/CircuitStatevector.html#/s:21SwiftQuantumComputing18CircuitStatevectorPAAE20groupedProbabilities8byQubits012summarizedByI030roundingSummaryToDecimalPlacess6ResultOySDySSSd11probability_SDySSSdG7summarytGAA07GroupedG5ErrorOGSaySiG_AQSiSgtF">CircuitStatevector.groupedProbabilities(byQubits:summarizedByQubits:roundingSummaryToDecimalPlaces:)</a></code>.</p>
+<code><a href="../Protocols/CircuitProbabilities.html#/s:21SwiftQuantumComputing20CircuitProbabilitiesPAAE07groupedE08byQubits012summarizedByH030roundingSummaryToDecimalPlacess6ResultOySDySSSd11probability_SDySSSdG7summarytGAA07GroupedE5ErrorOGSaySiG_AQSiSgtF">CircuitProbabilities.groupedProbabilities(byQubits:summarizedByQubits:roundingSummaryToDecimalPlaces:)</a></code>.</p>
 
           </div>
         </section>
@@ -454,7 +457,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/MakeDensityMatrixError.html b/docs/Enums/MakeDensityMatrixError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -480,7 +483,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/MakeStatevectorBitsError.html b/docs/Enums/MakeStatevectorBitsError.html
@@ -143,6 +143,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitFactory.html">CircuitFactory</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CircuitProbabilities.html">CircuitProbabilities</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/CircuitStatevector.html">CircuitStatevector</a>
               </li>
@@ -399,7 +402,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-09-24)</p>
+      <p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-12-12)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
     </section>
   </body>