qsharp-lang 1.3.1 → 1.3.3-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/27/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/27/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Microsoft.Quantum.Unstable.TableLookup

package/lib/node/qsc_wasm.cjs

@@ -396,6 +396,35 @@ module.exports.get_estimates = function(sources, params, language_features) {
     }
 };
 
+/**
+* @param {(Array<any>)[]} sources
+* @param {string} targetProfile
+* @param {IOperationInfo | undefined} operation
+* @param {(string)[]} language_features
+* @returns {any}
+*/
+module.exports.get_circuit = function(sources, targetProfile, operation, language_features) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passArrayJsValueToWasm0(sources, wasm.__wbindgen_export_0);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(targetProfile, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passArrayJsValueToWasm0(language_features, wasm.__wbindgen_export_0);
+        const len2 = WASM_VECTOR_LEN;
+        wasm.get_circuit(retptr, ptr0, len0, ptr1, len1, isLikeNone(operation) ? 0 : addHeapObject(operation), ptr2, len2);
+        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);
+    }
+};
+
 /**
 * @param {string} name
 * @returns {string | undefined}
@@ -516,7 +545,7 @@ function handleError(f, args) {
         wasm.__wbindgen_export_5(addHeapObject(e));
     }
 }
-function __wbg_adapter_170(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_174(arg0, arg1, arg2, arg3) {
     wasm.__wbindgen_export_6(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
@@ -588,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() {
@@ -1110,6 +1157,14 @@ module.exports.__wbindgen_as_number = function(arg0) {
     return ret;
 };
 
+module.exports.__wbg_String_b9412f8799faab3e = function(arg0, arg1) {
+    const ret = String(getObject(arg1));
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+    const len1 = WASM_VECTOR_LEN;
+    getInt32Memory0()[arg0 / 4 + 1] = len1;
+    getInt32Memory0()[arg0 / 4 + 0] = ptr1;
+};
+
 module.exports.__wbg_getwithrefkey_edc2c8960f0f1191 = function(arg0, arg1) {
     const ret = getObject(arg0)[getObject(arg1)];
     return addHeapObject(ret);
@@ -1294,7 +1349,7 @@ module.exports.__wbg_new_81740750da40724f = function(arg0, arg1) {
             const a = state0.a;
             state0.a = 0;
             try {
-                return __wbg_adapter_170(a, state0.b, arg0, arg1);
+                return __wbg_adapter_174(a, state0.b, arg0, arg1);
             } finally {
                 state0.a = a;
             }
@@ -1405,8 +1460,8 @@ module.exports.__wbindgen_memory = function() {
     return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper656 = function(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 233, __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

@@ -27,6 +27,14 @@ export function get_qir(sources: (Array<any>)[], language_features: (string)[]):
 */
 export function get_estimates(sources: (Array<any>)[], params: string, language_features: (string)[]): string;
 /**
+* @param {(Array<any>)[]} sources
+* @param {string} targetProfile
+* @param {IOperationInfo | undefined} operation
+* @param {(string)[]} language_features
+* @returns {any}
+*/
+export function get_circuit(sources: (Array<any>)[], targetProfile: string, operation: IOperationInfo | undefined, language_features: (string)[]): any;
+/**
 * @param {string} name
 * @returns {string | undefined}
 */
@@ -179,10 +187,18 @@ export interface IParameterInformation {
         documentation: string;
     }
 
-export interface ICodeLens {
+export type ICodeLens = {
         range: IRange;
         command: "histogram" | "estimate" | "debug" | "run";
-        args?: [string, string, string];
+    } | {
+        range: IRange;
+        command: "circuit";
+        args?: IOperationInfo
+    }
+
+export interface IOperationInfo {
+        operation: string;
+        totalNumQubits: number;
     }
 
 export interface IWorkspaceEdit {
@@ -239,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

@@ -27,6 +27,14 @@ export function get_qir(sources: (Array<any>)[], language_features: (string)[]):
 */
 export function get_estimates(sources: (Array<any>)[], params: string, language_features: (string)[]): string;
 /**
+* @param {(Array<any>)[]} sources
+* @param {string} targetProfile
+* @param {IOperationInfo | undefined} operation
+* @param {(string)[]} language_features
+* @returns {any}
+*/
+export function get_circuit(sources: (Array<any>)[], targetProfile: string, operation: IOperationInfo | undefined, language_features: (string)[]): any;
+/**
 * @param {string} name
 * @returns {string | undefined}
 */
@@ -179,10 +187,18 @@ export interface IParameterInformation {
         documentation: string;
     }
 
-export interface ICodeLens {
+export type ICodeLens = {
         range: IRange;
         command: "histogram" | "estimate" | "debug" | "run";
-        args?: [string, string, string];
+    } | {
+        range: IRange;
+        command: "circuit";
+        args?: IOperationInfo
+    }
+
+export interface IOperationInfo {
+        operation: string;
+        totalNumQubits: number;
     }
 
 export interface IWorkspaceEdit {
@@ -239,6 +255,10 @@ export class DebugService {
 */
   capture_quantum_state(): IQuantumStateList;
 /**
+* @returns {any}
+*/
+  get_circuit(): any;
+/**
 * @returns {IStackFrameList}
 */
   get_stack_frames(): IStackFrameList;
@@ -400,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;
@@ -433,6 +454,7 @@ export interface InitOutput {
   readonly git_hash: (a: number) => void;
   readonly get_qir: (a: number, b: number, c: number, d: number, e: number) => void;
   readonly get_estimates: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+  readonly get_circuit: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => void;
   readonly get_library_source_content: (a: number, b: number, c: number) => void;
   readonly get_hir: (a: number, b: number, c: number, d: number, e: number) => void;
   readonly run: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;

package/lib/web/qsc_wasm.js

@@ -393,6 +393,35 @@ export function get_estimates(sources, params, language_features) {
     }
 }
 
+/**
+* @param {(Array<any>)[]} sources
+* @param {string} targetProfile
+* @param {IOperationInfo | undefined} operation
+* @param {(string)[]} language_features
+* @returns {any}
+*/
+export function get_circuit(sources, targetProfile, operation, language_features) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passArrayJsValueToWasm0(sources, wasm.__wbindgen_export_0);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(targetProfile, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passArrayJsValueToWasm0(language_features, wasm.__wbindgen_export_0);
+        const len2 = WASM_VECTOR_LEN;
+        wasm.get_circuit(retptr, ptr0, len0, ptr1, len1, isLikeNone(operation) ? 0 : addHeapObject(operation), ptr2, len2);
+        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);
+    }
+}
+
 /**
 * @param {string} name
 * @returns {string | undefined}
@@ -513,7 +542,7 @@ function handleError(f, args) {
         wasm.__wbindgen_export_5(addHeapObject(e));
     }
 }
-function __wbg_adapter_170(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_174(arg0, arg1, arg2, arg3) {
     wasm.__wbindgen_export_6(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
@@ -585,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() {
@@ -1112,6 +1159,13 @@ function __wbg_get_imports() {
         const ret = +getObject(arg0);
         return ret;
     };
+    imports.wbg.__wbg_String_b9412f8799faab3e = function(arg0, arg1) {
+        const ret = String(getObject(arg1));
+        const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+        const len1 = WASM_VECTOR_LEN;
+        getInt32Memory0()[arg0 / 4 + 1] = len1;
+        getInt32Memory0()[arg0 / 4 + 0] = ptr1;
+    };
     imports.wbg.__wbg_getwithrefkey_edc2c8960f0f1191 = function(arg0, arg1) {
         const ret = getObject(arg0)[getObject(arg1)];
         return addHeapObject(ret);
@@ -1262,7 +1316,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_170(a, state0.b, arg0, arg1);
+                    return __wbg_adapter_174(a, state0.b, arg0, arg1);
                 } finally {
                     state0.a = a;
                 }
@@ -1354,8 +1408,8 @@ function __wbg_get_imports() {
         const ret = wasm.memory;
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper656 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 233, __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.1",
+  "version": "1.3.3-dev",
   "license": "MIT",
   "engines": {
     "node": ">=16.17.0"

package/ux/circuit.tsx

@@ -0,0 +1,98 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import * as qviz from "@microsoft/quantum-viz.js/lib";
+import { useEffect, useRef } from "preact/hooks";
+
+// 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 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>
+        <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;
+
+  if (errorDiv) {
+    return <div class=".qs-circuit-error">{errorDiv}</div>;
+  }
+
+  const circuitDiv = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    qviz.draw(props.circuit, circuitDiv.current!);
+
+    // quantum-viz hardcodes the styles in the SVG.
+    // Remove the style elements -- we'll define the styles in our own CSS.
+    const styleElements = circuitDiv.current?.querySelectorAll("style");
+    styleElements?.forEach((tag) => tag.remove());
+  }, [props.circuit]);
+
+  return <div class="qs-circuit" ref={circuitDiv}></div>;
+}
+
+/* This component is exclusive to the VS Code panel */
+export function CircuitPanel(props: {
+  title: string;
+  subtitle: string;
+  circuit?: qviz.Circuit;
+  errorHtml?: string;
+}) {
+  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>
+      <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/index.ts

@@ -4,6 +4,7 @@
 // By importing the CSS here, esbuild will by default bundle it up and copy it
 // to a CSS file adjacent to the JS bundle and with the same name.
 import "./qsharp-ux.css";
+import "./qsharp-circuit.css";
 
 export { CreateSingleEstimateResult, type ReData } from "./data.js";
 export { Histogram } from "./histogram.js";
@@ -12,3 +13,4 @@ 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";

package/ux/qsharp-circuit.css

@@ -0,0 +1,194 @@
+/* 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
+  https://github.com/microsoft/quantum-viz.js/blob/288e0cb506ee866ecca1b414c522e2d634f7b36d/src/styles.ts
+*/
+
+/* Background color for the circuit diagram */
+.qs-circuit {
+  background: var(--main-background);
+}
+
+/* Wires and gate outlines */
+.qs-circuit line,
+.qs-circuit circle,
+.qs-circuit rect {
+  stroke: var(--main-color);
+  stroke-width: 1;
+}
+
+/* Text for qubit labels */
+.qs-circuit text {
+  fill: var(--main-color);
+  dominant-baseline: middle;
+  text-anchor: middle;
+  font-family: Arial;
+}
+
+/* Background for gates */
+.qs-circuit .gate-unitary {
+  fill: var(--vscode-button-secondaryBackground, #d9f1fa);
+}
+
+/* Text for gates */
+.qs-circuit .gate text {
+  fill: var(--vscode-button-secondaryForeground, #000000);
+}
+
+/* Dot and line for controlled gates */
+.qs-circuit .gate > line,
+.qs-circuit .control-dot {
+  fill: var(--main-color);
+}
+
+/* X gate */
+.qs-circuit .gate > .oplus > line,
+.qs-circuit .gate > .oplus > circle {
+  fill: var(--main-background);
+  stroke: var(--main-color);
+  stroke-width: 2;
+}
+
+/* Measurement gate */
+.qs-circuit .gate-measure {
+  fill: var(--vscode-button-background, #ffde86);
+}
+
+/* Measurement gate icon */
+.qs-circuit .gate > g > line,
+.qs-circuit .arc-measure {
+  stroke: var(--vscode-button-foreground, #000000);
+  fill: none;
+  stroke-width: 1;
+}
+
+/* SWAP gate */
+.qs-circuit rect.gate-swap {
+  fill: transparent;
+  stroke: transparent;
+}
+
+/* Classical wire */
+.qs-circuit .register-classical {
+  stroke-width: 0.5;
+}
+
+/*
+  The following styles are unused so they are unthemed.
+  They relate to conditional circuits which are not currently supported.
+*/
+
+.qs-circuit .hidden {
+  display: none;
+}
+
+.qs-circuit .classically-controlled-unknown {
+  opacity: 0.25;
+}
+
+.qs-circuit .classically-controlled-one .classical-container,
+.qs-circuit .classically-controlled-one .classical-line {
+  stroke: #4059bd;
+  stroke-width: 1.3;
+  fill: #4059bd;
+  fill-opacity: 0.1;
+}
+
+.qs-circuit .classically-controlled-zero .classical-container,
+.qs-circuit .classically-controlled-zero .classical-line {
+  stroke: #c40000;
+  stroke-width: 1.3;
+  fill: #c40000;
+  fill-opacity: 0.1;
+}
+
+.qs-circuit .classically-controlled-btn {
+  cursor: pointer;
+}
+
+.qs-circuit .classically-controlled-unknown .classically-controlled-btn {
+  fill: #e5e5e5;
+}
+
+.qs-circuit .classically-controlled-one .classically-controlled-btn {
+  fill: #4059bd;
+}
+
+.qs-circuit .classically-controlled-zero .classically-controlled-btn {
+  fill: #c40000;
+}
+
+.qs-circuit .classically-controlled-btn text {
+  dominant-baseline: middle;
+  text-anchor: middle;
+  stroke: none;
+  font-family: Arial;
+}
+
+.qs-circuit .classically-controlled-unknown .classically-controlled-btn text {
+  fill: #000000;
+}
+
+.qs-circuit .classically-controlled-one .classically-controlled-btn text {
+  fill: #ffffff;
+}
+
+.qs-circuit .classically-controlled-zero .classically-controlled-btn text {
+  fill: #ffffff;
+}
+
+.qs-circuit .qviz .gate-collapse,
+.qs-circuit .qviz .gate-expand {
+  opacity: 0;
+  transition: opacity 1s;
+}
+
+.qs-circuit .qviz:hover .gate-collapse,
+.qs-circuit .qviz:hover .gate-expand {
+  visibility: visible;
+  opacity: 0.2;
+  transition: visibility 1s;
+  transition: opacity 1s;
+}
+
+.qs-circuit .gate-expand,
+.gate-collapse {
+  cursor: pointer;
+}
+
+.qs-circuit .gate-collapse circle,
+.qs-circuit .gate-expand circle {
+  fill: white;
+  stroke-width: 2px;
+  stroke: black;
+}
+
+.qs-circuit .gate-collapse path,
+.qs-circuit .gate-expand path {
+  stroke-width: 4px;
+  stroke: black;
+}
+
+.qs-circuit .gate:hover > .gate-collapse,
+.qs-circuit .gate:hover > .gate-expand {
+  visibility: visible;
+  opacity: 1;
+  transition: opacity 1s;
+}