Sparse simulator (core components) (#939)

Co-authored-by: DmitryVasilevsky <[email protected]>
Co-authored-by: Sam Jaques <[email protected]>
Co-authored-by: Dmitry Vasilevsky <[email protected]>
Co-authored-by: Thomas Haener <[email protected]>
Co-authored-by: Robin Kuzmin <[email protected]>
Co-authored-by: Thomas Haener <[email protected]>
Co-authored-by: Robin Kuzmin <[email protected]>
Co-authored-by: Bettina Heim <[email protected]>

Author: 7 people

.gitignore

@@ -232,7 +232,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -328,7 +328,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -337,7 +337,7 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
 /src/Simulation/Simulators.Tests/TestProjects/QSharpExe/built
@@ -357,6 +357,9 @@ xplat
 src/Simulation/Native/win10/Microsoft.Quantum.Simulator.Runtime.dll
 src/Simulation/Native/linux/libMicrosoft.Quantum.Simulator.Runtime.so
 src/Simulation/Native/osx/libMicrosoft.Quantum.Simulator.Runtime.dylib
+src/Simulation/Native/win10/SparseQuantumSimulator.dll
+src/Simulation/Native/linux/libSparseQuantumSimulator.so
+src/Simulation/Native/osx/libSparseQuantumSimulator.dylib
 src/Simulation/Native/win10/Microsoft.Quantum.Experimental.Simulators.Runtime.dll
 src/Simulation/Native/linux/Microsoft.Quantum.Experimental.Simulators.Runtime.dll
 src/Simulation/Native/osx/Microsoft.Quantum.Experimental.Simulators.Runtime.dll

Simulation.sln

@@ -855,7 +855,7 @@ Global
 		{EB6E3DBD-C884-4241-9BC4-8281191D1F53} = {34D419E9-CCF1-4E48-9FA4-3AD4B86BEEB4}
 		{E1A463D7-2E23-4134-BE04-1EFF7A546813} = {93409CC3-8DF9-45FA-AE21-16A19FDEF650}
 		{789C86D9-CE77-40DA-BDDD-979436952512} = {93409CC3-8DF9-45FA-AE21-16A19FDEF650}
-		{7E24885B-D86D-477E-A840-06FA53C33FE1} = {34D419E9-CCF1-4E48-9FA4-3AD4B86BEEB4}
+		{7E24885B-D86D-477E-A840-06FA53C33FE1} = {93409CC3-8DF9-45FA-AE21-16A19FDEF650}
 		{7F80466B-A6B5-4EF1-A9E9-22ABAE3C20C1} = {34D419E9-CCF1-4E48-9FA4-3AD4B86BEEB4}
 		{7F7BB60A-5DCB-469E-8546-1BE9E3CAC833} = {F6C2D4C0-12DC-40E3-9C86-FA5308D9B567}
 		{EAC5EAE7-D1B3-4726-AFDB-73000E62176A} = {7F7BB60A-5DCB-469E-8546-1BE9E3CAC833}

bootstrap.ps1

@@ -21,11 +21,15 @@ Pop-Location
 
 if (-not (Test-Path Env:/AGENT_OS)) {                                    # If not CI build, i.e. local build (if AGENT_OS envvar is not defined)
     if ($Env:ENABLE_NATIVE -ne "false") {
-        Write-Host "Build release flavor of the native simulator"
         $Env:BUILD_CONFIGURATION = "Release"
+        Write-Host "Build release flavor of the full state simulator"
         Push-Location (Join-Path $PSScriptRoot "src/Simulation/Native")
             .\build-native-simulator.ps1
         Pop-Location
+
+        Write-Host "Build release flavor of the Sparse Simulator"
+        Invoke-Expression (Join-Path $PSScriptRoot "src" "Simulation" "NativeSparseSimulator" "build.ps1")
+
         Push-Location (Join-Path $PSScriptRoot "src/Simulation/qdk_sim_rs")
             # Don't run the experimental simulator build if we're local
             # and prerequisites are missing.

build/build.ps1

@@ -22,6 +22,8 @@ if ($Env:ENABLE_NATIVE -ne "false") {
     if ($LastExitCode -ne 0) {
         $script:all_ok = $False
     }
+
+    ( & (Join-Path $PSScriptRoot .. src Simulation NativeSparseSimulator build.ps1) ) || ( $script:all_ok = $False )
 } else {
     Write-Host "Skipping build of native simulator because ENABLE_NATIVE variable is set to: $Env:ENABLE_NATIVE."
 }

build/pack.ps1

@@ -26,6 +26,17 @@ Push-Location (Join-Path $PSScriptRoot ../src/Simulation/Native)
         Copy-Item -Verbose "$DROP/Microsoft.Quantum.Simulator.Runtime.dll" "win10/Microsoft.Quantum.Simulator.Runtime.dll"
     }
 
+    $DROP = "$Env:DROP_NATIVE/src/Simulation/NativeSparseSimulator/build"
+    Write-Host "##[info]Copying NativeSparseSimulator files from $DROP...";
+    If (Test-Path "$DROP/libSparseQuantumSimulator.dylib") {
+        Copy-Item -Verbose "$DROP/libSparseQuantumSimulator.dylib" "osx/libSparseQuantumSimulator.dylib"
+    }
+    If (Test-Path "$DROP/libSparseQuantumSimulator.so") {
+        Copy-Item -Verbose "$DROP/libSparseQuantumSimulator.so" "linux/libSparseQuantumSimulator.so"
+    }
+    If (Test-Path "$DROP/SparseQuantumSimulator.dll") {
+        Copy-Item -Verbose "$DROP/SparseQuantumSimulator.dll" "win10/SparseQuantumSimulator.dll"
+    }
 
     $DROP = "$Env:DROP_NATIVE/src/Simulation/qdk_sim_rs/drop";
     Write-Host "##[info]Copying qdk_sim_rs files from $DROP...";
@@ -43,7 +54,7 @@ Pop-Location
 
 function Pack-One() {
     Param(
-        $project, 
+        $project,
         $option1 = "",
         $option2 = "",
         $option3 = "",
@@ -74,7 +85,7 @@ function Pack-One() {
 
 function Pack-Dotnet() {
     Param(
-        $project, 
+        $project,
         $option1 = "",
         $option2 = "",
         $option3 = "",

build/test.ps1

@@ -5,6 +5,8 @@
 $all_ok = $True
 
 if ($Env:ENABLE_NATIVE -ne "false") {
+    ( & (Join-Path $PSScriptRoot .. src Simulation NativeSparseSimulator test.ps1 ) ) || ( $script:all_ok = $False )
+
     $nativeSimulator = (Join-Path $PSScriptRoot "../src/Simulation/Native")
     & "$nativeSimulator/test-native-simulator.ps1"
     if ($LastExitCode -ne 0) {

global.json

@@ -1,5 +1,5 @@
 {
     "msbuild-sdks": {
-        "Microsoft.Quantum.Sdk": "0.22.192799-alpha"
+        "Microsoft.Quantum.Sdk": "0.22.192949-beta"
     }
 }

src/Qir/Runtime/lib/Simulators/FullstateSimulator.cpp

@@ -159,11 +159,11 @@ namespace Quantum
         {
             std::cout << "*********************" << std::endl;
             this->GetState(
-                [](size_t idx, double re, double im)
+                [](const char* idx, double re, double im)
                 {
                     if (!Close(re, 0.0) || !Close(im, 0.0))
                     {
-                        std::cout << "|" << std::bitset<8>(idx) << ">: " << re << "+" << im << "i" << std::endl;
+                        std::cout << "|" << idx << ">: " << re << "+" << im << "i" << std::endl;
                     }
                     return true;
                 });

src/Qir/Runtime/public/QSharpSimApi_I.hpp

@@ -64,7 +64,8 @@ namespace Quantum
 
         // The callback should be invoked on each basis vector (in the standard computational basis) in little-endian
         // order until it returns `false` or the state is fully dumped.
-        typedef bool (*TGetStateCallback)(size_t /*basis vector*/, double /* amplitude Re*/, double /* amplitude Im*/);
+        typedef bool (*TGetStateCallback)(const char* /*basis vector*/, double /* amplitude Re*/,
+                                          double /* amplitude Im*/);
 
         // Deprecated, use `DumpMachine()` and `DumpRegister()` instead.
         virtual void GetState(TGetStateCallback callback) = 0;

src/Qir/Tests/FullstateSimulator/FullstateSimulatorTests.cpp

@@ -3,6 +3,7 @@
 
 #include <complex>
 #include <memory>
+#include <string>
 #include <vector>
 
 #define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one cpp file
@@ -347,9 +348,14 @@ TEST_CASE("Fullstate simulator: get qubit state of Bell state", "[fullstate_simu
     // 1/sqrt(2)(|00> + |11>)x|0>
 
     dynamic_cast<IDiagnostics*>(sim.get())->GetState(
-        [](size_t idx, double re, double im)
+        [](const char* idxStr, double re, double im)
         {
             norm += re * re + im * im;
+            size_t idx = 0;
+            for (size_t i = 0; idxStr[i] != '\0'; ++i)
+            {
+                idx |= (idxStr[i] == '1' ? 1u : 0u) << i;
+            }
             REQUIRE(idx < 4);
             switch (idx)
             {
@@ -372,9 +378,14 @@ TEST_CASE("Fullstate simulator: get qubit state of Bell state", "[fullstate_simu
     // 1/sqrt(2)(|00> + |11>)xi|1>
 
     dynamic_cast<IDiagnostics*>(sim.get())->GetState(
-        [](size_t idx, double re, double im)
+        [](const char* idxStr, double re, double im)
         {
             norm += re * re + im * im;
+            size_t idx = 0;
+            for (size_t i = 0; idxStr[i] != '\0'; ++i)
+            {
+                idx |= (idxStr[i] == '1' ? 1u : 0u) << i;
+            }
             switch (idx)
             {
             case 4: