qsharp-lang 1.3.2-dev → 1.3.4-dev

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/22/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/22/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/lib/node/qsc_wasm.cjs

@@ -545,7 +545,7 @@ function handleError(f, args) {
         wasm.__wbindgen_export_5(addHeapObject(e));
     }
 }
-function __wbg_adapter_173(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_174(arg0, arg1, arg2, arg3) {
     wasm.__wbindgen_export_6(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
@@ -617,6 +617,24 @@ class DebugService {
         return takeObject(ret);
     }
     /**
+    * @returns {any}
+    */
+    get_circuit() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.debugservice_get_circuit(retptr, this.__wbg_ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
     * @returns {IStackFrameList}
     */
     get_stack_frames() {
@@ -1331,7 +1349,7 @@ module.exports.__wbg_new_81740750da40724f = function(arg0, arg1) {
             const a = state0.a;
             state0.a = 0;
             try {
-                return __wbg_adapter_173(a, state0.b, arg0, arg1);
+                return __wbg_adapter_174(a, state0.b, arg0, arg1);
             } finally {
                 state0.a = a;
             }
@@ -1442,8 +1460,8 @@ module.exports.__wbindgen_memory = function() {
     return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper696 = function(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 292, __wbg_adapter_54);
+module.exports.__wbindgen_closure_wrapper701 = function(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 294, __wbg_adapter_54);
     return addHeapObject(ret);
 };
 

package/lib/node/qsc_wasm.d.cts

@@ -255,6 +255,10 @@ export class DebugService {
 */
   capture_quantum_state(): IQuantumStateList;
 /**
+* @returns {any}
+*/
+  get_circuit(): any;
+/**
 * @returns {IStackFrameList}
 */
   get_stack_frames(): IStackFrameList;

package/lib/web/qsc_wasm.d.ts

@@ -255,6 +255,10 @@ export class DebugService {
 */
   capture_quantum_state(): IQuantumStateList;
 /**
+* @returns {any}
+*/
+  get_circuit(): any;
+/**
 * @returns {IStackFrameList}
 */
   get_stack_frames(): IStackFrameList;
@@ -416,6 +420,7 @@ export interface InitOutput {
   readonly debugservice_new: () => number;
   readonly debugservice_load_source: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
   readonly debugservice_capture_quantum_state: (a: number) => number;
+  readonly debugservice_get_circuit: (a: number, b: number) => void;
   readonly debugservice_get_stack_frames: (a: number) => number;
   readonly debugservice_eval_next: (a: number, b: number, c: number, d: number, e: number) => void;
   readonly debugservice_eval_continue: (a: number, b: number, c: number, d: number, e: number) => void;

package/lib/web/qsc_wasm.js

@@ -542,7 +542,7 @@ function handleError(f, args) {
         wasm.__wbindgen_export_5(addHeapObject(e));
     }
 }
-function __wbg_adapter_173(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_174(arg0, arg1, arg2, arg3) {
     wasm.__wbindgen_export_6(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
@@ -614,6 +614,24 @@ export class DebugService {
         return takeObject(ret);
     }
     /**
+    * @returns {any}
+    */
+    get_circuit() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.debugservice_get_circuit(retptr, this.__wbg_ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
     * @returns {IStackFrameList}
     */
     get_stack_frames() {
@@ -1298,7 +1316,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_173(a, state0.b, arg0, arg1);
+                    return __wbg_adapter_174(a, state0.b, arg0, arg1);
                 } finally {
                     state0.a = a;
                 }
@@ -1390,8 +1408,8 @@ function __wbg_get_imports() {
         const ret = wasm.memory;
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper696 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 292, __wbg_adapter_54);
+    imports.wbg.__wbindgen_closure_wrapper701 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 294, __wbg_adapter_54);
         return addHeapObject(ret);
     };
 

package/package.json

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

package/ux/circuit.tsx

@@ -3,11 +3,48 @@
 
 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
+// reasonably want to look at, but it takes about a second to
+// render a circuit this big on a mid-grade laptop so we allow it.
+const MAX_OPERATIONS = 10000;
+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>
+      </div>
+    ) : props.circuit.operations.length > MAX_OPERATIONS ? (
+      <div>
+        <p>
+          This circuit has too many gates to display. It has{" "}
+          {props.circuit.operations.length} gates, but the maximum supported is{" "}
+          {MAX_OPERATIONS}.
+        </p>
+      </div>
+    ) : props.circuit.qubits.length > MAX_QUBITS ? (
+      <div>
+        <p>
+          This circuit has too many qubits to display. It has{" "}
+          {props.circuit.qubits.length} qubits, but the maximum supported is{" "}
+          {MAX_QUBITS}.
+        </p>
+      </div>
+    ) : undefined;
+
   useEffect(() => {
+    if (errorDiv !== undefined) {
+      circuitDiv.current!.innerHTML = "";
+      return;
+    }
+
     qviz.draw(props.circuit, circuitDiv.current!);
 
     // quantum-viz hardcodes the styles in the SVG.
@@ -16,33 +53,66 @@ 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>
+  );
 }
 
-export function CircuitPanel(props: {
-  title: string;
-  subtitle: string;
-  circuit?: qviz.Circuit;
-  errorHtml?: string;
-}) {
-  return (
+/* This component is exclusive to the VS Code panel */
+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>
-        <h2>{props.subtitle}</h2>
       </div>
       {props.circuit ? <Circuit circuit={props.circuit}></Circuit> : null}
-      <div class="qs-circuit-error">
-        {props.errorHtml ? (
-          <div dangerouslySetInnerHTML={{ __html: props.errorHtml }}></div>
-        ) : null}
-      </div>
-      <div>
-        Tip: you can generate a circuit diagram for any operation that takes
-        qubits or arrays of qubits as input.
-      </div>
+      <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
+        </a>
+      </p>
     </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";

package/ux/qsharp-circuit.css

@@ -1,11 +1,20 @@
 /* Copyright (c) Microsoft Corporation.
    Licensed under the MIT License. */
 
+/* Circuit panel */
+.qs-circuit-panel p {
+  padding: 10px 0px;
+}
+
 /* Error div in circuit panel */
 .qs-circuit-error {
   padding: 10px 0px;
 }
 
+.qs-circuit-error p {
+  padding: 10px 0px;
+}
+
 /*
   Styles for Q# circuits.
   Copied and modified from the default CSS generated by