qsharp-lang 1.3.3-dev → 1.3.4-dev

package/docs/Microsoft.Quantum.Unstable.Arithmetic/LookAheadDKRSAddLE.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.LookAheadDKRSAddLE
 title: LookAheadDKRSAddLE operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.Arithmetic/MAJ.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.MAJ
 title: MAJ operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.Arithmetic/ReflectAboutInteger.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.ReflectAboutInteger
 title: ReflectAboutInteger operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGAddLE.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.RippleCarryCGAddLE
 title: RippleCarryCGAddLE operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGIncByLE.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.RippleCarryCGIncByLE
 title: RippleCarryCGIncByLE operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryTTKIncByLE.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.Arithmetic.RippleCarryTTKIncByLE
 title: RippleCarryTTKIncByLE operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.Arithmetic

package/docs/Microsoft.Quantum.Unstable.StatePreparation/ApproximatelyPreparePureStateCP.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.StatePreparation.ApproximatelyPreparePureStateCP
 title: ApproximatelyPreparePureStateCP operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.StatePreparation

package/docs/Microsoft.Quantum.Unstable.StatePreparation/PreparePureStateD.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.StatePreparation.PreparePureStateD
 title: PreparePureStateD operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.StatePreparation

package/docs/Microsoft.Quantum.Unstable.TableLookup/Select.md

@@ -1,7 +1,7 @@
 ---
 uid: Qdk.Microsoft.Quantum.Unstable.TableLookup.Select
 title: Select operation
-ms.date: 03/27/2024 12:00:00 AM
+ms.date: 03/28/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.TableLookup

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qsharp-lang",
   "description": "qsharp language package for quantum development",
-  "version": "1.3.3-dev",
+  "version": "1.3.4-dev",
   "license": "MIT",
   "engines": {
     "node": ">=16.17.0"

package/ux/circuit.tsx

@@ -3,6 +3,7 @@
 
 import * as qviz from "@microsoft/quantum-viz.js/lib";
 import { useEffect, useRef } from "preact/hooks";
+import { CircuitProps } from "./data.js";
 
 // For perf reasons we set a limit on how many gates/qubits
 // we attempt to render. This is still a lot higher than a human would
@@ -13,16 +14,12 @@ const MAX_QUBITS = 1000;
 
 /* This component is shared by the Python widget and the VS Code panel */
 export function Circuit(props: { circuit: qviz.Circuit }) {
+  const circuitDiv = useRef<HTMLDivElement>(null);
+
   const errorDiv =
     props.circuit.qubits.length === 0 ? (
       <div>
         <p>No circuit to display. No qubits have been allocated.</p>
-        <p>
-          <em>
-            Tip: you can generate a circuit diagram for any operation that takes
-            qubits or arrays of qubits as input.
-          </em>
-        </p>
       </div>
     ) : props.circuit.operations.length > MAX_OPERATIONS ? (
       <div>
@@ -42,13 +39,12 @@ export function Circuit(props: { circuit: qviz.Circuit }) {
       </div>
     ) : undefined;
 
-  if (errorDiv) {
-    return <div class=".qs-circuit-error">{errorDiv}</div>;
-  }
-
-  const circuitDiv = useRef<HTMLDivElement>(null);
-
   useEffect(() => {
+    if (errorDiv !== undefined) {
+      circuitDiv.current!.innerHTML = "";
+      return;
+    }
+
     qviz.draw(props.circuit, circuitDiv.current!);
 
     // quantum-viz hardcodes the styles in the SVG.
@@ -57,35 +53,61 @@ export function Circuit(props: { circuit: qviz.Circuit }) {
     styleElements?.forEach((tag) => tag.remove());
   }, [props.circuit]);
 
-  return <div class="qs-circuit" ref={circuitDiv}></div>;
+  return (
+    <div>
+      <div class="qs-circuit-error">{errorDiv}</div>
+      <div class="qs-circuit" ref={circuitDiv}></div>
+    </div>
+  );
 }
 
 /* This component is exclusive to the VS Code panel */
-export function CircuitPanel(props: {
-  title: string;
-  subtitle: string;
-  circuit?: qviz.Circuit;
-  errorHtml?: string;
-}) {
+export function CircuitPanel(props: CircuitProps) {
+  const error = props.errorHtml ? (
+    <div>
+      <p>
+        {props.circuit
+          ? "The program encountered a failure. See the error(s) below."
+          : "A circuit could not be generated for this program. See the error(s) below."}
+        <br />
+      </p>
+      <div dangerouslySetInnerHTML={{ __html: props.errorHtml }}></div>
+    </div>
+  ) : null;
+
   return (
     <div class="qs-circuit-panel">
       <div>
         <h1>{props.title}</h1>
       </div>
       {props.circuit ? <Circuit circuit={props.circuit}></Circuit> : null}
-      <div class="qs-circuit-error">
-        {props.errorHtml ? (
-          <div>
-            <p>
-              A circuit could not be generated for this program. See the
-              error(s) below.
-              <br />
-            </p>
-            <div dangerouslySetInnerHTML={{ __html: props.errorHtml }}></div>
-          </div>
-        ) : null}
-      </div>
-      <p>{props.subtitle /* target profile */}</p>
+      <div class="qs-circuit-error">{error}</div>
+      <p>{props.targetProfile}</p>
+      {props.simulating ? (
+        <p>
+          This circuit diagram was generated while running the program in the
+          simulator.
+          <br />
+          <br />
+          If your program contains behavior that is conditional on a qubit
+          measurement result, note that this circuit only shows the outcome that
+          was encountered during this simulation. Running the program again may
+          result in a different circuit being generated.
+        </p>
+      ) : null}
+      {
+        // show tip when the circuit is empty and we didn't run under the simulator (i.e. debugging)
+        !props.simulating &&
+        !props.errorHtml &&
+        props.circuit?.qubits.length === 0 ? (
+          <p>
+            <em>
+              Tip: you can generate a circuit diagram for any operation that
+              takes qubits or arrays of qubits as input.
+            </em>
+          </p>
+        ) : null
+      }
       <p>
         <a href="https://github.com/microsoft/qsharp/wiki/Circuit-Diagrams-from-Q%23-Code">
           Learn more
@@ -94,5 +116,3 @@ export function CircuitPanel(props: {
     </div>
   );
 }
-
-export type CircuitData = qviz.Circuit;

package/ux/data.ts

@@ -63,3 +63,13 @@ export function CreateSingleEstimateResult(
     };
   }
 }
+
+export type CircuitProps = {
+  title: string;
+  circuit?: CircuitData;
+  errorHtml?: string;
+  targetProfile: string;
+  simulating: boolean;
+};
+
+export type CircuitData = import("@microsoft/quantum-viz.js/lib").Circuit;

package/ux/index.ts

@@ -6,11 +6,16 @@
 import "./qsharp-ux.css";
 import "./qsharp-circuit.css";
 
-export { CreateSingleEstimateResult, type ReData } from "./data.js";
+export {
+  CreateSingleEstimateResult,
+  type ReData,
+  type CircuitData,
+  type CircuitProps,
+} from "./data.js";
 export { Histogram } from "./histogram.js";
 export { ReTable } from "./reTable.js";
 export { SpaceChart } from "./spaceChart.js";
 export { ScatterChart } from "./scatterChart.js";
 export { EstimatesOverview } from "./estimatesOverview.js";
 export { EstimatesPanel } from "./estimatesPanel.js";
-export { Circuit, CircuitPanel, type CircuitData } from "./circuit.js";
+export { Circuit, CircuitPanel } from "./circuit.js";