Merge pull request #216 from GenericP3rson/functional_reformatting

Reformatting Functionals

torchquantum/functional/__init__.py

@@ -22,12 +22,197 @@
 SOFTWARE.
 """
 
-from .functionals import *
+from .gate_wrapper import gate_wrapper, apply_unitary_einsum, apply_unitary_bmm
+from .hadamard import hadamard, shadamard, _hadamard_mat_dict, h, ch, sh, chadamard
+from .rx import rx, rxx, crx, xx, _rx_mat_dict, rx_matrix, rxx_matrix, crx_matrix
+from .ry import ry, ryy, cry, yy, _ry_mat_dict, ry_matrix, ryy_matrix, cry_matrix
+from .rz import (
+    rz,
+    rzz,
+    crz,
+    zz,
+    zx,
+    multirz,
+    rzx,
+    _rz_mat_dict,
+    rz_matrix,
+    rzz_matrix,
+    crz_matrix,
+    multirz_matrix,
+    rzx_matrix,
+)
+from .phase_shift import phaseshift_matrix, phaseshift, p, _phaseshift_mat_dict
+from .rot import rot, crot, rot_matrix, crot_matrix, _rot_mat_dict
+from .reset import reset
+from .xx_min_yy import xxminyy, xxminyy_matrix, _xxminyy_mat_dict
+from .xx_plus_yy import xxplusyy, xxplusyy_matrix, _xxplusyy_mat_dict
+from .u1 import u1, cu1, u1_matrix, cu1_matrix, _u1_mat_dict, cp, cr, cphase
+from .u2 import u2, cu2, u2_matrix, cu2_matrix, _u2_mat_dict
+from .u3 import u, u3, cu3, cu, cu_matrix, u3_matrix, cu3_matrix, _u3_mat_dict
+from .qubit_unitary import (
+    qubitunitary,
+    qubitunitaryfast,
+    qubitunitarystrict,
+    qubitunitary_matrix,
+    qubitunitaryfast_matrix,
+    qubitunitarystrict_matrix,
+    _qubitunitary_mat_dict,
+)
+from .single_excitation import (
+    singleexcitation,
+    singleexcitation_matrix,
+    _singleexcitation_mat_dict,
+)
+from .paulix import (
+    _x_mat_dict,
+    multicnot_matrix,
+    multixcnot_matrix,
+    paulix,
+    cnot,
+    multicnot,
+    multixcnot,
+    x,
+    c3x,
+    c4x,
+    dcx,
+    toffoli,
+    ccnot,
+    ccx,
+    cx,
+    rccx,
+    rc3x,
+)
+from .pauliy import _y_mat_dict, pauliy, cy, y
+from .pauliz import _z_mat_dict, pauliz, cz, ccz, z
+from .qft import _qft_mat_dict, qft, qft_matrix
+from .r import _r_mat_dict, r, r_matrix
+from .global_phase import _globalphase_mat_dict, globalphase, globalphase_matrix
+from .sx import _sx_mat_dict, sx, c3sx, sxdg, csx
+from .i import _i_mat_dict, i
+from .s import _s_mat_dict, s, sdg, cs, csdg
+from .t import _t_mat_dict, t, tdg
+from .swap import _swap_mat_dict, swap, sswap, iswap, cswap
+from .ecr import _ecr_mat_dict, ecr, echoedcrossresonance
 
-from .func_mat_exp import *
-from .func_controlled_unitary import *
+mat_dict = {
+    **_hadamard_mat_dict,
+    **_rx_mat_dict,
+    **_ry_mat_dict,
+    **_rz_mat_dict,
+    **_phaseshift_mat_dict,
+    **_rot_mat_dict,
+    **_xxminyy_mat_dict,
+    **_xxplusyy_mat_dict,
+    **_u1_mat_dict,
+    **_u2_mat_dict,
+    **_u3_mat_dict,
+    **_qubitunitary_mat_dict,
+    **_x_mat_dict,
+    **_y_mat_dict,
+    **_z_mat_dict,
+    **_singleexcitation_mat_dict,
+    **_qft_mat_dict,
+    **_r_mat_dict,
+    **_globalphase_mat_dict,
+    **_sx_mat_dict,
+    **_i_mat_dict,
+    **_s_mat_dict,
+    **_t_mat_dict,
+    **_swap_mat_dict,
+    **_ecr_mat_dict,
+}
+
+func_name_dict = {
+    "hadamard": hadamard,
+    "h": h,
+    "sh": shadamard,
+    "paulix": paulix,
+    "pauliy": pauliy,
+    "pauliz": pauliz,
+    "i": i,
+    "s": s,
+    "t": t,
+    "sx": sx,
+    "cnot": cnot,
+    "cz": cz,
+    "cy": cy,
+    "rx": rx,
+    "ry": ry,
+    "rz": rz,
+    "rxx": rxx,
+    "xx": xx,
+    "ryy": ryy,
+    "yy": yy,
+    "rzz": rzz,
+    "zz": zz,
+    "rzx": rzx,
+    "zx": zx,
+    "swap": swap,
+    "sswap": sswap,
+    "cswap": cswap,
+    "toffoli": toffoli,
+    "phaseshift": phaseshift,
+    "p": p,
+    "cp": cp,
+    "rot": rot,
+    "multirz": multirz,
+    "crx": crx,
+    "cry": cry,
+    "crz": crz,
+    "crot": crot,
+    "u1": u1,
+    "u2": u2,
+    "u3": u3,
+    "u": u,
+    "cu1": cu1,
+    "cphase": cphase,
+    "cr": cr,
+    "cu2": cu2,
+    "cu3": cu3,
+    "cu": cu,
+    "qubitunitary": qubitunitary,
+    "qubitunitaryfast": qubitunitaryfast,
+    "qubitunitarystrict": qubitunitarystrict,
+    "multicnot": multicnot,
+    "multixcnot": multixcnot,
+    "x": x,
+    "y": y,
+    "z": z,
+    "cx": cx,
+    "ccnot": ccnot,
+    "ccx": ccx,
+    "reset": reset,
+    "singleexcitation": singleexcitation,
+    "ecr": ecr,
+    "echoedcrossresonance": echoedcrossresonance,
+    "qft": qft,
+    "sdg": sdg,
+    "tdg": tdg,
+    "sxdg": sxdg,
+    "ch": ch,
+    "ccz": ccz,
+    "iswap": iswap,
+    "cs": cs,
+    "csdg": csdg,
+    "csx": csx,
+    "chadamard": chadamard,
+    "ccz": ccz,
+    "dcx": dcx,
+    "xxminyy": xxminyy,
+    "xxplusyy": xxplusyy,
+    "c3x": c3x,
+    "r": r,
+    "globalphase": globalphase,
+    "c3sx": c3sx,
+    "rccx": rccx,
+    "rc3x": rc3x,
+    "c4x": c4x,
+}
+
+from .func_mat_exp import matrix_exp
+from .func_controlled_unitary import controlled_unitary
 
 func_name_dict_collect = {
-    'matrix_exp': matrix_exp,
-    'controlled_unitary': controlled_unitary,
+    "matrix_exp": matrix_exp,
+    "controlled_unitary": controlled_unitary,
 }

torchquantum/functional/ecr.py

@@ -0,0 +1,74 @@
+import functools
+import torch
+import numpy as np
+
+from typing import Callable, Union, Optional, List, Dict, TYPE_CHECKING
+from ..macro import C_DTYPE, F_DTYPE, ABC, ABC_ARRAY, INV_SQRT2
+from ..util.utils import pauli_eigs, diag
+from torchpack.utils.logging import logger
+from torchquantum.util import normalize_statevector
+
+from .gate_wrapper import gate_wrapper, apply_unitary_einsum, apply_unitary_bmm
+
+if TYPE_CHECKING:
+    from torchquantum.device import QuantumDevice
+else:
+    QuantumDevice = None
+
+_ecr_mat_dict = {
+    "ecr": INV_SQRT2
+    * torch.tensor(
+        [[0, 0, 1, 1j], [0, 0, 1j, 1], [1, -1j, 0, 0], [-1j, 1, 0, 0]], dtype=C_DTYPE
+    ),
+}
+
+
+def ecr(
+    q_device,
+    wires,
+    params=None,
+    n_wires=None,
+    static=False,
+    parent_graph=None,
+    inverse=False,
+    comp_method="bmm",
+):
+    """Perform the echoed cross-resonance gate.
+    https://qiskit.org/documentation/stubs/qiskit.circuit.library.ECRGate.html
+
+    Args:
+        q_device (tq.QuantumDevice): The QuantumDevice.
+        wires (Union[List[int], int]): Which qubit(s) to apply the gate.
+        params (torch.Tensor, optional): Parameters (if any) of the gate.
+            Default to None.
+        n_wires (int, optional): Number of qubits the gate is applied to.
+            Default to None.
+        static (bool, optional): Whether use static mode computation.
+            Default to False.
+        parent_graph (tq.QuantumGraph, optional): Parent QuantumGraph of
+            current operation. Default to None.
+        inverse (bool, optional): Whether inverse the gate. Default to False.
+        comp_method (bool, optional): Use 'bmm' or 'einsum' method to perform
+        matrix vector multiplication. Default to 'bmm'.
+
+    Returns:
+        None.
+
+    """
+    name = "ecr"
+    mat = _ecr_mat_dict[name]
+    gate_wrapper(
+        name=name,
+        mat=mat,
+        method=comp_method,
+        q_device=q_device,
+        wires=wires,
+        params=params,
+        n_wires=n_wires,
+        static=static,
+        parent_graph=parent_graph,
+        inverse=inverse,
+    )
+
+
+echoedcrossresonance = ecr

torchquantum/functional/func_controlled_unitary.py

@@ -24,9 +24,10 @@
 
 import numpy as np
 import torch
-from torchquantum.functional.functionals import gate_wrapper
+from torchquantum.functional.gate_wrapper import gate_wrapper
 from torchquantum.macro import *
 
+
 def controlled_unitary(
     qdev,
     c_wires,
@@ -41,7 +42,7 @@ def controlled_unitary(
         t_wires: can be a list of list of wires, multiple sets
         [[1,2], [3,4]]
         params: the parameters of the unitary
-    
+
     Returns:
         None.
 
@@ -113,19 +114,19 @@ def controlled_unitary(
     unitary[-d_controlled_u:, -d_controlled_u:] = controlled_u
 
     # return cls(
-        # has_params=True,
-        # trainable=trainable,
-        # init_params=unitary,
-        # n_wires=n_wires,
-        # wires=wires,
+    # has_params=True,
+    # trainable=trainable,
+    # init_params=unitary,
+    # n_wires=n_wires,
+    # wires=wires,
     # )
 
-    name = 'qubitunitaryfast'
+    name = "qubitunitaryfast"
     unitary = unitary.to(qdev.device)
     gate_wrapper(
         name=name,
         mat=unitary,
-        method='bmm',
+        method="bmm",
         q_device=qdev,
         wires=wires,
         n_wires=n_wires,

torchquantum/functional/func_mat_exp.py

@@ -23,13 +23,14 @@
 """
 
 import torch
-from .functionals import gate_wrapper
+from .gate_wrapper import gate_wrapper
 from typing import Union
 import numpy as np
 import torchquantum.functional as tqf
 
 __all__ = ["matrix_exp"]
 
+
 def matrix_exp(
     qdev,
     wires,
@@ -62,7 +63,7 @@ def matrix_exp(
 
     mat = torch.matrix_exp(params)
 
-    name = 'qubitunitaryfast'
+    name = "qubitunitaryfast"
 
     tqf.qubitunitaryfast(
         q_device=qdev,