Add ResultArrayAsInt override to target packages (#1055)

This adds a `ResultArrayAsInt` implementation that is compatible with QIR hardware compilation to the target packages. This will allow it to act as an override for the libraries definition while still supporting calculation of the integer value on platforms that can support it.
microsoft · Dec 2, 2022 · d106fba · d106fba
1 parent c46da38
commit d106fba
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 0 deletions.
diff --git a/src/Simulation/TargetDefinitions/Decompositions/ResultArrayAsInt.qs b/src/Simulation/TargetDefinitions/Decompositions/ResultArrayAsInt.qs
@@ -0,0 +1,18 @@
+namespace Microsoft.Quantum.Convert {
+    open Microsoft.Quantum.Arrays;
+
+    /// # Summary
+    /// Produces a non-negative integer from a string of Results in little endian format.
+    ///
+    /// # Input
+    /// ## results
+    /// Results in binary representation of number.
+    function ResultArrayAsInt(results : Result[]) : Int {
+        mutable val = 0;
+        for i in IndexRange(results) {
+            set val += results[i] == One ? 2 ^ i | 0;
+        }
+        return val;
+    }
+
+}
diff --git a/src/Simulation/TargetDefinitions/TargetPackages/Type1.Package.props b/src/Simulation/TargetDefinitions/TargetPackages/Type1.Package.props
@@ -45,6 +45,7 @@
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1FromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1Frac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResetAll.qs" />
+    <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResultArrayAsInt.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RFrac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RxFromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RyFromSinglyControlled.qs" />

diff --git a/src/Simulation/TargetDefinitions/TargetPackages/Type2.Package.props b/src/Simulation/TargetDefinitions/TargetPackages/Type2.Package.props
@@ -40,6 +40,7 @@
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1Frac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResetAll.qs" />
+    <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResultArrayAsInt.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RFrac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\SetToBasisState.qs" />
 

diff --git a/src/Simulation/TargetDefinitions/TargetPackages/Type3.Package.props b/src/Simulation/TargetDefinitions/TargetPackages/Type3.Package.props
@@ -46,6 +46,7 @@
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1FromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1Frac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResetAll.qs" />
+    <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResultArrayAsInt.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RFrac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RxFromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RyFromSinglyControlled.qs" />

diff --git a/src/Simulation/TargetDefinitions/TargetPackages/Type4.Package.props b/src/Simulation/TargetDefinitions/TargetPackages/Type4.Package.props
@@ -46,6 +46,7 @@
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1FromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\R1Frac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResetAll.qs" />
+    <QSharpCompile Include="..\TargetDefinitions\Decompositions\ResultArrayAsInt.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RFrac.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RxFromSinglyControlled.qs" />
     <QSharpCompile Include="..\TargetDefinitions\Decompositions\RyFromSinglyControlled.qs" />

diff --git a/src/Simulation/TargetDefinitions/Tests/Tests.TargetDefinitions.csproj b/src/Simulation/TargetDefinitions/Tests/Tests.TargetDefinitions.csproj
@@ -40,6 +40,7 @@
     <QsharpCompile Include="..\Decompositions\ExpUtil.qs" />
     <QsharpCompile Include="..\Decompositions\HFromSinglyControlled.qs" />
     <QSharpCompile Include="..\Decompositions\MResetZExplicit.qs" />
+    <QSharpCompile Include="..\Decompositions\ResultArrayAsInt.qs" />
     <QsharpCompile Include="..\Decompositions\RFromSinglyControlledR1.qs" />
     <QsharpCompile Include="..\Decompositions\R1FromSinglyControlled.qs" />
     <QsharpCompile Include="..\Decompositions\RxFromSinglyControlled.qs" />

diff --git a/src/Simulation/TargetDefinitions/Tests/UtilitiesTest.qs b/src/Simulation/TargetDefinitions/Tests/UtilitiesTest.qs
@@ -0,0 +1,16 @@
+namespace UtilitiesTests {
+    open Microsoft.Quantum.Convert;
+    open Microsoft.Quantum.Diagnostics;
+
+    @Test("SparseSimulator")
+    operation VerifyResultArrayAsInt() : Unit {
+        Fact(ResultArrayAsInt([Zero, Zero, Zero]) == 0, "ResultArrayAsInt of 0 value should work");
+        Fact(ResultArrayAsInt([One, Zero, Zero]) == 1, "ResultArrayAsInt of 1 value should work");
+        Fact(ResultArrayAsInt([Zero, One, Zero]) == 2, "ResultArrayAsInt of 2 value should work");
+        Fact(ResultArrayAsInt([One, One, Zero]) == 3, "ResultArrayAsInt of 3 value should work");
+        Fact(ResultArrayAsInt([Zero, Zero, One]) == 4, "ResultArrayAsInt of 4 value should work");
+        Fact(ResultArrayAsInt([One, Zero, One]) == 5, "ResultArrayAsInt of 5 value should work");
+        Fact(ResultArrayAsInt([Zero, One, One]) == 6, "ResultArrayAsInt of 6 value should work");
+        Fact(ResultArrayAsInt([One, One, One]) == 7, "ResultArrayAsInt of 7 value should work");
+    }
+}