Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PhaseOracle and BooleanExpression allow setting the expression variable order #6658

Merged
merged 22 commits into from
Feb 3, 2023
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions qiskit/circuit/classicalfunction/boolean_expression.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,17 @@
class BooleanExpression(ClassicalElement):
"""The Boolean Expression gate."""

def __init__(self, expression: str, name: str = None) -> None:
def __init__(self, expression: str, name: str = None, var_order: list = None) -> None:
"""
Args:
expression (str): The logical expression string.
name (str): Optional. Instruction gate name. Otherwise part of
the expression is going to be used.
var_order(list): A list with the order in which variables will be created.
(default: by appearance)
name (str): Optional. Instruction gate name. Otherwise part of the expression is
going to be used.
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved
"""

self._tweedledum_bool_expression = BoolFunction.from_expression(expression)
self._tweedledum_bool_expression = BoolFunction.from_expression(expression, var_order)
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved

short_expr_for_name = (expression[:10] + "...") if len(expression) > 13 else expression
num_qubits = (
Expand Down
5 changes: 4 additions & 1 deletion qiskit/circuit/library/phase_oracle.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,23 @@ class PhaseOracle(QuantumCircuit):
def __init__(
self,
expression: Union[str, ClassicalElement],
var_order: list = None,
synthesizer: Optional[Callable[[BooleanExpression], QuantumCircuit]] = None,
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved
) -> None:
"""Creates a PhaseOracle object

Args:
expression: A Python-like boolean expression.
var_order(list): A list with the order in which variables will be created.
(default: by appearance)
synthesizer: Optional. A function to convert a BooleanExpression into a QuantumCircuit
If None is provided, Tweedledum's `pkrm_synth` with `phase_esop` will be used.
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved
"""
from qiskit.circuit.classicalfunction.boolean_expression import BooleanExpression
from qiskit.circuit.classicalfunction.classical_element import ClassicalElement

if not isinstance(expression, ClassicalElement):
expression = BooleanExpression(expression)
expression = BooleanExpression(expression, var_order=var_order)

self.boolean_expression = expression

Expand Down
19 changes: 19 additions & 0 deletions releasenotes/notes/expression-var-order-d87e9b04fb5d545c.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
features:
- |
Add the ability for users to define the variable order when defining a
`PhaseOracle`.
1ucian0 marked this conversation as resolved.
Show resolved Hide resolved

.. code-block::python

from qiskit import *
from qiskit.tools.visualization import plot_histogram
from qiskit.circuit.library import PhaseOracle
from qiskit.algorithms import Grover, AmplificationProblem

oracle = PhaseOracle('((A & C) | (B & D)) & ~(C & D)', var_order=['A', 'B', 'C', 'D'])
problem = AmplificationProblem(oracle=oracle, is_good_state=oracle.evaluate_bitstring)
backend = Aer.get_backend('qasm_simulator')
grover = Grover(quantum_instance=backend)
result = grover.amplify(problem)
print(result.circuit_results[0])
26 changes: 26 additions & 0 deletions test/python/circuit/library/test_phase_oracle.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,32 @@ def test_statevector(self, expression, good_states):
self.assertListEqual(expected_valid, result_valid)
self.assertListEqual(expected_invalid, result_invalid)

@data(
("((A & C) | (B & D)) & ~(C & D)", None, [3, 7, 12, 13]),
("((A & C) | (B & D)) & ~(C & D)", ["A", "B", "C", "D"], [5, 7, 10, 11]),
)
@unpack
def test_variable_order(self, expression, var_order, good_states):
"""Circuit generation"""
oracle = PhaseOracle(expression, var_order=var_order)
num_qubits = oracle.num_qubits
circuit = QuantumCircuit(num_qubits)
circuit.h(range(num_qubits))
circuit.compose(oracle, inplace=True)
statevector = Statevector.from_instruction(circuit)

valid_state = -1 / sqrt(2**num_qubits)
invalid_state = 1 / sqrt(2**num_qubits)

states = list(range(2**num_qubits))
expected_valid = [state in good_states for state in states]
result_valid = [isclose(statevector.data[state], valid_state) for state in states]

expected_invalid = [state not in good_states for state in states]
result_invalid = [isclose(statevector.data[state], invalid_state) for state in states]
self.assertListEqual(expected_valid, result_valid)
self.assertListEqual(expected_invalid, result_invalid)


if __name__ == "__main__":
unittest.main()