qsharp-lang 1.8.6-dev → 1.9.0

package/dist/compiler/common.d.ts

@@ -14,6 +14,11 @@ interface DumpMsg {
     state: Dump;
     stateLatex: string | null;
 }
+interface MatrixMsg {
+    type: "Matrix";
+    matrix: number[][][];
+    matrixLatex: string;
+}
 interface MessageMsg {
     type: "Message";
     message: string;
@@ -22,11 +27,11 @@ interface ResultMsg {
     type: "Result";
     result: Result;
 }
-type EventMsg = ResultMsg | DumpMsg | MessageMsg;
+type EventMsg = ResultMsg | DumpMsg | MatrixMsg | MessageMsg;
 export declare function eventStringToMsg(msg: string): EventMsg | null;
 export type ShotResult = {
     success: boolean;
     result: string | VSDiagnostic;
-    events: Array<MessageMsg | DumpMsg>;
+    events: Array<MessageMsg | DumpMsg | MatrixMsg>;
 };
 export {};

package/dist/compiler/common.js

@@ -42,6 +42,21 @@ function outputAsDump(msg) {
     }
     return null;
 }
+function outputAsMatrix(msg) {
+    try {
+        const obj = JSON.parse(msg);
+        if (obj?.type == "Matrix" && Array.isArray(obj.matrix)) {
+            return obj;
+        }
+    }
+    catch {
+        return null;
+    }
+    return null;
+}
 export function eventStringToMsg(msg) {
-    return outputAsResult(msg) || outputAsMessage(msg) || outputAsDump(msg);
+    return (outputAsResult(msg) ||
+        outputAsMessage(msg) ||
+        outputAsDump(msg) ||
+        outputAsMatrix(msg));
 }

package/dist/compiler/compiler.js

@@ -109,6 +109,12 @@ export function onCompilerEvent(msg, eventTarget) {
         case "Result":
             qscEvent = makeEvent("Result", qscMsg.result);
             break;
+        case "Matrix":
+            qscEvent = makeEvent("Matrix", {
+                matrix: qscMsg.matrix,
+                matrixLatex: qscMsg.matrixLatex,
+            });
+            break;
         default:
             log.never(msgType);
             throw "Unexpected message type";
@@ -130,5 +136,5 @@ export const compilerProtocol = {
         run: "requestWithProgress",
         checkExerciseSolution: "requestWithProgress",
     },
-    eventNames: ["DumpMachine", "Message", "Result"],
+    eventNames: ["DumpMachine", "Matrix", "Message", "Result"],
 };

package/dist/compiler/events.d.ts

@@ -9,6 +9,12 @@ export type QscEventData = {
         state: Dump;
         stateLatex: string | null;
     };
+} | {
+    type: "Matrix";
+    detail: {
+        matrix: number[][][];
+        matrixLatex: string;
+    };
 } | {
     type: "Result";
     detail: Result;
@@ -40,6 +46,7 @@ export declare class QscEventTarget implements IQscEventTarget {
      */
     constructor(captureEvents: boolean);
     private onMessage;
+    private onMatrix;
     private onDumpMachine;
     private onResult;
     private ensureActiveShot;

package/dist/compiler/events.js

@@ -35,6 +35,7 @@ export class QscEventTarget {
             this.addEventListener("Message", (ev) => this.onMessage(ev.detail));
             this.addEventListener("DumpMachine", (ev) => this.onDumpMachine(ev.detail));
             this.addEventListener("Result", (ev) => this.onResult(ev.detail));
+            this.addEventListener("Matrix", (ev) => this.onMatrix(ev.detail));
         }
     }
     onMessage(msg) {
@@ -43,6 +44,16 @@ export class QscEventTarget {
         this.results[shotIdx].events.push({ type: "Message", message: msg });
         this.queueUiRefresh();
     }
+    onMatrix(detail) {
+        this.ensureActiveShot();
+        const shotIdx = this.results.length - 1;
+        this.results[shotIdx].events.push({
+            type: "Matrix",
+            matrix: detail.matrix,
+            matrixLatex: detail.matrixLatex,
+        });
+        this.queueUiRefresh();
+    }
     onDumpMachine(detail) {
         this.ensureActiveShot();
         const shotIdx = this.results.length - 1;

package/dist/debug-service/debug-service.js

@@ -75,6 +75,12 @@ export function onCompilerEvent(msg, eventTarget) {
         case "Result":
             qscEvent = makeEvent("Result", qscMsg.result);
             break;
+        case "Matrix":
+            qscEvent = makeEvent("Matrix", {
+                matrix: qscMsg.matrix,
+                matrixLatex: qscMsg.matrixLatex,
+            });
+            break;
         default:
             log.never(msgType);
             throw "Unexpected message type";
@@ -98,5 +104,5 @@ export const debugServiceProtocol = {
         evalStepOut: "requestWithProgress",
         dispose: "request",
     },
-    eventNames: ["DumpMachine", "Message", "Result"],
+    eventNames: ["DumpMachine", "Message", "Matrix", "Result"],
 };

package/docs/Std.Diagnostics/DumpOperation.md

@@ -0,0 +1,43 @@
+---
+uid: Qdk.Std.Diagnostics.DumpOperation
+title: DumpOperation operation
+ms.date: 09/30/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Std.Diagnostics
+qsharp.name: DumpOperation
+qsharp.summary: "Given an operation, dumps the matrix representation of the operation action on the given number of qubits."
+---
+
+# DumpOperation operation
+
+Fully qualified name: Std.Diagnostics.DumpOperation
+
+```qsharp
+operation DumpOperation(nQubits : Int, op : (Qubit[] => Unit is Adj)) : Unit
+```
+
+## Summary
+Given an operation, dumps the matrix representation of the operation action on the given
+number of qubits.
+
+## Input
+### nQubits
+The number of qubits on which the given operation acts.
+### op
+The operation that is to be diagnosed.
+
+## Remarks
+When run on the sparse-state simulator, the following snippet
+will output the matrix
+$\left(\begin{matrix} 0.0 & 0.707 \\\\ 0.707 & 0.0\end{matrix}\right)$:
+
+```qsharp
+operation DumpH() : Unit {
+    DumpOperation(1, qs => H(qs[0]));
+}
+```
+Calling this operation has no observable effect from within Q#.
+Note that if `DumpOperation` is called when there are other qubits allocated,
+the matrix displayed may reflect any global phase that has accumulated from operations
+on those other qubits.

package/docs/toc.yml

@@ -140,6 +140,7 @@
   uid: Qdk.Std.Core
 - items:
   - {name: DumpMachine, uid: Qdk.Std.Diagnostics.DumpMachine}
+  - {name: DumpOperation, uid: Qdk.Std.Diagnostics.DumpOperation}
   - {name: DumpRegister, uid: Qdk.Std.Diagnostics.DumpRegister}
   - {name: Fact, uid: Qdk.Std.Diagnostics.Fact}
   name: Std.Diagnostics

package/lib/node/qsc_wasm.cjs

@@ -1537,8 +1537,8 @@ module.exports.__wbindgen_memory = function() {
     return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper902 = function(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 363, __wbg_adapter_52);
+module.exports.__wbindgen_closure_wrapper905 = function(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 364, __wbg_adapter_52);
     return addHeapObject(ret);
 };
 

package/lib/web/qsc_wasm.js

@@ -1475,8 +1475,8 @@ function __wbg_get_imports() {
         const ret = wasm.memory;
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper902 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 363, __wbg_adapter_52);
+    imports.wbg.__wbindgen_closure_wrapper905 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 364, __wbg_adapter_52);
         return addHeapObject(ret);
     };
 

package/package.json

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