Update wire order support for probabilities

.github/CHANGELOG.md

@@ -108,6 +108,9 @@
 
 ### Bug fixes
 
+* Fix wire order permutations when using `qml.probs` with out-of-order wires.
+  [(#707)](https://github.com/PennyLaneAI/pennylane-lightning/pull/707)
+
 * Lightning Qubit once again respects the wire order specified on device instantiation.
   [(#705)](https://github.com/PennyLaneAI/pennylane-lightning/pull/705)
 

.github/workflows/tests_linux_cpp.yml

@@ -44,6 +44,26 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
       - uses: actions/setup-python@v5
         name: Install Python
         with:
@@ -132,6 +152,27 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
+
       - uses: actions/setup-python@v5
         name: Install Python
         with:
@@ -198,6 +239,26 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
       - uses: actions/setup-python@v5
         name: Install Python
         with:
@@ -292,6 +353,26 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
       - uses: actions/setup-python@v5
         name: Install Python
         with:

.github/workflows/tests_lkcpu_python.yml

@@ -53,6 +53,26 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
       - name: Checkout PennyLane-Lightning
         uses: actions/checkout@v4
         with:
@@ -148,6 +168,27 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
+
       - uses: actions/setup-python@v5
         name: Install Python
         with:

.github/workflows/tests_lqcpu_python.yml

@@ -44,6 +44,27 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
+
       - uses: actions/setup-python@v5
         name: Install Python
         with:
@@ -122,6 +143,27 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
+
       - uses: actions/setup-python@v5
         name: Install Python
         with:

.github/workflows/wheel_linux_x86_64.yml

@@ -46,6 +46,27 @@ jobs:
     container: ${{ matrix.container_img }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
+
       - name: Cache installation directories
         id: kokkos-cache
         uses: actions/cache@v3
@@ -107,6 +128,26 @@ jobs:
     container: ${{ matrix.container_img }}
 
     steps:
+      - name: Remove GH Action tooling
+        run: |
+          # Following instructions from Apache Flink
+          # https://github.com/apache/flink/blob/release-1.15/tools/azure-pipelines/free_disk_space.sh
+          echo "=============================================================================="
+          echo "Freeing up disk space on CI system"
+          echo "=============================================================================="
+          echo "Listing 100 largest packages"
+          dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n | tail -n 100
+          df -h
+          echo "Removing large packages"
+          sudo apt-get remove -y '^dotnet-.*'
+          sudo apt-get remove -y microsoft-edge-stable
+          sudo apt-get autoremove -y
+          sudo apt-get clean
+          df -h
+          echo "Removing large directories"
+          # deleting 15GB
+          rm -rf /usr/share/dotnet/
+          df -h
       - name: Restoring cached dependencies
         id: kokkos-cache
         uses: actions/cache@v3

pennylane_lightning/core/src/measurements/tests/Test_MeasurementsBase.cpp

@@ -84,36 +84,41 @@ template <typename TypeList> void testProbabilities() {
         // Expected results calculated with Pennylane default.qubit:
         std::vector<std::pair<std::vector<size_t>, std::vector<PrecisionT>>>
             input = {
-#ifdef _ENABLE_PLGPU
+#if defined(_ENABLE_PLGPU)
                 // Bit index reodering conducted in the python layer
                 // for L-GPU. Also L-GPU backend doesn't support
                 // out of order wires for probability calculation
                 {{2, 1, 0},
                  {0.67078706, 0.03062806, 0.0870997, 0.00397696, 0.17564072,
                   0.00801973, 0.02280642, 0.00104134}}
 #else
-                {{0, 1, 2},
-                 {0.67078706, 0.03062806, 0.0870997, 0.00397696, 0.17564072,
-                  0.00801973, 0.02280642, 0.00104134}},
+#if defined(_ENABLE_PLQUBIT)
+                // LightningQubit currently supports arbitrary wire index
+                // ordering.
                 {{0, 2, 1},
                  {0.67078706, 0.0870997, 0.03062806, 0.00397696, 0.17564072,
                   0.02280642, 0.00801973, 0.00104134}},
                 {{1, 0, 2},
                  {0.67078706, 0.03062806, 0.17564072, 0.00801973, 0.0870997,
                   0.00397696, 0.02280642, 0.00104134}},
                 {{1, 2, 0},
-                 {0.67078706, 0.0870997, 0.17564072, 0.02280642, 0.03062806,
-                  0.00397696, 0.00801973, 0.00104134}},
-                {{2, 0, 1},
                  {0.67078706, 0.17564072, 0.03062806, 0.00801973, 0.0870997,
                   0.02280642, 0.00397696, 0.00104134}},
+                {{2, 0, 1},
+                 {0.67078706, 0.0870997, 0.17564072, 0.02280642, 0.03062806,
+                  0.00397696, 0.00801973, 0.00104134}},
                 {{2, 1, 0},
                  {0.67078706, 0.17564072, 0.0870997, 0.02280642, 0.03062806,
                   0.00801973, 0.00397696, 0.00104134}},
+                {{2, 1}, {0.84642778, 0.10990612, 0.0386478, 0.0050183}},
+
+#endif
+                {{0, 1, 2},
+                 {0.67078706, 0.03062806, 0.0870997, 0.00397696, 0.17564072,
+                  0.00801973, 0.02280642, 0.00104134}},
                 {{0, 1}, {0.70141512, 0.09107666, 0.18366045, 0.02384776}},
                 {{0, 2}, {0.75788676, 0.03460502, 0.19844714, 0.00906107}},
                 {{1, 2}, {0.84642778, 0.0386478, 0.10990612, 0.0050183}},
-                {{2, 1}, {0.84642778, 0.10990612, 0.0386478, 0.0050183}},
                 {{0}, {0.79249179, 0.20750821}},
                 {{1}, {0.88507558, 0.11492442}},
                 {{2}, {0.9563339, 0.0436661}}

pennylane_lightning/core/src/simulators/lightning_gpu/measurements/MeasurementsGPU.hpp

@@ -92,6 +92,10 @@ class Measurements final
      * @return std::vector<PrecisionT>
      */
     auto probs(const std::vector<size_t> &wires) -> std::vector<PrecisionT> {
+        PL_ABORT_IF_NOT(std::is_sorted(wires.cbegin(), wires.cend()),
+                        "LightningGPU does not currently support out-of-order "
+                        "wire indices with probability calculations");
+
         // Data return type fixed as double in custatevec function call
         std::vector<double> probabilities(Pennylane::Util::exp2(wires.size()));
         // this should be built upon by the wires not participating
@@ -193,6 +197,10 @@ class Measurements final
 
     std::vector<PrecisionT> probs(const std::vector<size_t> &wires,
                                   size_t num_shots) {
+        PL_ABORT_IF_NOT(std::is_sorted(wires.cbegin(), wires.cend()),
+                        "LightningGPU does not currently support out-of-order "
+                        "wire indices with probability calculations");
+
         return BaseType::probs(wires, num_shots);
     }
 

pennylane_lightning/core/src/simulators/lightning_kokkos/measurements/MeasurementsKokkos.hpp

@@ -506,6 +506,10 @@ class Measurements final
      * The basis columns are rearranged according to wires.
      */
     std::vector<PrecisionT> probs(const std::vector<size_t> &wires) {
+        PL_ABORT_IF_NOT(
+            std::is_sorted(wires.cbegin(), wires.cend()),
+            "LightningKokkos does not currently support out-of-order wire "
+            "indices with probability calculations");
         using MDPolicyType_2D =
             Kokkos::MDRangePolicy<Kokkos::Rank<2, Kokkos::Iterate::Left>>;
 
@@ -645,6 +649,11 @@ class Measurements final
 
     std::vector<PrecisionT> probs(const std::vector<size_t> &wires,
                                   size_t num_shots) {
+        PL_ABORT_IF_NOT(
+            std::is_sorted(wires.cbegin(), wires.cend()),
+            "LightningKokkos does not currently support out-of-order wire "
+            "indices with probability calculations");
+
         return BaseType::probs(wires, num_shots);
     }