Custom Jordan Wigner, Visualize

src/tequila/circuit/visualize.py

@@ -0,0 +1,128 @@
+import importlib.util
+
+import tequila
+from typing import Optional, List
+import matplotlib.pyplot as plt
+import matplotlib.figure as figure
+import networkx
+
+
+def visualize(qubit_hamiltonian: tequila.QubitHamiltonian,
+              circuit: Optional[tequila.QCircuit] = None,
+              connectivity: Optional[List[tuple]] = None,
+              file_path: Optional[str] = None) -> figure.Figure:
+    """
+    Precondition:
+    The maximum number of qubits is 10 at the moment (Feb24, 2023)
+
+    Post condition:
+    The graph of the qubit_hamiltonian is displayed
+    or is stored in file_path
+
+    One thing to note is that if you are using command-line interface,
+    the plot might not be successfully shown
+
+    , so it's better idea to save it as an image.
+    === parameters ===
+    qubit_hamiltonian: A QubitHamiltonian representation of pauli operators
+    circuit: A QCircuit that corresponds to the
+    connectivity: networkx.Graph.edges that show the connectivity of qubits
+    A nested list should be provided for this argument.
+    file_name: str format of file name
+    to which the plotted graph will be exported. The file will be a png format
+
+    === return ===
+    None
+
+    === sample usages ===
+    >>> visualize(
+    >>> tequila.QubitHamiltonian(openfermion.QubitOperator("X0 X5 Y3", 1)))
+    *** A graph with nodes 0 and 5 having colour red
+    and node 3 having colour green ***
+    >>> visualize(
+    >>> tequila.QubitHamiltonian(openfermion.QubitOperator("X0 X5 Y3", 1)),
+    >>> circuit=gates.X(0) + gates.CNOT(0, 5) + gates.Y(3))
+    *** A graph with nodes 0 and 5 having color red and
+    node 3 having colour green with edge 0 and 5 exists ***
+    >>> visualize(
+    >>> tequila.QubitHamiltonian(openfermion.QubitOperator("X0 X5 Y3", 1)),
+    >>> connectivity=[(0, 0), (0, 5), (3, 3)])
+    *** A graph with nodes 0 and 5 having color red and
+    node 3 having colour green with edge 0 and 5 exists ***
+    >>> visualize(
+    >>> tequila.QubitHamiltonian(openfermion.QubitOperator("X0 X5 Y3", 1)),
+    >>> connectivity=[(0, 0), (0, 5), (3, 3)],
+    >>> file_name="test_system")
+    *** Exported an image of a graph with nodes 0 and 5 having color red and
+    node 3 having colour green with edge 0 and 5 exists to test_system.png ***
+    """
+    if importlib.util.find_spec("networkx") is None:
+        raise tequila.TequilaException("networkx module is not in the system")
+    if importlib.util.find_spec("matplotlib") is None:
+        raise tequila.TequilaException("matplotlib module is not in the system")
+
+    if(len(qubit_hamiltonian.qubit_operator.terms)) != 1:
+        raise tequila.TequilaException("The input qubit_operator"
+                                       " should have length 1")
+
+    qh = next(iter(qubit_hamiltonian.qubit_operator.terms))
+    graph = networkx.Graph()
+    graph, pos = _draw_basics(graph)
+    if circuit is None and connectivity is None:
+        graph, pos = _visualize_helper(qh, graph, pos)
+
+    elif connectivity is None:
+        graph, pos = _visualize_helper(qh, graph, pos, list(circuit.to_networkx().edges))
+
+    elif circuit is None:
+        graph, pos = _visualize_helper(qh, graph, pos, connectivity)
+
+    if file_path is None:
+        return plt.figure()
+    if file_path is not None:
+        plt.savefig(file_path+".png", format="PNG")
+        return plt.figure()
+
+
+def _draw_basics(graph):
+    """
+    A helper function for visualize() function.
+    This function sets up the basic graph to be used.
+    """
+    length = 10
+    for site in range(length):
+        graph.add_node(site)
+    pos = networkx.spring_layout(graph, seed=3113794652)
+    networkx.draw_networkx_nodes(
+        graph, pos,  node_color="#FFFFFF", edgecolors="#000000")
+    return graph, pos
+
+
+def _visualize_helper(qh_list: List[tequila.QubitHamiltonian],
+                      graph, pos, connection: Optional[list] = None):
+    """
+    A helper function for visualize() function.
+    This function visualize the graph based on the QubitHamiltonian and connection
+    """
+    for pair in qh_list:
+        if pair[1] == 'X':
+            networkx.draw_networkx_nodes(
+                graph, pos,
+                nodelist=[pair[0]], node_color="tab:red")
+        elif pair[1] == 'Y':
+            networkx.draw_networkx_nodes(
+                graph, pos,
+                nodelist=[pair[0]], node_color="tab:green")
+        elif pair[1] == 'Z':
+            networkx.draw_networkx_nodes(
+                graph, pos,
+                nodelist=[pair[0]], node_color="tab:blue")
+    if connection is not None:
+        for edge in connection:
+            if edge[0] != edge[1]:
+                networkx.draw_networkx_edges(
+                    graph, pos, edgelist=[edge], width=5)
+    networkx.draw_networkx_labels(
+        graph, pos,
+        labels={0: 0, 1: 1, 2: 2, 3: 3, 4: 4, 5: 5, 6: 6, 7: 7, 8: 8, 9: 9})
+    return graph, pos

src/tequila/hamiltonian/custom_jw_transform.py

@@ -0,0 +1,226 @@
+import typing
+from tequila.hamiltonian.qubit_hamiltonian import QubitHamiltonian
+import tequila.hamiltonian.paulis as paulis
+
+
+def _custom_transform(fermion: str, qubits: list) -> QubitHamiltonian:
+    """
+    This method maps fermion to qubits.
+
+    Precondition:
+    The last index of qubits should be greater than
+    the site value of fermion.
+    For instance fermion: "3", qubits: [1, 2, 3, 4] is allowed, but
+    fermion: "3", qubits: [1, 2, 3] is not allowed
+
+    Post condition:
+    QubitHamiltonian of the qubits representation is returned
+
+    === Parameter ===
+    fermion: string representation of fermion operator to be mapped
+    qubits: list of qubits on which Paulis are applied
+    e.g. cjw.custom_transform("3^", [0, 1, 3, 5])
+
+    === Return ===
+    QubitHamiltonian
+    """
+    if not _is_input_compatible(fermion, qubits):
+        raise Exception("Incorrect Input Format")
+
+    qubit_hamiltonian = QubitHamiltonian()
+    operator = fermion[0]
+    site = qubits[int(operator[0])]
+    if fermion[-1] == '^':
+        pauli_z = QubitHamiltonian()
+        for qubit in range(0, int(operator)):
+            pauli_z *= paulis.Z(qubits[qubit])
+
+        qubit_hamiltonian += 0.5 * (pauli_z + paulis.X(site))
+        qubit_hamiltonian += -0.5j * (pauli_z + paulis.Y(site))
+
+    else:
+        pauli_z = QubitHamiltonian()
+        for qubit in range(0, int(operator)):
+            pauli_z *= paulis.Z(qubits[qubit])
+
+        qubit_hamiltonian += 0.5 * (pauli_z + paulis.X(site))
+        qubit_hamiltonian += 0.5j * (pauli_z + paulis.Y(site))
+
+    return qubit_hamiltonian
+
+
+def _custom_transform_one_fermion(
+        fermion: str, qubits: list,
+        qubit_map: typing.Optional[dict] = None) -> QubitHamiltonian:
+    """
+    This method maps one fermion operator to qubit with specification of
+    the mapping allowed
+
+    Precondition:
+    The last index of qubits should be greater than
+    the site value of fermion. (Example in custom_transform method)
+    The qubit specified by qubit_map should be contained in qubits and
+    should not be duplicated in qubits.
+
+    Post condition:
+    Return QubitHamiltonian based on the custom transformation the user
+    specified with qubits and qubit_map
+
+    === Parameter ===
+    fermion: str e.g. '3' '4^'
+    qubits: list[int]
+    qubit_map: dict[str, int], default=None
+
+    === Return ===
+    QubitHamiltonian
+
+    """
+
+    qubit_hamiltonian = QubitHamiltonian()
+    revised_qubits = qubits
+    mapped_qubits = False
+    if qubit_map is None:
+        qubit_hamiltonian += _custom_transform(fermion, qubits)
+        return qubit_hamiltonian
+    for key in qubit_map:
+        if key == fermion and qubits.count(qubit_map[key]) > 1:
+            raise Exception("Duplicated qubits. Either change "
+                            "the mapped qubit or qubits list")
+        if key == fermion and qubit_map[key] not in qubits:
+            raise Exception("The mapped qubit should be contained in "
+                            "qubits list")
+        if key == fermion:
+            revised_qubits.remove(qubit_map[key])
+            revised_qubits.insert(int(key[0]), qubit_map[key])
+            qubit_hamiltonian += _custom_transform(
+                fermion, revised_qubits)
+            mapped_qubits = True
+    if not mapped_qubits:
+        qubit_hamiltonian += _custom_transform(fermion, qubits)
+    return qubit_hamiltonian
+
+
+def custom_jw_transform(
+        fermions: typing.Union[str, list], qubits: typing.Optional[list] = None,
+        qubit_map: typing.Optional[dict] = None) -> QubitHamiltonian:
+    """
+    This method maps multiple fermion operators to specified qubits
+    Precondition:
+    Same as custom_transform_one_fermion
+
+    Post condition:
+    Return QubitHamiltonian based on the custom transformation the user
+    specified with qubits and qubit_map
+
+    === Parameter ===
+    fermion: str e.g. '3' '3 4^ 6'
+    qubits: list[list[int]] e.g. [[1, 2, 4, 5], [2, 3, 4, 6], [3, 5, 2, 3]]
+    qubit_map: dict[str, int], default=None e.g. {'3': 4, '5^': 2}
+
+    === Return ===
+    QubitHamiltonian
+    """
+
+    if qubits is None:
+        if qubit_map is None:
+            largest_index = _find_largest_index(fermions)
+            new_qubit_list = [i for i in range(largest_index + 1)]
+            if _num_of_fermions(fermions) == 1:
+                return custom_jw_transform(fermions, new_qubit_list, qubit_map)
+            else:
+                qubits_list = \
+                    [new_qubit_list for _ in range(_num_of_fermions(fermions))]
+                return custom_jw_transform(fermions, qubits_list, qubit_map)
+
+    if not _is_input_compatible(fermions, qubits):
+        raise Exception("Incorrect input given (fermions or qubits)."
+                        " Follow the convention for fermions and qubits input")
+
+    if isinstance(fermions, str):
+        if len(fermions) <= 2:
+            return _custom_transform_one_fermion(fermions, qubits,  qubit_map)
+        fermion_ops = _split_fermions(fermions)
+        qubit_hamiltonian = _custom_transform_one_fermion(
+            fermion_ops[0], qubits[0], qubit_map)
+        for i in range(1, len(fermion_ops)):
+            qubit_hamiltonian *= _custom_transform_one_fermion(
+                fermion_ops[i], qubits[i], qubit_map)
+
+        return qubit_hamiltonian
+    if isinstance(fermions, list):
+        qubit_hamiltonian = _custom_transform_one_fermion(
+            fermions[0], qubits[0], qubit_map)
+        for i in range(1, len(fermions)):
+            qubit_hamiltonian *= _custom_transform_one_fermion(
+                fermions[i], qubits[i], qubit_map)
+
+        return qubit_hamiltonian
+
+
+def _num_of_fermions(fermions: typing.Union[str, list]) -> int:
+    """
+
+    """
+    if isinstance(fermions, str):
+        if len(fermions) <= 2:
+            return 1
+        return len(_split_fermions(fermions))
+    elif isinstance(fermions, list):
+        return len(fermions)
+
+
+def _find_largest_index(fermions: typing.Union[str, list]) -> int:
+    if isinstance(fermions, str):
+        if len(fermions) <= 2:
+            return int(fermions[0])
+        fermion_ops = _split_fermions(fermions)
+        max_ind = 0
+        for index in fermion_ops:
+            max_ind = max(max_ind, int(index[0]))
+        return max_ind
+    elif isinstance(fermions, list):
+        max_ind = 0
+        for index in fermions:
+            max_ind = max(max_ind, int(index[0]))
+        return max_ind
+
+
+def _split_fermions(fermions: str) -> list:
+    if ", " in fermions:
+        fermion_ops = fermions.split(", ")
+    elif " " in fermions:
+        fermion_ops = fermions.split(" ")
+    elif "," in fermions:
+        fermion_ops = fermions.split(",")
+    elif ":" in fermions:
+        fermion_ops = fermions.split(":")
+    else:
+        raise Exception("Incorrect input format")
+    return fermion_ops
+
+
+def _is_input_compatible(
+        fermion: typing.Union[str, list], qubits: list) -> bool:
+    """
+    Helper function for CustomJordanWigner class
+    Checks if the inputs, namely the fermion operators are compatible with
+    qubits in the following ways; the size, ...
+    """
+    if isinstance(fermion, str) and len(fermion) < 3:
+        if int(fermion[0]) >= len(qubits):
+            return False
+        if len(qubits) != len(set(qubits)):
+            return False
+        return True
+    elif isinstance(fermion, str) and len(fermion) >= 3:
+        for maps in qubits:
+            if not isinstance(maps, list):
+                return False
+        fermion_ops = _split_fermions(fermion)
+        if len(fermion_ops) > len(qubits):
+            return False
+        for i in range(len(fermion_ops)):
+            if not _is_input_compatible(fermion_ops, qubits[i]):
+                return False
+        return True
+    return True