qiskit 1.0.0b1__cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

qiskit/transpiler/synthesis/aqc/fast_gradient/pmatrix.py

@@ -0,0 +1,312 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+Matrix designed for fast multiplication by permutation and block-diagonal ones.
+"""
+
+import numpy as np
+from .layer import Layer1Q, Layer2Q
+
+
+class PMatrix:
+    """
+    Wrapper around a matrix that enables fast multiplication by permutation
+    matrices and block-diagonal ones.
+    """
+
+    def __init__(self, num_qubits: int):
+        """
+        Initializes the internal structures of this object but does not set
+        the matrix yet.
+
+        Args:
+            num_qubits: number of qubits.
+        """
+        dim = 2**num_qubits
+        self._mat = np.empty(0)
+        self._dim = dim
+        self._temp_g2x2 = np.zeros((2, 2), dtype=np.complex128)
+        self._temp_g4x4 = np.zeros((4, 4), dtype=np.complex128)
+        self._temp_2x2 = self._temp_g2x2.copy()
+        self._temp_4x4 = self._temp_g4x4.copy()
+        self._identity_perm = np.arange(dim, dtype=np.int64)
+        self._left_perm = self._identity_perm.copy()
+        self._right_perm = self._identity_perm.copy()
+        self._temp_perm = self._identity_perm.copy()
+        self._temp_slice_dim_x_2 = np.zeros((dim, 2), dtype=np.complex128)
+        self._temp_slice_dim_x_4 = np.zeros((dim, 4), dtype=np.complex128)
+        self._idx_mat = self._init_index_matrix(dim)
+        self._temp_block_diag = np.zeros(self._idx_mat.shape, dtype=np.complex128)
+
+    def set_matrix(self, mat: np.ndarray):
+        """
+        Copies specified matrix to internal storage. Once the matrix
+        is set, the object is ready for use.
+
+        **Note**, the matrix will be copied, mind the size issues.
+
+        Args:
+            mat: matrix we want to multiply on the left and on the right by
+                 layer matrices.
+        """
+        if self._mat.size == 0:
+            self._mat = mat.copy()
+        else:
+            np.copyto(self._mat, mat)
+
+    @staticmethod
+    def _init_index_matrix(dim: int) -> np.ndarray:
+        """
+        Fast multiplication can be implemented by picking up a subset of
+        entries in a sparse matrix.
+
+        Args:
+            dim: problem dimensionality.
+
+        Returns:
+            2d-array of indices for the fast multiplication.
+        """
+        all_idx = np.arange(dim * dim, dtype=np.int64).reshape(dim, dim)
+        idx = np.full((dim // 4, 4 * 4), fill_value=0, dtype=np.int64)
+        b = np.full((4, 4), fill_value=0, dtype=np.int64)
+        for i in range(0, dim, 4):
+            b[:, :] = all_idx[i : i + 4, i : i + 4]
+            idx[i // 4, :] = b.T.ravel()
+        return idx
+
+    def mul_right_q1(self, layer: Layer1Q, temp_mat: np.ndarray, dagger: bool):
+        """
+        Multiplies ``NxN`` matrix, wrapped by this object, by a 1-qubit layer
+        matrix of the right, where ``N`` is the actual size of matrices involved,
+        ``N = 2^{num. of qubits}``.
+
+        Args:
+            layer: 1-qubit layer, i.e. the layer with just one non-trivial
+                   1-qubit gate and other gates are just identity operators.
+            temp_mat: a temporary NxN matrix used as a workspace.
+            dagger: if true, the right-hand side matrix will be taken as
+                    conjugate transposed.
+        """
+
+        gmat, perm, inv_perm = layer.get_attr()
+        mat = self._mat
+        dim = perm.size
+
+        # temp_mat <-- mat[:, right_perm[perm]] = mat[:, right_perm][:, perm]:
+        np.take(mat, np.take(self._right_perm, perm, out=self._temp_perm), axis=1, out=temp_mat)
+
+        # mat <-- mat[:, right_perm][:, perm] @ kron(I(N/4), gmat)^dagger, where
+        # conjugate-transposition might be or might be not applied:
+        gmat_right = np.conj(gmat, out=self._temp_g2x2).T if dagger else gmat
+        for i in range(0, dim, 2):
+            mat[:, i : i + 2] = np.dot(
+                temp_mat[:, i : i + 2], gmat_right, out=self._temp_slice_dim_x_2
+            )
+
+        # Update right permutation:
+        self._right_perm[:] = inv_perm
+
+    def mul_right_q2(self, layer: Layer2Q, temp_mat: np.ndarray, dagger: bool = True):
+        """
+        Multiplies ``NxN`` matrix, wrapped by this object, by a 2-qubit layer
+        matrix on the right, where ``N`` is the actual size of matrices involved,
+        ``N = 2^{num. of qubits}``.
+
+        Args:
+            layer: 2-qubit layer, i.e. the layer with just one non-trivial
+                   2-qubit gate and other gates are just identity operators.
+            temp_mat: a temporary NxN matrix used as a workspace.
+            dagger: if true, the right-hand side matrix will be taken as
+                    conjugate transposed.
+        """
+
+        gmat, perm, inv_perm = layer.get_attr()
+        mat = self._mat
+        dim = perm.size
+
+        # temp_mat <-- mat[:, right_perm[perm]] = mat[:, right_perm][:, perm]:
+        np.take(mat, np.take(self._right_perm, perm, out=self._temp_perm), axis=1, out=temp_mat)
+
+        # mat <-- mat[:, right_perm][:, perm] @ kron(I(N/4), gmat)^dagger, where
+        # conjugate-transposition might be or might be not applied:
+        gmat_right = np.conj(gmat, out=self._temp_g4x4).T if dagger else gmat
+        for i in range(0, dim, 4):
+            mat[:, i : i + 4] = np.dot(
+                temp_mat[:, i : i + 4], gmat_right, out=self._temp_slice_dim_x_4
+            )
+
+        # Update right permutation:
+        self._right_perm[:] = inv_perm
+
+    def mul_left_q1(self, layer: Layer1Q, temp_mat: np.ndarray):
+        """
+        Multiplies ``NxN`` matrix, wrapped by this object, by a 1-qubit layer
+        matrix of the left, where ``dim`` is the actual size of matrices involved,
+        ``dim = 2^{num. of qubits}``.
+
+        Args:
+            layer: 1-qubit layer, i.e. the layer with just one non-trivial
+                   1-qubit gate and other gates are just identity operators.
+            temp_mat: a temporary NxN matrix used as a workspace.
+        """
+        mat = self._mat
+        gmat, perm, inv_perm = layer.get_attr()
+        dim = perm.size
+
+        # temp_mat <-- mat[left_perm[perm]] = mat[left_perm][perm]:
+        np.take(mat, np.take(self._left_perm, perm, out=self._temp_perm), axis=0, out=temp_mat)
+
+        # mat <-- kron(I(dim/4), gmat) @ mat[left_perm][perm]:
+        if dim > 512:
+            # Faster for large matrices.
+            for i in range(0, dim, 2):
+                np.dot(gmat, temp_mat[i : i + 2, :], out=mat[i : i + 2, :])
+        else:
+            # Faster for small matrices.
+            half = dim // 2
+            np.copyto(
+                mat.reshape((2, half, dim)), np.swapaxes(temp_mat.reshape((half, 2, dim)), 0, 1)
+            )
+            np.dot(gmat, mat.reshape(2, -1), out=temp_mat.reshape(2, -1))
+            np.copyto(
+                mat.reshape((half, 2, dim)), np.swapaxes(temp_mat.reshape((2, half, dim)), 0, 1)
+            )
+
+        # Update left permutation:
+        self._left_perm[:] = inv_perm
+
+    def mul_left_q2(self, layer: Layer2Q, temp_mat: np.ndarray):
+        """
+        Multiplies ``NxN`` matrix, wrapped by this object, by a 2-qubit layer
+        matrix on the left, where ``dim`` is the actual size of matrices involved,
+        ``dim = 2^{num. of qubits}``.
+
+        Args:
+            layer: 2-qubit layer, i.e. the layer with just one non-trivial
+                   2-qubit gate and other gates are just identity operators.
+            temp_mat: a temporary NxN matrix used as a workspace.
+        """
+        mat = self._mat
+        gmat, perm, inv_perm = layer.get_attr()
+        dim = perm.size
+
+        # temp_mat <-- mat[left_perm[perm]] = mat[left_perm][perm]:
+        np.take(mat, np.take(self._left_perm, perm, out=self._temp_perm), axis=0, out=temp_mat)
+
+        # mat <-- kron(I(dim/4), gmat) @ mat[left_perm][perm]:
+        if dim > 512:
+            # Faster for large matrices.
+            for i in range(0, dim, 4):
+                np.dot(gmat, temp_mat[i : i + 4, :], out=mat[i : i + 4, :])
+        else:
+            # Faster for small matrices.
+            half = dim // 4
+            np.copyto(
+                mat.reshape((4, half, dim)), np.swapaxes(temp_mat.reshape((half, 4, dim)), 0, 1)
+            )
+            np.dot(gmat, mat.reshape(4, -1), out=temp_mat.reshape(4, -1))
+            np.copyto(
+                mat.reshape((half, 4, dim)), np.swapaxes(temp_mat.reshape((4, half, dim)), 0, 1)
+            )
+
+        # Update left permutation:
+        self._left_perm[:] = inv_perm
+
+    def product_q1(self, layer: Layer1Q, tmp1: np.ndarray, tmp2: np.ndarray) -> np.complex128:
+        """
+        Computes and returns: ``Trace(mat @ C) = Trace(mat @ P^T @ gmat @ P) =
+        Trace((P @ mat @ P^T) @ gmat) = Trace(C @ (P @ mat @ P^T)) =
+        vec(gmat^T)^T @ vec(P @ mat @ P^T)``, where mat is ``NxN`` matrix wrapped
+        by this object, ``C`` is matrix representation of the layer ``L``, and gmat
+        is 2x2 matrix of underlying 1-qubit gate.
+
+        **Note**: matrix of this class must be finalized beforehand.
+
+        Args:
+            layer: 1-qubit layer.
+            tmp1: temporary, external matrix used as a workspace.
+            tmp2: temporary, external matrix used as a workspace.
+
+        Returns:
+            trace of the matrix product.
+        """
+        mat = self._mat
+        gmat, perm, _ = layer.get_attr()
+
+        # tmp2 = P @ mat @ P^T:
+        np.take(np.take(mat, perm, axis=0, out=tmp1), perm, axis=1, out=tmp2)
+
+        # matrix dot product = Tr(transposed(kron(I(dim/4), gmat)), (P @ mat @ P^T)):
+        gmat_t, tmp3 = self._temp_g2x2, self._temp_2x2
+        np.copyto(gmat_t, gmat.T)
+        _sum = 0.0
+        for i in range(0, mat.shape[0], 2):
+            tmp3[:, :] = tmp2[i : i + 2, i : i + 2]
+            _sum += np.dot(gmat_t.ravel(), tmp3.ravel())
+
+        return np.complex128(_sum)
+
+    def product_q2(self, layer: Layer2Q, tmp1: np.ndarray, tmp2: np.ndarray) -> np.complex128:
+        """
+        Computes and returns: ``Trace(mat @ C) = Trace(mat @ P^T @ gmat @ P) =
+        Trace((P @ mat @ P^T) @ gmat) = Trace(C @ (P @ mat @ P^T)) =
+        vec(gmat^T)^T @ vec(P @ mat @ P^T)``, where mat is ``NxN`` matrix wrapped
+        by this object, ``C`` is matrix representation of the layer ``L``, and gmat
+        is 4x4 matrix of underlying 2-qubit gate.
+
+        **Note**: matrix of this class must be finalized beforehand.
+
+        Args:
+            layer: 2-qubit layer.
+            tmp1: temporary, external matrix used as a workspace.
+            tmp2: temporary, external matrix used as a workspace.
+
+        Returns:
+            trace of the matrix product.
+        """
+        mat = self._mat
+        gmat, perm, _ = layer.get_attr()
+
+        # Compute the matrix dot product:
+        # Tr(transposed(kron(I(dim/4), gmat)), (P @ mat @ P^T)):
+
+        # The fastest version so far, but requires two NxN temp. matrices.
+        # tmp2 = P @ mat @ P^T:
+        np.take(np.take(mat, perm, axis=0, out=tmp1), perm, axis=1, out=tmp2)
+
+        bldia = self._temp_block_diag
+        np.take(tmp2.ravel(), self._idx_mat.ravel(), axis=0, out=bldia.ravel())
+        bldia *= gmat.reshape(-1, gmat.size)
+        return np.complex128(np.sum(bldia))
+
+    def finalize(self, temp_mat: np.ndarray) -> np.ndarray:
+        """
+        Applies the left (row) and right (column) permutations to the matrix.
+        at the end of computation process.
+
+        Args:
+            temp_mat: temporary, external matrix.
+
+        Returns:
+            finalized matrix with all transformations applied.
+        """
+        mat = self._mat
+
+        # mat <-- mat[left_perm][:, right_perm] = P_left @ mat @ transposed(P_right)
+        np.take(mat, self._left_perm, axis=0, out=temp_mat)
+        np.take(temp_mat, self._right_perm, axis=1, out=mat)
+
+        # Set both permutations to identity once they have been applied.
+        self._left_perm[:] = self._identity_perm
+        self._right_perm[:] = self._identity_perm
+        return self._mat

qiskit/transpiler/synthesis/graysynth.py

@@ -0,0 +1,114 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2023.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+# pylint: disable=unused-wildcard-import, wildcard-import
+
+"""
+Implementation of the GraySynth algorithm for synthesizing CNOT-Phase
+circuits with efficient CNOT cost, and the Patel-Hayes-Markov algorithm
+for optimal synthesis of linear (CNOT-only) reversible circuits.
+"""
+
+
+# Redirect getattrs to modules new location
+# TODO: Deprecate in 0.24.0 and remove in 0.26.0
+from qiskit.synthesis.linear.cnot_synth import *
+from qiskit.synthesis.linear_phase.cnot_phase_synth import *
+
+
+def cnot_synth(state, section_size=2):
+    """
+    Synthesize linear reversible circuits for all-to-all architecture
+    using Patel, Markov and Hayes method.
+
+    This function is an implementation of the Patel, Markov and Hayes algorithm from [1]
+    for optimal synthesis of linear reversible circuits for all-to-all architecture,
+    as specified by an n x n matrix.
+
+    Args:
+        state (list[list] or ndarray): n x n boolean invertible matrix, describing the state
+            of the input circuit
+        section_size (int): the size of each section, used in the
+            Patel–Markov–Hayes algorithm [1]. section_size must be a factor of num_qubits.
+
+    Returns:
+        QuantumCircuit: a CX-only circuit implementing the linear transformation.
+
+    Raises:
+        QiskitError: when variable "state" isn't of type numpy.ndarray
+
+    References:
+        1. Patel, Ketan N., Igor L. Markov, and John P. Hayes,
+           *Optimal synthesis of linear reversible circuits*,
+           Quantum Information & Computation 8.3 (2008): 282-294.
+           `arXiv:quant-ph/0302002 [quant-ph] <https://arxiv.org/abs/quant-ph/0302002>`_
+    """
+    return synth_cnot_count_full_pmh(state, section_size=section_size)
+
+
+def graysynth(cnots, angles, section_size=2):
+    """This function is an implementation of the GraySynth algorithm of
+    Amy, Azimadeh and Mosca.
+
+    GraySynth is a heuristic algorithm from [1] for synthesizing small parity networks.
+    It is inspired by Gray codes. Given a set of binary strings S
+    (called "cnots" bellow), the algorithm synthesizes a parity network for S by
+    repeatedly choosing an index i to expand and then effectively recursing on
+    the co-factors S_0 and S_1, consisting of the strings y in S,
+    with y_i = 0 or 1 respectively. As a subset S is recursively expanded,
+    CNOT gates are applied so that a designated target bit contains the
+    (partial) parity ksi_y(x) where y_i = 1 if and only if y'_i = 1 for all
+    y' in S. If S is a singleton {y'}, then y = y', hence the target bit contains
+    the value ksi_y'(x) as desired.
+
+    Notably, rather than uncomputing this sequence of CNOT gates when a subset S
+    is finished being synthesized, the algorithm maintains the invariant
+    that the remaining parities to be computed are expressed over the current state
+    of bits. This allows the algorithm to avoid the 'backtracking' inherent in
+    uncomputing-based methods.
+
+    The algorithm is described in detail in section 4 of [1].
+
+    Args:
+        cnots (list[list]): a matrix whose columns are the parities to be synthesized
+            e.g.::
+
+                [[0, 1, 1, 1, 1, 1],
+                 [1, 0, 0, 1, 1, 1],
+                 [1, 0, 0, 1, 0, 0],
+                 [0, 0, 1, 0, 1, 0]]
+
+            corresponds to::
+
+                 x1^x2 + x0 + x0^x3 + x0^x1^x2 + x0^x1^x3 + x0^x1
+
+        angles (list): a list containing all the phase-shift gates which are
+            to be applied, in the same order as in "cnots". A number is
+            interpreted as the angle of p(angle), otherwise the elements
+            have to be 't', 'tdg', 's', 'sdg' or 'z'.
+
+        section_size (int): the size of every section, used in _lwr_cnot_synth(), in the
+            Patel–Markov–Hayes algorithm. section_size must be a factor of num_qubits.
+
+    Returns:
+        QuantumCircuit: the decomposed quantum circuit.
+
+    Raises:
+        QiskitError: when dimensions of cnots and angles don't align.
+
+    References:
+        1. Matthew Amy, Parsiad Azimzadeh, and Michele Mosca.
+           *On the controlled-NOT complexity of controlled-NOT–phase circuits.*,
+           Quantum Science and Technology 4.1 (2018): 015002.
+           `arXiv:1712.01859 <https://arxiv.org/abs/1712.01859>`_
+    """
+    return synth_cnot_phase_aam(cnots, angles, section_size=section_size)