pyqrack 1.29.0__py3-none-win_amd64.whl → 1.72.5__py3-none-win_amd64.whl

pyqrack/qrack_circuit.py

@@ -1,4 +1,4 @@
-# (C) Daniel Strano and the Qrack contributors 2017-2023. All rights reserved.
+# (C) Daniel Strano and the Qrack contributors 2017-2025. All rights reserved.
 #
 # Use of this source code is governed by an MIT-style license that can be
 # found in the LICENSE file or at https://opensource.org/licenses/MIT.
@@ -12,8 +12,10 @@ _IS_QISKIT_AVAILABLE = True
 try:
     from qiskit.circuit.quantumcircuit import QuantumCircuit
     from qiskit.compiler.transpiler import transpile
+    from qiskit.circuit.library import UCGate
     import numpy as np
     import math
+    import sys
 except ImportError:
     _IS_QISKIT_AVAILABLE = False
 
@@ -30,6 +32,7 @@ try:
 except ImportError:
     _IS_TENSORCIRCUIT_AVAILABLE = False
 
+
 class QrackCircuit:
     """Class that exposes the QCircuit class of Qrack
 
@@ -42,13 +45,22 @@ class QrackCircuit:
         cid(int): Qrack ID of this circuit
     """
 
-    def __init__(self, is_collapse = True, is_near_clifford = False, clone_cid = -1, is_inverse=False, past_light_cone = []):
+    def __init__(
+        self,
+        is_collapse=True,
+        is_near_clifford=False,
+        clone_cid=-1,
+        is_inverse=False,
+        past_light_cone=[],
+    ):
         if clone_cid < 0:
             self.cid = Qrack.qrack_lib.init_qcircuit(is_collapse, is_near_clifford)
         elif is_inverse:
             self.cid = Qrack.qrack_lib.qcircuit_inverse(clone_cid)
         elif len(past_light_cone) > 0:
-            self.cid = Qrack.qrack_lib.qcircuit_past_light_cone(clone_cid, len(past_light_cone), self._ulonglong_byref(past_light_cone))
+            self.cid = Qrack.qrack_lib.qcircuit_past_light_cone(
+                clone_cid, len(past_light_cone), self._ulonglong_byref(past_light_cone)
+            )
         else:
             self.cid = Qrack.qrack_lib.init_qcircuit_clone(clone_cid)
 
@@ -67,13 +79,60 @@ class QrackCircuit:
         t = [(c.real, c.imag) for c in a]
         return self._double_byref([float(item) for sublist in t for item in sublist])
 
+    def _mtrx_to_u4(m):
+        nrm = abs(m[0])
+        if (nrm * nrm) < sys.float_info.epsilon:
+            phase = 1.0 + 0.0j
+            th = math.pi
+        else:
+            phase = m[0] / nrm
+            if nrm > 1.0:
+                nrm = 1.0
+            th = 2 * math.acos(nrm)
+
+        nrm1 = abs(m[1])
+        nrm2 = abs(m[2])
+        nrm1 *= nrm1
+        nrm2 *= nrm2
+        if (nrm1 < sys.float_info.epsilon) or (nrm2 < sys.float_info.epsilon):
+            ph = np.angle(m[3] / phase)
+            lm = 0.0
+        else:
+            ph = np.angle(m[2] / phase)
+            lm = np.angle(-m[1] / phase)
+
+        return th, ph, lm, np.angle(phase)
+
+    def _u3_to_mtrx(params):
+        th = float(params[0])
+        ph = float(params[1])
+        lm = float(params[2])
+
+        c = math.cos(th / 2)
+        s = math.sin(th / 2)
+        el = np.exp(1j * lm)
+        ep = np.exp(1j * ph)
+
+        return [c + 0j, -el * s, ep * s, ep * el * c]
+
+    def _u4_to_mtrx(params):
+        m = QrackCircuit._u3_to_mtrx(params)
+        g = np.exp(1j * float(params[3]))
+        for i in range(4):
+            m[i] *= g
+
+        return m
+
+    def _make_mtrx_unitary(m):
+        return QrackCircuit._u4_to_mtrx(QrackCircuit._mtrx_to_u4(m))
+
     def clone(self):
         """Make a new circuit that is an exact clone of this circuit
 
         Raises:
             RuntimeError: QrackCircuit C++ library raised an exception.
         """
-        return QrackCircuit(clone_cid = self.cid, is_inverse = False)
+        return QrackCircuit(clone_cid=self.cid, is_inverse=False)
 
     def inverse(self):
         """Make a new circuit that is the exact inverse of this circuit
@@ -81,7 +140,7 @@ class QrackCircuit:
         Raises:
             RuntimeError: QrackCircuit C++ library raised an exception.
         """
-        return QrackCircuit(clone_cid = self.cid, is_inverse = True)
+        return QrackCircuit(clone_cid=self.cid, is_inverse=True)
 
     def past_light_cone(self, q):
         """Make a new circuit with just this circuits' past light cone for certain qubits.
@@ -92,7 +151,7 @@ class QrackCircuit:
         Raises:
             RuntimeError: QrackCircuit C++ library raised an exception.
         """
-        return QrackCircuit(clone_cid = self.cid, is_inverse = False, past_light_cone = q)
+        return QrackCircuit(clone_cid=self.cid, is_inverse=False, past_light_cone=q)
 
     def get_qubit_count(self):
         """Get count of qubits in circuit
@@ -128,7 +187,9 @@ class QrackCircuit:
             RuntimeError: QrackSimulator raised an exception.
         """
         if len(m) < 4:
-            raise ValueError("2x2 matrix 'm' in QrackCircuit.mtrx() must contain at least 4 elements.")
+            raise ValueError(
+                "2x2 matrix 'm' in QrackCircuit.mtrx() must contain at least 4 elements."
+            )
         Qrack.qrack_lib.qcircuit_append_1qb(self.cid, self._complex_byref(m), q)
 
     def ucmtrx(self, c, m, q, p):
@@ -149,7 +210,9 @@ class QrackCircuit:
             RuntimeError: QrackSimulator raised an exception.
         """
         if len(m) < 4:
-            raise ValueError("2x2 matrix 'm' in QrackCircuit.ucmtrx() must contain at least 4 elements.")
+            raise ValueError(
+                "2x2 matrix 'm' in QrackCircuit.ucmtrx() must contain at least 4 elements."
+            )
         Qrack.qrack_lib.qcircuit_append_mc(
             self.cid, self._complex_byref(m), len(c), self._ulonglong_byref(c), q, p
         )
@@ -183,7 +246,7 @@ class QrackCircuit:
         Args:
             filename: Name of file
         """
-        Qrack.qrack_lib.qcircuit_out_to_file(self.cid, filename.encode('utf-8'))
+        Qrack.qrack_lib.qcircuit_out_to_file(self.cid, filename.encode("utf-8"))
 
     def in_from_file(filename):
         """Read in optimized circuit from file
@@ -195,10 +258,50 @@ class QrackCircuit:
             filename: Name of file
         """
         out = QrackCircuit()
-        Qrack.qrack_lib.qcircuit_in_from_file(out.cid, filename.encode('utf-8'))
+        Qrack.qrack_lib.qcircuit_in_from_file(out.cid, filename.encode("utf-8"))
 
         return out
 
+    def out_to_string(self):
+        """Output optimized circuit to string
+
+        Outputs the (optimized) circuit to a string.
+        """
+        string_length = Qrack.qrack_lib.qcircuit_out_to_string_length(self.cid)
+        out = ctypes.create_string_buffer(string_length)
+        Qrack.qrack_lib.qcircuit_out_to_string(self.cid, out)
+
+        return out.value.decode("utf-8")
+
+    def file_gate_count(filename):
+        """File gate count
+
+        Return the count of gates in a QrackCircuit file
+
+        Args:
+            filename: Name of file
+        """
+        tokens = []
+        with open(filename, "r") as file:
+            tokens = file.read().split()
+        return int(tokens[1])
+
+    def to_qiskit_circuit(self):
+        """Convert to a Qiskit circuit
+
+        Outputs a Qiskit circuit from a QrackCircuit.
+
+        Raises:
+            RuntimeErorr: Before trying to string_to_qiskit_circuit() with
+                QrackCircuit, you must install Qiskit, numpy, and math!
+        """
+        if not _IS_QISKIT_AVAILABLE:
+            raise RuntimeError(
+                "Before trying to_qiskit_circuit() with QrackCircuit, you must install Qiskit, numpy, and math!"
+            )
+
+        return QrackCircuit.string_to_qiskit_circuit(self.out_to_string())
+
     def file_to_qiskit_circuit(filename):
         """Convert an output file to a Qiskit circuit
 
@@ -219,79 +322,79 @@ class QrackCircuit:
             )
 
         tokens = []
-        with open(filename, 'r') as file:
-            tokens = file.read().split()
+        with open(filename, "r") as file:
+            return QrackCircuit.string_to_qiskit_circuit(file.read())
+
+    def string_to_qiskit_circuit(circ_string):
+        """Convert an output string to a Qiskit circuit
+
+        Reads in an (optimized) circuit from a string
+        parameter and outputs a Qiskit circuit.
+
+        Args:
+            circ_string: String representation of circuit
+
+        Raises:
+            RuntimeErorr: Before trying to string_to_qiskit_circuit() with
+                QrackCircuit, you must install Qiskit, numpy, and math!
+        """
+        if not _IS_QISKIT_AVAILABLE:
+            raise RuntimeError(
+                "Before trying to string_to_qiskit_circuit() with QrackCircuit, you must install Qiskit, numpy, and math!"
+            )
+
+        tokens = circ_string.split()
 
         i = 0
         num_qubits = int(tokens[i])
-        i = i + 1
+        i += 1
         circ = QuantumCircuit(num_qubits)
 
         num_gates = int(tokens[i])
-        i = i + 1
+        i += 1
 
+        identity = np.eye(2, dtype=complex)
         for g in range(num_gates):
             target = int(tokens[i])
-            i = i + 1
+            i += 1
 
             control_count = int(tokens[i])
-            i = i + 1
+            i += 1
             controls = []
             for j in range(control_count):
                 controls.append(int(tokens[i]))
-                i = i + 1
+                i += 1
 
             payload_count = int(tokens[i])
-            i = i + 1
+            i += 1
             payloads = {}
             for j in range(payload_count):
                 key = int(tokens[i])
-                i = i + 1
-                op = np.zeros((2,2), dtype=complex)
-                row = []
-                for _ in range(2):
-                    amp = tokens[i].replace("(","").replace(")","").split(',')
-                    row.append(float(amp[0]) + float(amp[1])*1j)
-                    i = i + 1
-                l = math.sqrt(np.real(row[0] * np.conj(row[0]) + row[1] * np.conj(row[1])))
-                op[0][0] = row[0] / l
-                op[0][1] = row[1] / l
-
-                if np.abs(op[0][0] - row[0]) > 1e-5:
-                    print("Warning: gate ", str(g), ", payload ", str(j), " might not be unitary!")
-                if np.abs(op[0][1] - row[1]) > 1e-5:
-                    print("Warning: gate ", str(g), ", payload ", str(j), " might not be unitary!")
-
-                row = []
-                for _ in range(2):
-                    amp = tokens[i].replace("(","").replace(")","").split(',')
-                    row.append(float(amp[0]) + float(amp[1])*1j)
-                    i = i + 1
-                l = math.sqrt(np.real(row[0] * np.conj(row[0]) + row[1] * np.conj(row[1])))
-                op[1][0] = row[0] / l
-                op[1][1] = row[1] / l
-
-                ph = np.real(np.log(np.linalg.det(op)) / 1j)
-
-                op[1][0] = -np.exp(1j * ph) * np.conj(op[0][1])
-                op[1][1] = np.exp(1j * ph) * np.conj(op[0][0])
-
-                if np.abs(op[1][0] - row[0]) > 1e-5:
-                    print("Warning: gate ", str(g), ", payload ", str(j), " might not be unitary!")
-                if np.abs(op[1][1] - row[1]) > 1e-5:
-                    print("Warning: gate ", str(g), ", payload ", str(j), " might not be unitary!")
-
-                # Qiskit has a lower tolerance for deviation from numerically unitary.
-                payloads[key] = np.array(op)
+                i += 1
+
+                mtrx = []
+                for _ in range(4):
+                    amp = tokens[i].replace("(", "").replace(")", "").split(",")
+                    mtrx.append(float(amp[0]) + float(amp[1]) * 1j)
+                    i += 1
+
+                mtrx = QrackCircuit._make_mtrx_unitary(mtrx)
+
+                op = np.eye(2, dtype=complex)
+                op[0][0] = mtrx[0]
+                op[0][1] = mtrx[1]
+                op[1][0] = mtrx[2]
+                op[1][1] = mtrx[3]
+
+                payloads[key] = op
 
             gate_list = []
             for j in range(1 << control_count):
                 if j in payloads:
                     gate_list.append(payloads[j])
                 else:
-                    gate_list.append(np.array([[1, 0],[0, 1]]))
-
-            circ.uc(gate_list, controls, target)
+                    gate_list.append(identity)
+            circ.append(UCGate(gate_list), [target] + controls)
 
         return circ
 
@@ -313,31 +416,30 @@ class QrackCircuit:
             )
 
         out = QrackCircuit()
-
-        basis_gates = ["u", "cx"]
-        circ = transpile(circ, basis_gates=basis_gates, optimization_level=3)
+        basis_gates = ["x", "y", "z", "u", "cx", "cy", "cz", "cu"]
+        circ = transpile(circ, basis_gates=basis_gates, optimization_level=0)
         for gate in circ.data:
             o = gate.operation
-            if o.name == "u":
-                th = float(o.params[0])
-                ph = float(o.params[1])
-                lm = float(o.params[2])
 
-                c = math.cos(th / 2)
-                s = math.sin(th / 2)
+            op = []
+            if o.name in ["x", "cx"]:
+                op = [0, 1, 1, 0]
+            elif o.name in ["y", "cy"]:
+                op = [0, -1j, 1j, 0]
+            elif o.name in ["z", "cz"]:
+                op = [1, 0, 0, -1]
+            else:
+                op = QrackCircuit._u3_to_mtrx(o.params)
 
-                op = [
-                    c + 0j,
-                    -np.exp(1j * lm) * s,
-                    np.exp(1j * ph) * s,
-                    np.exp(1j * (ph + lm)) * c
-                ]
+            if o.name in ["x", "y", "z", "u"]:
                 out.mtrx(op, circ.find_bit(gate.qubits[0])[0])
             else:
-                ctrls = []
-                for c in gate.qubits[0:1]:
-                    ctrls.append(circ.find_bit(c)[0])
-                out.ucmtrx(ctrls, [0, 1, 1, 0], circ.find_bit(gate.qubits[1])[0], 1)
+                out.ucmtrx(
+                    [circ.find_bit(gate.qubits[0])[0]],
+                    op,
+                    circ.find_bit(gate.qubits[1])[0],
+                    1,
+                )
 
         return out
 
@@ -347,9 +449,9 @@ class QrackCircuit:
         psi0=None,
         gate_opts=None,
         tags=None,
-        psi0_dtype='complex128',
-        psi0_tag='PSI0',
-        bra_site_ind_id='b{}'
+        psi0_dtype="complex128",
+        psi0_tag="PSI0",
+        bra_site_ind_id="b{}",
     ):
         """Convert an output file to a Quimb circuit
 
@@ -380,25 +482,32 @@ class QrackCircuit:
         basis_gates = ["u", "cx"]
         qcirc = transpile(qcirc, basis_gates=basis_gates, optimization_level=3)
 
-        tcirc = qtn.Circuit(
-            N=qcirc.num_qubits,
-            psi0=psi0,
-            gate_opts=gate_opts,
-            tags=tags,
-            psi0_dtype=psi0_dtype,
-            psi0_tag=psi0_tag,
-            bra_site_ind_id=bra_site_ind_id
-        ) if circuit_type == QuimbCircuitType.Circuit else (
-            qtn.CircuitDense(N=qcirc.num_qubits, psi0=psi0, gate_opts=gate_opts, tags=tags) if circuit_type == QuimbCircuitType.CircuitDense else
-                qtn.CircuitMPS(
+        tcirc = (
+            qtn.Circuit(
+                N=qcirc.num_qubits,
+                psi0=psi0,
+                gate_opts=gate_opts,
+                tags=tags,
+                psi0_dtype=psi0_dtype,
+                psi0_tag=psi0_tag,
+                bra_site_ind_id=bra_site_ind_id,
+            )
+            if circuit_type == QuimbCircuitType.Circuit
+            else (
+                qtn.CircuitDense(
+                    N=qcirc.num_qubits, psi0=psi0, gate_opts=gate_opts, tags=tags
+                )
+                if circuit_type == QuimbCircuitType.CircuitDense
+                else qtn.CircuitMPS(
                     N=qcirc.num_qubits,
                     psi0=psi0,
                     gate_opts=gate_opts,
                     tags=tags,
                     psi0_dtype=psi0_dtype,
                     psi0_tag=psi0_tag,
-                    bra_site_ind_id=bra_site_ind_id
+                    bra_site_ind_id=bra_site_ind_id,
                 )
+            )
         )
         for gate in qcirc.data:
             o = gate.operation
@@ -407,17 +516,18 @@ class QrackCircuit:
                 ph = float(o.params[1])
                 lm = float(o.params[2])
 
-                tcirc.apply_gate('U3', th, ph, lm, qcirc.find_bit(gate.qubits[0])[0])
+                tcirc.apply_gate("U3", th, ph, lm, qcirc.find_bit(gate.qubits[0])[0])
             else:
-                tcirc.apply_gate('CNOT', qcirc.find_bit(gate.qubits[0])[0], qcirc.find_bit(gate.qubits[1])[0])
+                tcirc.apply_gate(
+                    "CNOT",
+                    qcirc.find_bit(gate.qubits[0])[0],
+                    qcirc.find_bit(gate.qubits[1])[0],
+                )
 
         return tcirc
 
     def file_to_tensorcircuit(
-        filename,
-        inputs=None,
-        circuit_params=None,
-        binding_params=None
+        filename, inputs=None, circuit_params=None, binding_params=None
     ):
         """Convert an output file to a TensorCircuit circuit
 
@@ -444,9 +554,11 @@ class QrackCircuit:
         basis_gates = ["u", "cx"]
         qcirc = transpile(qcirc, basis_gates=basis_gates, optimization_level=3)
 
-        return tc.Circuit.from_qiskit(qcirc, qcirc.num_qubits, inputs, circuit_params, binding_params)
+        return tc.Circuit.from_qiskit(
+            qcirc, qcirc.num_qubits, inputs, circuit_params, binding_params
+        )
 
-    def in_from_tensorcircuit(tcirc, enable_instruction = False, enable_inputs = False):
+    def in_from_tensorcircuit(tcirc, enable_instruction=False, enable_inputs=False):
         """Convert a TensorCircuit circuit to a QrackCircuit
 
         Accepts a TensorCircuit circuit and outputs an equivalent QrackCircuit

pyqrack/qrack_neuron.py

@@ -1,4 +1,4 @@
-# (C) Daniel Strano and the Qrack contributors 2017-2023. All rights reserved.
+# (C) Daniel Strano and the Qrack contributors 2017-2025. All rights reserved.
 #
 # Use of this source code is governed by an MIT-style license that can be
 # found in the LICENSE file or at https://opensource.org/licenses/MIT.
@@ -9,6 +9,7 @@ import sys
 from .qrack_system import Qrack
 from .neuron_activation_fn import NeuronActivationFn
 
+
 class QrackNeuron:
     """Class that exposes the QNeuron class of Qrack
 
@@ -45,10 +46,10 @@ class QrackNeuron:
         simulator,
         controls,
         target,
-        activation_fn = NeuronActivationFn.Sigmoid,
-        alpha = 1.0,
-        tolerance = sys.float_info.epsilon,
-        _init = True
+        activation_fn=NeuronActivationFn.Sigmoid,
+        alpha=1.0,
+        tolerance=sys.float_info.epsilon,
+        _init=True,
     ):
         self.simulator = simulator
         self.controls = controls
@@ -60,7 +61,15 @@ class QrackNeuron:
         if not _init:
             return
 
-        self.nid = Qrack.qrack_lib.init_qneuron(simulator.sid, len(controls), self._ulonglong_byref(controls), target, activation_fn, alpha, tolerance)
+        self.nid = Qrack.qrack_lib.init_qneuron(
+            simulator.sid,
+            len(controls),
+            self._ulonglong_byref(controls),
+            target,
+            activation_fn,
+            alpha,
+            tolerance,
+        )
 
         self._throw_if_error()
 
@@ -78,7 +87,14 @@ class QrackNeuron:
         Raises:
             RuntimeError: QrackNeuron C++ library raised an exception.
         """
-        result = QrackNeuron(self.simulator, self.controls, self.target, self.activation_fn, self.alpha, self.tolerance)
+        result = QrackNeuron(
+            self.simulator,
+            self.controls,
+            self.target,
+            self.activation_fn,
+            self.alpha,
+            self.tolerance,
+        )
         self.nid = Qrack.qrack_lib.clone_qneuron(self.simulator.sid)
         self._throw_if_error()
         return result
@@ -106,7 +122,9 @@ class QrackNeuron:
             RuntimeError: QrackSimulator raised an exception.
         """
         if len(a) < (1 << len(self.controls)):
-            raise ValueError("Angles 'a' in QrackNeuron.set_angles() must contain at least (2 ** len(self.controls)) elements.")
+            raise ValueError(
+                "Angles 'a' in QrackNeuron.set_angles() must contain at least (2 ** len(self.controls)) elements."
+            )
         Qrack.qrack_lib.set_qneuron_angles(self.nid, self._real1_byref(a))
         self._throw_if_error()
 
@@ -144,7 +162,7 @@ class QrackNeuron:
 
         Nonlinear activation functions can be important to neural net
         applications, like DNN. The available activation functions are
-        enumerated in `NeuronActivationFn`. 
+        enumerated in `NeuronActivationFn`.
 
         Raises:
             RuntimeError: QrackNeuron C++ library raised an exception.