add ControlledGate class #2862

ewinston · 2019-07-25T02:03:37Z

Fixes #544, Fixes #2804

Summary

Adds a ControlledGate class inheriting from the Gate class. Also, adds a method q_if to the Gate class which returns a ControlledGate instance.

addresses part of issue #2804

Details and comments

dime10 · 2019-09-27T16:15:31Z

I am working on an optimization pass which makes use of this new controlled gate class and I noticed the following feature is missing which would be quite useful for the optimizer (and maybe in general too):

On a ControlledGate object, access to the base gate that is being controlled, no matter how it was created (e.g. via ToffoliGate(), XGate().q_if(2), XGate().q_if().q_if(), CnotGate().q_if(), etc). This is important to identify whether gates can be cancelled even if their control qubits differ. This could be a simple attribute that references the class of the uncontrolled gate (e.g. self.base_gate = XGate)

Two other things I noticed:

When creating a CCCX gate using q_if, why is the _cccx definition given in multi_control_toffoli_gate not used? Additionally, the generated definitions for CCCX vary depending on the path to generate it: XGate().q_if(3) != XGate().q_if(2).q_if() = XGate().q_if().q_if().q_if() = ToffoliGate().q_if() != CnotGate().q_if(2).
When printing a circuit, controlled gates created via q_if() aren't drawn as controlled gates, rather as a single box.

updated standard gates to return controlled version if it is also in the standard set.

minor commit added "controlled_ops" parameter gate rules of gate before applying controls. pass controlled gate tests changing to recursive control broken point

passing mu1 and mu3 tests working...confusing num_ctrl_qubits linting fix indentation error fix circular import for python 3.5 and 3.6. more import fixes put aqua q_if back in, linting minor commit minor commit linting another attempt to fix circular import across all pltforms. disable cyclic-import pylint check another attempt to remove cyclic import This also eliminates defining q_if in standard extension gates. forgot to add module add_control.py fix style method from qi

todo: convert the gates to ControlledGates linting style simplify some tests minor fix

todo: convert the gates to ControlledGates linting style simplify some tests minor fix Co-authored-by: Shaohan Hu <shaohan.hu@ibm.com> Co-authored-by: Manoel Marques <manoel@us.ibm.com> Co-authored-by: Albert Frisch <alfr@de.ibm.com>

ewinston · 2019-10-04T15:04:59Z

Hi @dime10,
I can add (1) as you suggested. For (2), this pr currently implements the "noancilla" mode from multi_control_toffoli_gate as it behaves in aqua where it came from. Point (3) is referenced in issue #2804, which is why it was mentioned this pr only addresses the non-visualization part. I'll create a new issue for the visualization part. Thanks for the suggestions and trying it out!

This adds "base_gate" as class attribute of ControlledGate which is a class reference.

qiskit/circuit/add_control.py

Also remove some unused imports in test_controlled_gate.py.

* added release notes for controlled gate class (#2862). Also remove some unused imports in test_controlled_gate.py. * remove pylint disable * remove one more unused import * change q_if to control in expectation of pr #3455 * update release notes include imports in release notes.

* added ControlledGate class updated standard gates to return controlled version if it is also in the standard set. * added assertions to some tests. minor commit added "controlled_ops" parameter gate rules of gate before applying controls. pass controlled gate tests changing to recursive control broken point * added dmitri based decomposition from aqua passing mu1 and mu3 tests working...confusing num_ctrl_qubits linting fix indentation error fix circular import for python 3.5 and 3.6. more import fixes put aqua q_if back in, linting minor commit minor commit linting another attempt to fix circular import across all pltforms. disable cyclic-import pylint check another attempt to remove cyclic import This also eliminates defining q_if in standard extension gates. forgot to add module add_control.py fix style method from qi * copied multi controlled gates from aqua todo: convert the gates to ControlledGates linting style simplify some tests minor fix * simplify code. catch rotation gates to avoid decomposition. * copied multi controlled gates from aqua todo: convert the gates to ControlledGates linting style simplify some tests minor fix Co-authored-by: Shaohan Hu <shaohan.hu@ibm.com> Co-authored-by: Manoel Marques <manoel@us.ibm.com> Co-authored-by: Albert Frisch <alfr@de.ibm.com> * simplify code. catch rotation gates to avoid decomposition. * add reference to base controlled gate This adds "base_gate" as class attribute of ControlledGate which is a class reference. * add some tests. fix imports * remove pdb * linting * add `to_gate` method to Instruction. * lint * linting * linting * add test for instruction_to_gate * add phase argument when computing control matrix * linting

…3465) * added release notes for controlled gate class (Qiskit#2862). Also remove some unused imports in test_controlled_gate.py. * remove pylint disable * remove one more unused import * change q_if to control in expectation of pr Qiskit#3455 * update release notes include imports in release notes.

ewinston requested review from 1ucian0, ajavadia, atilag, chriseclectic, delapuente, diego-plan9, jaygambetta, kdk, lcapelluto, mtreinish, nonhermitian and taalexander as code owners July 25, 2019 02:03

ewinston force-pushed the gatecontrol branch from 26e908e to e9b068d Compare July 25, 2019 02:05

ewinston force-pushed the gatecontrol branch 3 times, most recently from b30ea21 to cfaff92 Compare August 7, 2019 19:47

ewinston changed the title ~~[WIP] add ControlledGate class~~ add ControlledGate class Aug 8, 2019

ajavadia self-assigned this Aug 20, 2019

ewinston added 5 commits October 2, 2019 14:49

added ControlledGate class

670e116

updated standard gates to return controlled version if it is also in the standard set.

added assertions to some tests.

513ed46

minor commit added "controlled_ops" parameter gate rules of gate before applying controls. pass controlled gate tests changing to recursive control broken point

copied multi controlled gates from aqua

066ce9b

todo: convert the gates to ControlledGates linting style simplify some tests minor fix

simplify code. catch rotation gates to avoid decomposition.

e0fad4b

ewinston force-pushed the gatecontrol branch from b8db55f to e0fad4b Compare October 2, 2019 20:10

ewinston and others added 2 commits October 2, 2019 16:19

copied multi controlled gates from aqua

7e1820e

todo: convert the gates to ControlledGates linting style simplify some tests minor fix Co-authored-by: Shaohan Hu <shaohan.hu@ibm.com> Co-authored-by: Manoel Marques <manoel@us.ibm.com> Co-authored-by: Albert Frisch <alfr@de.ibm.com>

simplify code. catch rotation gates to avoid decomposition.

5dbb179

dime10 mentioned this pull request Oct 2, 2019

Hoare optimization transpiler pass #3185

Merged

add reference to base controlled gate

4a8d4de

This adds "base_gate" as class attribute of ControlledGate which is a class reference.

ewinston added 4 commits October 10, 2019 12:41

add to_gate method to Instruction.

d024b7f

lint

cb1e7b1

linting

0da33b7

linting

a836262

1ucian0 reviewed Oct 14, 2019

View reviewed changes

qiskit/circuit/add_control.py Show resolved Hide resolved

1ucian0 added on hold Can not fix yet and removed on hold Can not fix yet labels Oct 22, 2019

ewinston added 7 commits November 5, 2019 10:49

Merge branch 'master' into gatecontrol

ee28889

add test for instruction_to_gate

f336f28

add phase argument when computing control matrix

62a79af

Merge remote-tracking branch 'upstream/master' into gatecontrol

8e5253d

linting

fbb0237

Merge branch 'master' into gatecontrol

a4d5054

Merge branch 'master' into gatecontrol

d9c9db6

1ucian0 mentioned this pull request Nov 8, 2019

controlled gate text drawer #3442

Merged

ajavadia approved these changes Nov 12, 2019

View reviewed changes

ajavadia added the automerge label Nov 12, 2019

Merge branch 'master' into gatecontrol

a52615b

ajavadia mentioned this pull request Nov 12, 2019

follow up to ControlledGate implementation #3453

Closed

6 tasks

mergify bot merged commit 370b27e into Qiskit:master Nov 12, 2019

mtreinish added the Changelog: New Feature Include in the "Added" section of the changelog label Nov 12, 2019

ewinston added a commit to ewinston/qiskit that referenced this pull request Nov 13, 2019

added release notes for controlled gate class (Qiskit#2862).

2283a67

Also remove some unused imports in test_controlled_gate.py.

ewinston mentioned this pull request Nov 13, 2019

added release notes for controlled gate class (#2862). #3465

Merged

1ucian0 mentioned this pull request Nov 18, 2019

Removing unused import modules from test_controlled_gate.py #3487

Merged

kdk mentioned this pull request Nov 21, 2019

Remove top-level sympy imports from multi-control gates. #3507

Merged

ewinston mentioned this pull request Jan 27, 2020

override control of standard gates where possible #3631

Merged

ewinston deleted the gatecontrol branch June 9, 2020 19:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add ControlledGate class #2862

add ControlledGate class #2862

ewinston commented Jul 25, 2019 •

edited by ajavadia

Loading

dime10 commented Sep 27, 2019

ewinston commented Oct 4, 2019

add ControlledGate class #2862

add ControlledGate class #2862

Conversation

ewinston commented Jul 25, 2019 • edited by ajavadia Loading

Summary

Details and comments

dime10 commented Sep 27, 2019

ewinston commented Oct 4, 2019

ewinston commented Jul 25, 2019 •

edited by ajavadia

Loading