Merge pull request #918 from microsoft/kuzminrobin/sparseSim

Sparse Simulator

Author: kuzminrobin

bootstrap.ps1

@@ -28,9 +28,7 @@ if (-not (Test-Path Env:/AGENT_OS)) {                                    # If no
         Pop-Location
 
         Write-Host "Build release flavor of the Sparse Simulator"
-        Push-Location (Join-Path $PSScriptRoot "src/Simulation/Simulators/SparseSimulator")
-            .\build.ps1
-        Pop-Location
+        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

build/build.ps1

@@ -23,7 +23,7 @@ if ($Env:ENABLE_NATIVE -ne "false") {
         $script:all_ok = $False
     }
 
-    ( & (Join-Path $PSScriptRoot .. src Simulation Simulators SparseSimulator build.ps1) ) || ( $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/test.ps1

@@ -5,7 +5,7 @@
 $all_ok = $True
 
 if ($Env:ENABLE_NATIVE -ne "false") {
-    ( & (Join-Path $PSScriptRoot .. src Simulation Simulators SparseSimulator test.ps1) ) || ( $script:all_ok = $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"

global.json

@@ -1,5 +1,5 @@
 {
     "msbuild-sdks": {
-        "Microsoft.Quantum.Sdk": "0.22.185393-alpha"
+        "Microsoft.Quantum.Sdk": "0.22.186614-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:

src/Qir/Tools/Microsoft.Quantum.Qir.Runtime.Tools.csproj

@@ -36,7 +36,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
-    <PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.22.185393-alpha" />
+    <PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.22.186614-beta" />
   </ItemGroup>
 
   <ItemGroup>

src/Simulation/AutoSubstitution/Microsoft.Quantum.AutoSubstitution.csproj

@@ -19,7 +19,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Quantum.Compiler" Version="0.22.185393-alpha" />
+    <PackageReference Include="Microsoft.Quantum.Compiler" Version="0.22.186614-beta" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="3.6.0" />
   </ItemGroup>
 

src/Simulation/Common/Simulators.Dev.props

@@ -7,6 +7,7 @@
     <NativeRootPath>$([MSBuild]::NormalizePath($(EnlistmentRoot)src/Simulation/Native))</NativeRootPath>
     <NativeBuildPath>$([MSBuild]::NormalizePath($(NativeRootPath)/build/drop))</NativeBuildPath>
     <ExperimentalSimBuildPath>$([MSBuild]::NormalizePath($(EnlistmentRoot)src/Simulation/qdk_sim_rs/drop))</ExperimentalSimBuildPath>
+    <NativeSparseSimBuildPath>$([MSBuild]::NormalizePath($(EnlistmentRoot)src/Simulation/NativeSparseSimulator/build))</NativeSparseSimBuildPath>
   </PropertyGroup>
 
   <ItemGroup>
@@ -26,6 +27,11 @@
       <NativeDll Include="$([MSBuild]::NormalizePath($(ExperimentalSimBuildPath)/libqdk_sim.dylib))" Dest="osx/Microsoft.Quantum.Experimental.Simulators.Runtime.dll" />
       <NativeDll Include="$([MSBuild]::NormalizePath($(ExperimentalSimBuildPath)/libqdk_sim.so))" Dest="linux/Microsoft.Quantum.Experimental.Simulators.Runtime.dll" />
       <NativeDll Include="$([MSBuild]::NormalizePath($(ExperimentalSimBuildPath)/qdk_sim.dll))" Dest="win10/Microsoft.Quantum.Experimental.Simulators.Runtime.dll" />
+
+      <!-- Native Sparse Simulator: -->
+      <NativeDll Include="$([MSBuild]::NormalizePath($(NativeSparseSimBuildPath)/libSparseQuantumSimulator.dylib))" Dest="osx/libSparseQuantumSimulator.dylib" />
+      <NativeDll Include="$([MSBuild]::NormalizePath($(NativeSparseSimBuildPath)/libSparseQuantumSimulator.so))" Dest="linux/libSparseQuantumSimulator.so" />
+      <NativeDll Include="$([MSBuild]::NormalizePath($(NativeSparseSimBuildPath)/SparseQuantumSimulator.dll))" Dest="win10/SparseQuantumSimulator.dll" />
     </ItemGroup>
 
     <Copy