Deprecate duplicate circuit gate method #10797
Conversation
|
One or more of the the following people are requested to review this:
|
There was a problem hiding this comment.
Is there a reason we shouldn't just make this a full deprecation now? It seems to me there isn't anything really to wait on before deprecating the aliases.
Also, the only one I'm questioning here is QuantumCircuit.id, tbh I don't think I've ever used the i method for an identity gate. It's a bit different too because wasn't it the proper method in the past?
|
True, the new path exists and we can just deprecate them 👍🏻 I was going for |
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
|
Added in 58ad6f2 👍🏻 |
* Pending-deprecate duplicate circuit methods * Missed some old methods * may darkness rule (aka "run black") * Deprecate and id not i * use id over i * capture Aer's usage of QuantumCircuit.i * catch warning, don't assert * try fix errors Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> * Attempt 2 of ? Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> * Attempt 3 of 3 (hopefully) * redundant "+" * Filter the deprecation warning globally * add reno --------- Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Summary
Currently, several gates can be appended to the circuit with two differently named methods. As "circuit maintenance" and cleanup we would like to keep only a single way of doing this task. This PR deprecates duplicate quantum circuit gate methods to deprecate and remove them in following releases.
Details and comments
The methods that are kept are the ones aligned with the gate naming scheme. For example, the identity gate is called
CXGateand notCnotGate, therefore the plan is to removeQuantumCircuit.cnotand only keep the exisitingQuantumCircuit.cx. Note that this PR does not add any new methods but only removes duplicates.The deprecations are:
i->id(this is the only exception: the gate is calledIGatebutidwas voted to be more intuitive, andIGatemight go away in the future)cnot->cxtoffoli->ccxmct->mcxfredkin->cswapNo reno is added as nothing is deprecated yet.