qiskit 1.3.0__cp39-abi3-win32.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (836) hide show
  1. qiskit/VERSION.txt +1 -0
  2. qiskit/__init__.py +146 -0
  3. qiskit/_accelerate.pyd +0 -0
  4. qiskit/_numpy_compat.py +73 -0
  5. qiskit/assembler/__init__.py +42 -0
  6. qiskit/assembler/assemble_circuits.py +451 -0
  7. qiskit/assembler/assemble_schedules.py +367 -0
  8. qiskit/assembler/disassemble.py +310 -0
  9. qiskit/assembler/run_config.py +77 -0
  10. qiskit/circuit/__init__.py +1313 -0
  11. qiskit/circuit/_classical_resource_map.py +148 -0
  12. qiskit/circuit/_standard_gates_commutations.py +3849 -0
  13. qiskit/circuit/_utils.py +167 -0
  14. qiskit/circuit/add_control.py +274 -0
  15. qiskit/circuit/annotated_operation.py +279 -0
  16. qiskit/circuit/barrier.py +50 -0
  17. qiskit/circuit/bit.py +94 -0
  18. qiskit/circuit/classical/__init__.py +41 -0
  19. qiskit/circuit/classical/expr/__init__.py +238 -0
  20. qiskit/circuit/classical/expr/constructors.py +556 -0
  21. qiskit/circuit/classical/expr/expr.py +397 -0
  22. qiskit/circuit/classical/expr/visitors.py +300 -0
  23. qiskit/circuit/classical/types/__init__.py +109 -0
  24. qiskit/circuit/classical/types/ordering.py +222 -0
  25. qiskit/circuit/classical/types/types.py +117 -0
  26. qiskit/circuit/classicalfunction/__init__.py +140 -0
  27. qiskit/circuit/classicalfunction/boolean_expression.py +129 -0
  28. qiskit/circuit/classicalfunction/classical_element.py +54 -0
  29. qiskit/circuit/classicalfunction/classical_function_visitor.py +155 -0
  30. qiskit/circuit/classicalfunction/classicalfunction.py +173 -0
  31. qiskit/circuit/classicalfunction/exceptions.py +35 -0
  32. qiskit/circuit/classicalfunction/types.py +18 -0
  33. qiskit/circuit/classicalfunction/utils.py +91 -0
  34. qiskit/circuit/classicalregister.py +57 -0
  35. qiskit/circuit/commutation_checker.py +106 -0
  36. qiskit/circuit/commutation_library.py +20 -0
  37. qiskit/circuit/controlflow/__init__.py +28 -0
  38. qiskit/circuit/controlflow/_builder_utils.py +207 -0
  39. qiskit/circuit/controlflow/break_loop.py +56 -0
  40. qiskit/circuit/controlflow/builder.py +691 -0
  41. qiskit/circuit/controlflow/continue_loop.py +58 -0
  42. qiskit/circuit/controlflow/control_flow.py +84 -0
  43. qiskit/circuit/controlflow/for_loop.py +217 -0
  44. qiskit/circuit/controlflow/if_else.py +511 -0
  45. qiskit/circuit/controlflow/switch_case.py +417 -0
  46. qiskit/circuit/controlflow/while_loop.py +171 -0
  47. qiskit/circuit/controlledgate.py +274 -0
  48. qiskit/circuit/delay.py +123 -0
  49. qiskit/circuit/duration.py +95 -0
  50. qiskit/circuit/equivalence.py +94 -0
  51. qiskit/circuit/equivalence_library.py +18 -0
  52. qiskit/circuit/exceptions.py +19 -0
  53. qiskit/circuit/gate.py +263 -0
  54. qiskit/circuit/instruction.py +697 -0
  55. qiskit/circuit/instructionset.py +179 -0
  56. qiskit/circuit/library/__init__.py +668 -0
  57. qiskit/circuit/library/arithmetic/__init__.py +34 -0
  58. qiskit/circuit/library/arithmetic/adders/__init__.py +18 -0
  59. qiskit/circuit/library/arithmetic/adders/adder.py +210 -0
  60. qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py +123 -0
  61. qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py +129 -0
  62. qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py +95 -0
  63. qiskit/circuit/library/arithmetic/exact_reciprocal.py +88 -0
  64. qiskit/circuit/library/arithmetic/functional_pauli_rotations.py +114 -0
  65. qiskit/circuit/library/arithmetic/integer_comparator.py +243 -0
  66. qiskit/circuit/library/arithmetic/linear_amplitude_function.py +196 -0
  67. qiskit/circuit/library/arithmetic/linear_pauli_rotations.py +189 -0
  68. qiskit/circuit/library/arithmetic/multipliers/__init__.py +17 -0
  69. qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py +145 -0
  70. qiskit/circuit/library/arithmetic/multipliers/multiplier.py +192 -0
  71. qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py +108 -0
  72. qiskit/circuit/library/arithmetic/piecewise_chebyshev.py +353 -0
  73. qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py +277 -0
  74. qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py +317 -0
  75. qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py +335 -0
  76. qiskit/circuit/library/arithmetic/quadratic_form.py +198 -0
  77. qiskit/circuit/library/arithmetic/weighted_adder.py +337 -0
  78. qiskit/circuit/library/basis_change/__init__.py +15 -0
  79. qiskit/circuit/library/basis_change/qft.py +313 -0
  80. qiskit/circuit/library/blueprintcircuit.py +280 -0
  81. qiskit/circuit/library/boolean_logic/__init__.py +18 -0
  82. qiskit/circuit/library/boolean_logic/inner_product.py +155 -0
  83. qiskit/circuit/library/boolean_logic/quantum_and.py +200 -0
  84. qiskit/circuit/library/boolean_logic/quantum_or.py +202 -0
  85. qiskit/circuit/library/boolean_logic/quantum_xor.py +165 -0
  86. qiskit/circuit/library/data_preparation/__init__.py +57 -0
  87. qiskit/circuit/library/data_preparation/_z_feature_map.py +115 -0
  88. qiskit/circuit/library/data_preparation/_zz_feature_map.py +150 -0
  89. qiskit/circuit/library/data_preparation/initializer.py +107 -0
  90. qiskit/circuit/library/data_preparation/pauli_feature_map.py +656 -0
  91. qiskit/circuit/library/data_preparation/state_preparation.py +336 -0
  92. qiskit/circuit/library/fourier_checking.py +158 -0
  93. qiskit/circuit/library/generalized_gates/__init__.py +30 -0
  94. qiskit/circuit/library/generalized_gates/diagonal.py +159 -0
  95. qiskit/circuit/library/generalized_gates/gms.py +174 -0
  96. qiskit/circuit/library/generalized_gates/gr.py +215 -0
  97. qiskit/circuit/library/generalized_gates/isometry.py +370 -0
  98. qiskit/circuit/library/generalized_gates/linear_function.py +318 -0
  99. qiskit/circuit/library/generalized_gates/mcg_up_to_diagonal.py +143 -0
  100. qiskit/circuit/library/generalized_gates/mcmt.py +316 -0
  101. qiskit/circuit/library/generalized_gates/pauli.py +85 -0
  102. qiskit/circuit/library/generalized_gates/permutation.py +194 -0
  103. qiskit/circuit/library/generalized_gates/rv.py +96 -0
  104. qiskit/circuit/library/generalized_gates/uc.py +213 -0
  105. qiskit/circuit/library/generalized_gates/uc_pauli_rot.py +164 -0
  106. qiskit/circuit/library/generalized_gates/ucrx.py +32 -0
  107. qiskit/circuit/library/generalized_gates/ucry.py +32 -0
  108. qiskit/circuit/library/generalized_gates/ucrz.py +32 -0
  109. qiskit/circuit/library/generalized_gates/unitary.py +215 -0
  110. qiskit/circuit/library/graph_state.py +169 -0
  111. qiskit/circuit/library/grover_operator.py +579 -0
  112. qiskit/circuit/library/hamiltonian_gate.py +142 -0
  113. qiskit/circuit/library/hidden_linear_function.py +161 -0
  114. qiskit/circuit/library/iqp.py +175 -0
  115. qiskit/circuit/library/n_local/__init__.py +45 -0
  116. qiskit/circuit/library/n_local/efficient_su2.py +277 -0
  117. qiskit/circuit/library/n_local/evolved_operator_ansatz.py +515 -0
  118. qiskit/circuit/library/n_local/excitation_preserving.py +297 -0
  119. qiskit/circuit/library/n_local/n_local.py +1472 -0
  120. qiskit/circuit/library/n_local/pauli_two_design.py +243 -0
  121. qiskit/circuit/library/n_local/qaoa_ansatz.py +366 -0
  122. qiskit/circuit/library/n_local/real_amplitudes.py +306 -0
  123. qiskit/circuit/library/n_local/two_local.py +289 -0
  124. qiskit/circuit/library/overlap.py +182 -0
  125. qiskit/circuit/library/pauli_evolution.py +186 -0
  126. qiskit/circuit/library/phase_estimation.py +175 -0
  127. qiskit/circuit/library/phase_oracle.py +153 -0
  128. qiskit/circuit/library/quantum_volume.py +167 -0
  129. qiskit/circuit/library/standard_gates/__init__.py +142 -0
  130. qiskit/circuit/library/standard_gates/dcx.py +78 -0
  131. qiskit/circuit/library/standard_gates/ecr.py +130 -0
  132. qiskit/circuit/library/standard_gates/equivalence_library.py +1800 -0
  133. qiskit/circuit/library/standard_gates/global_phase.py +85 -0
  134. qiskit/circuit/library/standard_gates/h.py +258 -0
  135. qiskit/circuit/library/standard_gates/i.py +76 -0
  136. qiskit/circuit/library/standard_gates/iswap.py +134 -0
  137. qiskit/circuit/library/standard_gates/multi_control_rotation_gates.py +405 -0
  138. qiskit/circuit/library/standard_gates/p.py +441 -0
  139. qiskit/circuit/library/standard_gates/r.py +117 -0
  140. qiskit/circuit/library/standard_gates/rx.py +303 -0
  141. qiskit/circuit/library/standard_gates/rxx.py +183 -0
  142. qiskit/circuit/library/standard_gates/ry.py +298 -0
  143. qiskit/circuit/library/standard_gates/ryy.py +183 -0
  144. qiskit/circuit/library/standard_gates/rz.py +319 -0
  145. qiskit/circuit/library/standard_gates/rzx.py +229 -0
  146. qiskit/circuit/library/standard_gates/rzz.py +196 -0
  147. qiskit/circuit/library/standard_gates/s.py +428 -0
  148. qiskit/circuit/library/standard_gates/swap.py +288 -0
  149. qiskit/circuit/library/standard_gates/sx.py +315 -0
  150. qiskit/circuit/library/standard_gates/t.py +179 -0
  151. qiskit/circuit/library/standard_gates/u.py +403 -0
  152. qiskit/circuit/library/standard_gates/u1.py +501 -0
  153. qiskit/circuit/library/standard_gates/u2.py +149 -0
  154. qiskit/circuit/library/standard_gates/u3.py +436 -0
  155. qiskit/circuit/library/standard_gates/x.py +1529 -0
  156. qiskit/circuit/library/standard_gates/xx_minus_yy.py +235 -0
  157. qiskit/circuit/library/standard_gates/xx_plus_yy.py +239 -0
  158. qiskit/circuit/library/standard_gates/y.py +262 -0
  159. qiskit/circuit/library/standard_gates/z.py +348 -0
  160. qiskit/circuit/library/templates/__init__.py +92 -0
  161. qiskit/circuit/library/templates/clifford/__init__.py +33 -0
  162. qiskit/circuit/library/templates/clifford/clifford_2_1.py +34 -0
  163. qiskit/circuit/library/templates/clifford/clifford_2_2.py +35 -0
  164. qiskit/circuit/library/templates/clifford/clifford_2_3.py +34 -0
  165. qiskit/circuit/library/templates/clifford/clifford_2_4.py +34 -0
  166. qiskit/circuit/library/templates/clifford/clifford_3_1.py +35 -0
  167. qiskit/circuit/library/templates/clifford/clifford_4_1.py +38 -0
  168. qiskit/circuit/library/templates/clifford/clifford_4_2.py +37 -0
  169. qiskit/circuit/library/templates/clifford/clifford_4_3.py +38 -0
  170. qiskit/circuit/library/templates/clifford/clifford_4_4.py +37 -0
  171. qiskit/circuit/library/templates/clifford/clifford_5_1.py +40 -0
  172. qiskit/circuit/library/templates/clifford/clifford_6_1.py +40 -0
  173. qiskit/circuit/library/templates/clifford/clifford_6_2.py +40 -0
  174. qiskit/circuit/library/templates/clifford/clifford_6_3.py +40 -0
  175. qiskit/circuit/library/templates/clifford/clifford_6_4.py +38 -0
  176. qiskit/circuit/library/templates/clifford/clifford_6_5.py +40 -0
  177. qiskit/circuit/library/templates/clifford/clifford_8_1.py +42 -0
  178. qiskit/circuit/library/templates/clifford/clifford_8_2.py +42 -0
  179. qiskit/circuit/library/templates/clifford/clifford_8_3.py +41 -0
  180. qiskit/circuit/library/templates/nct/__init__.py +67 -0
  181. qiskit/circuit/library/templates/nct/template_nct_2a_1.py +34 -0
  182. qiskit/circuit/library/templates/nct/template_nct_2a_2.py +35 -0
  183. qiskit/circuit/library/templates/nct/template_nct_2a_3.py +37 -0
  184. qiskit/circuit/library/templates/nct/template_nct_4a_1.py +43 -0
  185. qiskit/circuit/library/templates/nct/template_nct_4a_2.py +41 -0
  186. qiskit/circuit/library/templates/nct/template_nct_4a_3.py +39 -0
  187. qiskit/circuit/library/templates/nct/template_nct_4b_1.py +41 -0
  188. qiskit/circuit/library/templates/nct/template_nct_4b_2.py +39 -0
  189. qiskit/circuit/library/templates/nct/template_nct_5a_1.py +40 -0
  190. qiskit/circuit/library/templates/nct/template_nct_5a_2.py +40 -0
  191. qiskit/circuit/library/templates/nct/template_nct_5a_3.py +40 -0
  192. qiskit/circuit/library/templates/nct/template_nct_5a_4.py +39 -0
  193. qiskit/circuit/library/templates/nct/template_nct_6a_1.py +40 -0
  194. qiskit/circuit/library/templates/nct/template_nct_6a_2.py +41 -0
  195. qiskit/circuit/library/templates/nct/template_nct_6a_3.py +41 -0
  196. qiskit/circuit/library/templates/nct/template_nct_6a_4.py +41 -0
  197. qiskit/circuit/library/templates/nct/template_nct_6b_1.py +41 -0
  198. qiskit/circuit/library/templates/nct/template_nct_6b_2.py +41 -0
  199. qiskit/circuit/library/templates/nct/template_nct_6c_1.py +41 -0
  200. qiskit/circuit/library/templates/nct/template_nct_7a_1.py +43 -0
  201. qiskit/circuit/library/templates/nct/template_nct_7b_1.py +43 -0
  202. qiskit/circuit/library/templates/nct/template_nct_7c_1.py +43 -0
  203. qiskit/circuit/library/templates/nct/template_nct_7d_1.py +43 -0
  204. qiskit/circuit/library/templates/nct/template_nct_7e_1.py +43 -0
  205. qiskit/circuit/library/templates/nct/template_nct_9a_1.py +45 -0
  206. qiskit/circuit/library/templates/nct/template_nct_9c_1.py +43 -0
  207. qiskit/circuit/library/templates/nct/template_nct_9c_10.py +44 -0
  208. qiskit/circuit/library/templates/nct/template_nct_9c_11.py +44 -0
  209. qiskit/circuit/library/templates/nct/template_nct_9c_12.py +44 -0
  210. qiskit/circuit/library/templates/nct/template_nct_9c_2.py +44 -0
  211. qiskit/circuit/library/templates/nct/template_nct_9c_3.py +44 -0
  212. qiskit/circuit/library/templates/nct/template_nct_9c_4.py +44 -0
  213. qiskit/circuit/library/templates/nct/template_nct_9c_5.py +44 -0
  214. qiskit/circuit/library/templates/nct/template_nct_9c_6.py +44 -0
  215. qiskit/circuit/library/templates/nct/template_nct_9c_7.py +44 -0
  216. qiskit/circuit/library/templates/nct/template_nct_9c_8.py +44 -0
  217. qiskit/circuit/library/templates/nct/template_nct_9c_9.py +44 -0
  218. qiskit/circuit/library/templates/nct/template_nct_9d_1.py +43 -0
  219. qiskit/circuit/library/templates/nct/template_nct_9d_10.py +44 -0
  220. qiskit/circuit/library/templates/nct/template_nct_9d_2.py +44 -0
  221. qiskit/circuit/library/templates/nct/template_nct_9d_3.py +44 -0
  222. qiskit/circuit/library/templates/nct/template_nct_9d_4.py +44 -0
  223. qiskit/circuit/library/templates/nct/template_nct_9d_5.py +44 -0
  224. qiskit/circuit/library/templates/nct/template_nct_9d_6.py +44 -0
  225. qiskit/circuit/library/templates/nct/template_nct_9d_7.py +44 -0
  226. qiskit/circuit/library/templates/nct/template_nct_9d_8.py +44 -0
  227. qiskit/circuit/library/templates/nct/template_nct_9d_9.py +44 -0
  228. qiskit/circuit/library/templates/rzx/__init__.py +25 -0
  229. qiskit/circuit/library/templates/rzx/rzx_cy.py +47 -0
  230. qiskit/circuit/library/templates/rzx/rzx_xz.py +54 -0
  231. qiskit/circuit/library/templates/rzx/rzx_yz.py +45 -0
  232. qiskit/circuit/library/templates/rzx/rzx_zz1.py +69 -0
  233. qiskit/circuit/library/templates/rzx/rzx_zz2.py +59 -0
  234. qiskit/circuit/library/templates/rzx/rzx_zz3.py +59 -0
  235. qiskit/circuit/measure.py +44 -0
  236. qiskit/circuit/operation.py +67 -0
  237. qiskit/circuit/parameter.py +178 -0
  238. qiskit/circuit/parameterexpression.py +692 -0
  239. qiskit/circuit/parametertable.py +119 -0
  240. qiskit/circuit/parametervector.py +120 -0
  241. qiskit/circuit/quantumcircuit.py +6829 -0
  242. qiskit/circuit/quantumcircuitdata.py +136 -0
  243. qiskit/circuit/quantumregister.py +75 -0
  244. qiskit/circuit/random/__init__.py +15 -0
  245. qiskit/circuit/random/utils.py +358 -0
  246. qiskit/circuit/register.py +233 -0
  247. qiskit/circuit/reset.py +34 -0
  248. qiskit/circuit/singleton.py +606 -0
  249. qiskit/circuit/store.py +97 -0
  250. qiskit/circuit/tools/__init__.py +16 -0
  251. qiskit/circuit/tools/pi_check.py +190 -0
  252. qiskit/circuit/twirling.py +145 -0
  253. qiskit/compiler/__init__.py +33 -0
  254. qiskit/compiler/assembler.py +681 -0
  255. qiskit/compiler/scheduler.py +109 -0
  256. qiskit/compiler/sequencer.py +71 -0
  257. qiskit/compiler/transpiler.py +533 -0
  258. qiskit/converters/__init__.py +74 -0
  259. qiskit/converters/circuit_to_dag.py +78 -0
  260. qiskit/converters/circuit_to_dagdependency.py +51 -0
  261. qiskit/converters/circuit_to_dagdependency_v2.py +47 -0
  262. qiskit/converters/circuit_to_gate.py +107 -0
  263. qiskit/converters/circuit_to_instruction.py +155 -0
  264. qiskit/converters/dag_to_circuit.py +79 -0
  265. qiskit/converters/dag_to_dagdependency.py +55 -0
  266. qiskit/converters/dag_to_dagdependency_v2.py +44 -0
  267. qiskit/converters/dagdependency_to_circuit.py +46 -0
  268. qiskit/converters/dagdependency_to_dag.py +54 -0
  269. qiskit/dagcircuit/__init__.py +44 -0
  270. qiskit/dagcircuit/collect_blocks.py +391 -0
  271. qiskit/dagcircuit/dagcircuit.py +24 -0
  272. qiskit/dagcircuit/dagdependency.py +646 -0
  273. qiskit/dagcircuit/dagdependency_v2.py +641 -0
  274. qiskit/dagcircuit/dagdepnode.py +160 -0
  275. qiskit/dagcircuit/dagnode.py +176 -0
  276. qiskit/dagcircuit/exceptions.py +42 -0
  277. qiskit/exceptions.py +153 -0
  278. qiskit/passmanager/__init__.py +240 -0
  279. qiskit/passmanager/base_tasks.py +230 -0
  280. qiskit/passmanager/compilation_status.py +74 -0
  281. qiskit/passmanager/exceptions.py +19 -0
  282. qiskit/passmanager/flow_controllers.py +116 -0
  283. qiskit/passmanager/passmanager.py +333 -0
  284. qiskit/primitives/__init__.py +481 -0
  285. qiskit/primitives/backend_estimator.py +486 -0
  286. qiskit/primitives/backend_estimator_v2.py +434 -0
  287. qiskit/primitives/backend_sampler.py +222 -0
  288. qiskit/primitives/backend_sampler_v2.py +339 -0
  289. qiskit/primitives/base/__init__.py +20 -0
  290. qiskit/primitives/base/base_estimator.py +252 -0
  291. qiskit/primitives/base/base_primitive.py +45 -0
  292. qiskit/primitives/base/base_primitive_job.py +78 -0
  293. qiskit/primitives/base/base_result.py +65 -0
  294. qiskit/primitives/base/base_sampler.py +204 -0
  295. qiskit/primitives/base/estimator_result.py +46 -0
  296. qiskit/primitives/base/sampler_result.py +45 -0
  297. qiskit/primitives/base/validation.py +231 -0
  298. qiskit/primitives/containers/__init__.py +26 -0
  299. qiskit/primitives/containers/bindings_array.py +389 -0
  300. qiskit/primitives/containers/bit_array.py +741 -0
  301. qiskit/primitives/containers/data_bin.py +173 -0
  302. qiskit/primitives/containers/estimator_pub.py +222 -0
  303. qiskit/primitives/containers/object_array.py +94 -0
  304. qiskit/primitives/containers/observables_array.py +279 -0
  305. qiskit/primitives/containers/primitive_result.py +53 -0
  306. qiskit/primitives/containers/pub_result.py +51 -0
  307. qiskit/primitives/containers/sampler_pub.py +193 -0
  308. qiskit/primitives/containers/sampler_pub_result.py +74 -0
  309. qiskit/primitives/containers/shape.py +129 -0
  310. qiskit/primitives/estimator.py +172 -0
  311. qiskit/primitives/primitive_job.py +81 -0
  312. qiskit/primitives/sampler.py +162 -0
  313. qiskit/primitives/statevector_estimator.py +174 -0
  314. qiskit/primitives/statevector_sampler.py +292 -0
  315. qiskit/primitives/utils.py +247 -0
  316. qiskit/providers/__init__.py +803 -0
  317. qiskit/providers/backend.py +667 -0
  318. qiskit/providers/backend_compat.py +472 -0
  319. qiskit/providers/basic_provider/__init__.py +45 -0
  320. qiskit/providers/basic_provider/basic_provider.py +101 -0
  321. qiskit/providers/basic_provider/basic_provider_job.py +65 -0
  322. qiskit/providers/basic_provider/basic_provider_tools.py +218 -0
  323. qiskit/providers/basic_provider/basic_simulator.py +821 -0
  324. qiskit/providers/basic_provider/exceptions.py +30 -0
  325. qiskit/providers/exceptions.py +45 -0
  326. qiskit/providers/fake_provider/__init__.py +105 -0
  327. qiskit/providers/fake_provider/backends_v1/__init__.py +22 -0
  328. qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/__init__.py +18 -0
  329. qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/conf_washington.json +1 -0
  330. qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/defs_washington.json +1 -0
  331. qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/fake_127q_pulse_v1.py +37 -0
  332. qiskit/providers/fake_provider/backends_v1/fake_127q_pulse/props_washington.json +1 -0
  333. qiskit/providers/fake_provider/backends_v1/fake_20q/__init__.py +18 -0
  334. qiskit/providers/fake_provider/backends_v1/fake_20q/conf_singapore.json +1 -0
  335. qiskit/providers/fake_provider/backends_v1/fake_20q/fake_20q.py +43 -0
  336. qiskit/providers/fake_provider/backends_v1/fake_20q/props_singapore.json +1 -0
  337. qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/__init__.py +18 -0
  338. qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/conf_hanoi.json +1 -0
  339. qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/defs_hanoi.json +1 -0
  340. qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/fake_27q_pulse_v1.py +50 -0
  341. qiskit/providers/fake_provider/backends_v1/fake_27q_pulse/props_hanoi.json +1 -0
  342. qiskit/providers/fake_provider/backends_v1/fake_5q/__init__.py +18 -0
  343. qiskit/providers/fake_provider/backends_v1/fake_5q/conf_yorktown.json +1 -0
  344. qiskit/providers/fake_provider/backends_v1/fake_5q/fake_5q_v1.py +41 -0
  345. qiskit/providers/fake_provider/backends_v1/fake_5q/props_yorktown.json +1 -0
  346. qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/__init__.py +18 -0
  347. qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/conf_nairobi.json +1 -0
  348. qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/defs_nairobi.json +1 -0
  349. qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/fake_7q_pulse_v1.py +44 -0
  350. qiskit/providers/fake_provider/backends_v1/fake_7q_pulse/props_nairobi.json +1 -0
  351. qiskit/providers/fake_provider/fake_1q.py +91 -0
  352. qiskit/providers/fake_provider/fake_backend.py +165 -0
  353. qiskit/providers/fake_provider/fake_openpulse_2q.py +391 -0
  354. qiskit/providers/fake_provider/fake_openpulse_3q.py +340 -0
  355. qiskit/providers/fake_provider/fake_pulse_backend.py +49 -0
  356. qiskit/providers/fake_provider/fake_qasm_backend.py +77 -0
  357. qiskit/providers/fake_provider/generic_backend_v2.py +1035 -0
  358. qiskit/providers/fake_provider/utils/__init__.py +15 -0
  359. qiskit/providers/fake_provider/utils/backend_converter.py +150 -0
  360. qiskit/providers/fake_provider/utils/json_decoder.py +109 -0
  361. qiskit/providers/job.py +147 -0
  362. qiskit/providers/jobstatus.py +30 -0
  363. qiskit/providers/models/__init__.py +89 -0
  364. qiskit/providers/models/backendconfiguration.py +1040 -0
  365. qiskit/providers/models/backendproperties.py +517 -0
  366. qiskit/providers/models/backendstatus.py +94 -0
  367. qiskit/providers/models/jobstatus.py +66 -0
  368. qiskit/providers/models/pulsedefaults.py +305 -0
  369. qiskit/providers/options.py +273 -0
  370. qiskit/providers/provider.py +95 -0
  371. qiskit/providers/providerutils.py +110 -0
  372. qiskit/pulse/__init__.py +158 -0
  373. qiskit/pulse/builder.py +2254 -0
  374. qiskit/pulse/calibration_entries.py +381 -0
  375. qiskit/pulse/channels.py +227 -0
  376. qiskit/pulse/configuration.py +245 -0
  377. qiskit/pulse/exceptions.py +45 -0
  378. qiskit/pulse/filters.py +309 -0
  379. qiskit/pulse/instruction_schedule_map.py +424 -0
  380. qiskit/pulse/instructions/__init__.py +67 -0
  381. qiskit/pulse/instructions/acquire.py +150 -0
  382. qiskit/pulse/instructions/delay.py +71 -0
  383. qiskit/pulse/instructions/directives.py +154 -0
  384. qiskit/pulse/instructions/frequency.py +135 -0
  385. qiskit/pulse/instructions/instruction.py +270 -0
  386. qiskit/pulse/instructions/phase.py +152 -0
  387. qiskit/pulse/instructions/play.py +99 -0
  388. qiskit/pulse/instructions/reference.py +100 -0
  389. qiskit/pulse/instructions/snapshot.py +82 -0
  390. qiskit/pulse/library/__init__.py +97 -0
  391. qiskit/pulse/library/continuous.py +430 -0
  392. qiskit/pulse/library/pulse.py +148 -0
  393. qiskit/pulse/library/samplers/__init__.py +15 -0
  394. qiskit/pulse/library/samplers/decorators.py +295 -0
  395. qiskit/pulse/library/samplers/strategies.py +71 -0
  396. qiskit/pulse/library/symbolic_pulses.py +1988 -0
  397. qiskit/pulse/library/waveform.py +136 -0
  398. qiskit/pulse/macros.py +262 -0
  399. qiskit/pulse/parameter_manager.py +445 -0
  400. qiskit/pulse/parser.py +314 -0
  401. qiskit/pulse/reference_manager.py +58 -0
  402. qiskit/pulse/schedule.py +1854 -0
  403. qiskit/pulse/transforms/__init__.py +106 -0
  404. qiskit/pulse/transforms/alignments.py +406 -0
  405. qiskit/pulse/transforms/base_transforms.py +71 -0
  406. qiskit/pulse/transforms/canonicalization.py +498 -0
  407. qiskit/pulse/transforms/dag.py +122 -0
  408. qiskit/pulse/utils.py +149 -0
  409. qiskit/qasm/libs/dummy/stdgates.inc +75 -0
  410. qiskit/qasm/libs/qelib1.inc +266 -0
  411. qiskit/qasm/libs/stdgates.inc +82 -0
  412. qiskit/qasm2/__init__.py +654 -0
  413. qiskit/qasm2/exceptions.py +27 -0
  414. qiskit/qasm2/export.py +372 -0
  415. qiskit/qasm2/parse.py +452 -0
  416. qiskit/qasm3/__init__.py +367 -0
  417. qiskit/qasm3/ast.py +738 -0
  418. qiskit/qasm3/exceptions.py +27 -0
  419. qiskit/qasm3/experimental.py +70 -0
  420. qiskit/qasm3/exporter.py +1299 -0
  421. qiskit/qasm3/printer.py +577 -0
  422. qiskit/qobj/__init__.py +75 -0
  423. qiskit/qobj/common.py +81 -0
  424. qiskit/qobj/converters/__init__.py +18 -0
  425. qiskit/qobj/converters/lo_config.py +177 -0
  426. qiskit/qobj/converters/pulse_instruction.py +897 -0
  427. qiskit/qobj/pulse_qobj.py +709 -0
  428. qiskit/qobj/qasm_qobj.py +708 -0
  429. qiskit/qobj/utils.py +46 -0
  430. qiskit/qpy/__init__.py +1822 -0
  431. qiskit/qpy/binary_io/__init__.py +36 -0
  432. qiskit/qpy/binary_io/circuits.py +1475 -0
  433. qiskit/qpy/binary_io/schedules.py +635 -0
  434. qiskit/qpy/binary_io/value.py +1025 -0
  435. qiskit/qpy/common.py +350 -0
  436. qiskit/qpy/exceptions.py +53 -0
  437. qiskit/qpy/formats.py +401 -0
  438. qiskit/qpy/interface.py +377 -0
  439. qiskit/qpy/type_keys.py +572 -0
  440. qiskit/quantum_info/__init__.py +162 -0
  441. qiskit/quantum_info/analysis/__init__.py +17 -0
  442. qiskit/quantum_info/analysis/average.py +47 -0
  443. qiskit/quantum_info/analysis/distance.py +102 -0
  444. qiskit/quantum_info/analysis/make_observable.py +44 -0
  445. qiskit/quantum_info/analysis/z2_symmetries.py +484 -0
  446. qiskit/quantum_info/operators/__init__.py +28 -0
  447. qiskit/quantum_info/operators/base_operator.py +145 -0
  448. qiskit/quantum_info/operators/channel/__init__.py +29 -0
  449. qiskit/quantum_info/operators/channel/chi.py +191 -0
  450. qiskit/quantum_info/operators/channel/choi.py +218 -0
  451. qiskit/quantum_info/operators/channel/kraus.py +337 -0
  452. qiskit/quantum_info/operators/channel/ptm.py +204 -0
  453. qiskit/quantum_info/operators/channel/quantum_channel.py +348 -0
  454. qiskit/quantum_info/operators/channel/stinespring.py +296 -0
  455. qiskit/quantum_info/operators/channel/superop.py +377 -0
  456. qiskit/quantum_info/operators/channel/transformations.py +475 -0
  457. qiskit/quantum_info/operators/custom_iterator.py +48 -0
  458. qiskit/quantum_info/operators/dihedral/__init__.py +18 -0
  459. qiskit/quantum_info/operators/dihedral/dihedral.py +509 -0
  460. qiskit/quantum_info/operators/dihedral/dihedral_circuits.py +216 -0
  461. qiskit/quantum_info/operators/dihedral/polynomial.py +313 -0
  462. qiskit/quantum_info/operators/dihedral/random.py +64 -0
  463. qiskit/quantum_info/operators/linear_op.py +25 -0
  464. qiskit/quantum_info/operators/measures.py +418 -0
  465. qiskit/quantum_info/operators/mixins/__init__.py +52 -0
  466. qiskit/quantum_info/operators/mixins/adjoint.py +52 -0
  467. qiskit/quantum_info/operators/mixins/group.py +171 -0
  468. qiskit/quantum_info/operators/mixins/linear.py +84 -0
  469. qiskit/quantum_info/operators/mixins/multiply.py +62 -0
  470. qiskit/quantum_info/operators/mixins/tolerances.py +72 -0
  471. qiskit/quantum_info/operators/op_shape.py +525 -0
  472. qiskit/quantum_info/operators/operator.py +865 -0
  473. qiskit/quantum_info/operators/operator_utils.py +76 -0
  474. qiskit/quantum_info/operators/predicates.py +183 -0
  475. qiskit/quantum_info/operators/random.py +154 -0
  476. qiskit/quantum_info/operators/scalar_op.py +254 -0
  477. qiskit/quantum_info/operators/symplectic/__init__.py +23 -0
  478. qiskit/quantum_info/operators/symplectic/base_pauli.py +719 -0
  479. qiskit/quantum_info/operators/symplectic/clifford.py +1030 -0
  480. qiskit/quantum_info/operators/symplectic/clifford_circuits.py +558 -0
  481. qiskit/quantum_info/operators/symplectic/pauli.py +753 -0
  482. qiskit/quantum_info/operators/symplectic/pauli_list.py +1230 -0
  483. qiskit/quantum_info/operators/symplectic/pauli_utils.py +40 -0
  484. qiskit/quantum_info/operators/symplectic/random.py +117 -0
  485. qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py +1196 -0
  486. qiskit/quantum_info/operators/utils/__init__.py +20 -0
  487. qiskit/quantum_info/operators/utils/anti_commutator.py +36 -0
  488. qiskit/quantum_info/operators/utils/commutator.py +36 -0
  489. qiskit/quantum_info/operators/utils/double_commutator.py +76 -0
  490. qiskit/quantum_info/quaternion.py +156 -0
  491. qiskit/quantum_info/random.py +26 -0
  492. qiskit/quantum_info/states/__init__.py +28 -0
  493. qiskit/quantum_info/states/densitymatrix.py +845 -0
  494. qiskit/quantum_info/states/measures.py +288 -0
  495. qiskit/quantum_info/states/quantum_state.py +503 -0
  496. qiskit/quantum_info/states/random.py +157 -0
  497. qiskit/quantum_info/states/stabilizerstate.py +773 -0
  498. qiskit/quantum_info/states/statevector.py +958 -0
  499. qiskit/quantum_info/states/utils.py +247 -0
  500. qiskit/result/__init__.py +73 -0
  501. qiskit/result/counts.py +189 -0
  502. qiskit/result/distributions/__init__.py +17 -0
  503. qiskit/result/distributions/probability.py +100 -0
  504. qiskit/result/distributions/quasi.py +154 -0
  505. qiskit/result/exceptions.py +40 -0
  506. qiskit/result/mitigation/__init__.py +13 -0
  507. qiskit/result/mitigation/base_readout_mitigator.py +79 -0
  508. qiskit/result/mitigation/correlated_readout_mitigator.py +277 -0
  509. qiskit/result/mitigation/local_readout_mitigator.py +328 -0
  510. qiskit/result/mitigation/utils.py +217 -0
  511. qiskit/result/models.py +234 -0
  512. qiskit/result/postprocess.py +239 -0
  513. qiskit/result/result.py +392 -0
  514. qiskit/result/sampled_expval.py +75 -0
  515. qiskit/result/utils.py +295 -0
  516. qiskit/scheduler/__init__.py +40 -0
  517. qiskit/scheduler/config.py +37 -0
  518. qiskit/scheduler/lowering.py +187 -0
  519. qiskit/scheduler/methods/__init__.py +15 -0
  520. qiskit/scheduler/methods/basic.py +140 -0
  521. qiskit/scheduler/schedule_circuit.py +69 -0
  522. qiskit/scheduler/sequence.py +104 -0
  523. qiskit/synthesis/__init__.py +220 -0
  524. qiskit/synthesis/arithmetic/__init__.py +16 -0
  525. qiskit/synthesis/arithmetic/adders/__init__.py +17 -0
  526. qiskit/synthesis/arithmetic/adders/cdkm_ripple_carry_adder.py +154 -0
  527. qiskit/synthesis/arithmetic/adders/draper_qft_adder.py +103 -0
  528. qiskit/synthesis/arithmetic/adders/vbe_ripple_carry_adder.py +161 -0
  529. qiskit/synthesis/arithmetic/multipliers/__init__.py +16 -0
  530. qiskit/synthesis/arithmetic/multipliers/hrs_cumulative_multiplier.py +102 -0
  531. qiskit/synthesis/arithmetic/multipliers/rg_qft_multiplier.py +99 -0
  532. qiskit/synthesis/clifford/__init__.py +19 -0
  533. qiskit/synthesis/clifford/clifford_decompose_ag.py +178 -0
  534. qiskit/synthesis/clifford/clifford_decompose_bm.py +46 -0
  535. qiskit/synthesis/clifford/clifford_decompose_full.py +64 -0
  536. qiskit/synthesis/clifford/clifford_decompose_greedy.py +58 -0
  537. qiskit/synthesis/clifford/clifford_decompose_layers.py +447 -0
  538. qiskit/synthesis/cnotdihedral/__init__.py +17 -0
  539. qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py +52 -0
  540. qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py +141 -0
  541. qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py +266 -0
  542. qiskit/synthesis/discrete_basis/__init__.py +16 -0
  543. qiskit/synthesis/discrete_basis/commutator_decompose.py +241 -0
  544. qiskit/synthesis/discrete_basis/gate_sequence.py +415 -0
  545. qiskit/synthesis/discrete_basis/generate_basis_approximations.py +163 -0
  546. qiskit/synthesis/discrete_basis/solovay_kitaev.py +217 -0
  547. qiskit/synthesis/evolution/__init__.py +21 -0
  548. qiskit/synthesis/evolution/evolution_synthesis.py +48 -0
  549. qiskit/synthesis/evolution/lie_trotter.py +117 -0
  550. qiskit/synthesis/evolution/matrix_synthesis.py +47 -0
  551. qiskit/synthesis/evolution/pauli_network.py +80 -0
  552. qiskit/synthesis/evolution/product_formula.py +311 -0
  553. qiskit/synthesis/evolution/qdrift.py +138 -0
  554. qiskit/synthesis/evolution/suzuki_trotter.py +215 -0
  555. qiskit/synthesis/linear/__init__.py +26 -0
  556. qiskit/synthesis/linear/cnot_synth.py +69 -0
  557. qiskit/synthesis/linear/linear_circuits_utils.py +128 -0
  558. qiskit/synthesis/linear/linear_depth_lnn.py +276 -0
  559. qiskit/synthesis/linear/linear_matrix_utils.py +27 -0
  560. qiskit/synthesis/linear_phase/__init__.py +17 -0
  561. qiskit/synthesis/linear_phase/cnot_phase_synth.py +206 -0
  562. qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py +262 -0
  563. qiskit/synthesis/linear_phase/cz_depth_lnn.py +58 -0
  564. qiskit/synthesis/multi_controlled/__init__.py +24 -0
  565. qiskit/synthesis/multi_controlled/mcmt_vchain.py +52 -0
  566. qiskit/synthesis/multi_controlled/mcx_synthesis.py +356 -0
  567. qiskit/synthesis/one_qubit/__init__.py +15 -0
  568. qiskit/synthesis/one_qubit/one_qubit_decompose.py +288 -0
  569. qiskit/synthesis/permutation/__init__.py +18 -0
  570. qiskit/synthesis/permutation/permutation_full.py +78 -0
  571. qiskit/synthesis/permutation/permutation_lnn.py +54 -0
  572. qiskit/synthesis/permutation/permutation_reverse_lnn.py +93 -0
  573. qiskit/synthesis/permutation/permutation_utils.py +16 -0
  574. qiskit/synthesis/qft/__init__.py +16 -0
  575. qiskit/synthesis/qft/qft_decompose_full.py +97 -0
  576. qiskit/synthesis/qft/qft_decompose_lnn.py +79 -0
  577. qiskit/synthesis/stabilizer/__init__.py +16 -0
  578. qiskit/synthesis/stabilizer/stabilizer_circuit.py +149 -0
  579. qiskit/synthesis/stabilizer/stabilizer_decompose.py +194 -0
  580. qiskit/synthesis/two_qubit/__init__.py +19 -0
  581. qiskit/synthesis/two_qubit/local_invariance.py +63 -0
  582. qiskit/synthesis/two_qubit/two_qubit_decompose.py +700 -0
  583. qiskit/synthesis/two_qubit/xx_decompose/__init__.py +19 -0
  584. qiskit/synthesis/two_qubit/xx_decompose/circuits.py +300 -0
  585. qiskit/synthesis/two_qubit/xx_decompose/decomposer.py +324 -0
  586. qiskit/synthesis/two_qubit/xx_decompose/embodiments.py +163 -0
  587. qiskit/synthesis/two_qubit/xx_decompose/paths.py +412 -0
  588. qiskit/synthesis/two_qubit/xx_decompose/polytopes.py +262 -0
  589. qiskit/synthesis/two_qubit/xx_decompose/utilities.py +40 -0
  590. qiskit/synthesis/two_qubit/xx_decompose/weyl.py +133 -0
  591. qiskit/synthesis/unitary/__init__.py +13 -0
  592. qiskit/synthesis/unitary/aqc/__init__.py +177 -0
  593. qiskit/synthesis/unitary/aqc/approximate.py +116 -0
  594. qiskit/synthesis/unitary/aqc/aqc.py +175 -0
  595. qiskit/synthesis/unitary/aqc/cnot_structures.py +300 -0
  596. qiskit/synthesis/unitary/aqc/cnot_unit_circuit.py +103 -0
  597. qiskit/synthesis/unitary/aqc/cnot_unit_objective.py +299 -0
  598. qiskit/synthesis/unitary/aqc/elementary_operations.py +108 -0
  599. qiskit/synthesis/unitary/aqc/fast_gradient/__init__.py +164 -0
  600. qiskit/synthesis/unitary/aqc/fast_gradient/fast_grad_utils.py +237 -0
  601. qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py +226 -0
  602. qiskit/synthesis/unitary/aqc/fast_gradient/layer.py +370 -0
  603. qiskit/synthesis/unitary/aqc/fast_gradient/pmatrix.py +312 -0
  604. qiskit/synthesis/unitary/qsd.py +288 -0
  605. qiskit/transpiler/__init__.py +1290 -0
  606. qiskit/transpiler/basepasses.py +221 -0
  607. qiskit/transpiler/coupling.py +500 -0
  608. qiskit/transpiler/exceptions.py +59 -0
  609. qiskit/transpiler/instruction_durations.py +281 -0
  610. qiskit/transpiler/layout.py +737 -0
  611. qiskit/transpiler/passes/__init__.py +312 -0
  612. qiskit/transpiler/passes/analysis/__init__.py +23 -0
  613. qiskit/transpiler/passes/analysis/count_ops.py +30 -0
  614. qiskit/transpiler/passes/analysis/count_ops_longest_path.py +26 -0
  615. qiskit/transpiler/passes/analysis/dag_longest_path.py +24 -0
  616. qiskit/transpiler/passes/analysis/depth.py +33 -0
  617. qiskit/transpiler/passes/analysis/num_qubits.py +26 -0
  618. qiskit/transpiler/passes/analysis/num_tensor_factors.py +26 -0
  619. qiskit/transpiler/passes/analysis/resource_estimation.py +41 -0
  620. qiskit/transpiler/passes/analysis/size.py +36 -0
  621. qiskit/transpiler/passes/analysis/width.py +27 -0
  622. qiskit/transpiler/passes/basis/__init__.py +19 -0
  623. qiskit/transpiler/passes/basis/basis_translator.py +137 -0
  624. qiskit/transpiler/passes/basis/decompose.py +131 -0
  625. qiskit/transpiler/passes/basis/translate_parameterized.py +175 -0
  626. qiskit/transpiler/passes/basis/unroll_3q_or_more.py +88 -0
  627. qiskit/transpiler/passes/basis/unroll_custom_definitions.py +109 -0
  628. qiskit/transpiler/passes/calibration/__init__.py +17 -0
  629. qiskit/transpiler/passes/calibration/base_builder.py +79 -0
  630. qiskit/transpiler/passes/calibration/builders.py +20 -0
  631. qiskit/transpiler/passes/calibration/exceptions.py +22 -0
  632. qiskit/transpiler/passes/calibration/pulse_gate.py +100 -0
  633. qiskit/transpiler/passes/calibration/rx_builder.py +164 -0
  634. qiskit/transpiler/passes/calibration/rzx_builder.py +411 -0
  635. qiskit/transpiler/passes/calibration/rzx_templates.py +51 -0
  636. qiskit/transpiler/passes/layout/__init__.py +26 -0
  637. qiskit/transpiler/passes/layout/_csp_custom_solver.py +65 -0
  638. qiskit/transpiler/passes/layout/apply_layout.py +123 -0
  639. qiskit/transpiler/passes/layout/csp_layout.py +132 -0
  640. qiskit/transpiler/passes/layout/dense_layout.py +202 -0
  641. qiskit/transpiler/passes/layout/disjoint_utils.py +219 -0
  642. qiskit/transpiler/passes/layout/enlarge_with_ancilla.py +49 -0
  643. qiskit/transpiler/passes/layout/full_ancilla_allocation.py +117 -0
  644. qiskit/transpiler/passes/layout/layout_2q_distance.py +77 -0
  645. qiskit/transpiler/passes/layout/sabre_layout.py +487 -0
  646. qiskit/transpiler/passes/layout/sabre_pre_layout.py +225 -0
  647. qiskit/transpiler/passes/layout/set_layout.py +69 -0
  648. qiskit/transpiler/passes/layout/trivial_layout.py +66 -0
  649. qiskit/transpiler/passes/layout/vf2_layout.py +263 -0
  650. qiskit/transpiler/passes/layout/vf2_post_layout.py +419 -0
  651. qiskit/transpiler/passes/layout/vf2_utils.py +260 -0
  652. qiskit/transpiler/passes/optimization/__init__.py +43 -0
  653. qiskit/transpiler/passes/optimization/_gate_extension.py +80 -0
  654. qiskit/transpiler/passes/optimization/collect_1q_runs.py +31 -0
  655. qiskit/transpiler/passes/optimization/collect_2q_blocks.py +35 -0
  656. qiskit/transpiler/passes/optimization/collect_and_collapse.py +115 -0
  657. qiskit/transpiler/passes/optimization/collect_cliffords.py +104 -0
  658. qiskit/transpiler/passes/optimization/collect_linear_functions.py +80 -0
  659. qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py +227 -0
  660. qiskit/transpiler/passes/optimization/commutation_analysis.py +44 -0
  661. qiskit/transpiler/passes/optimization/commutative_cancellation.py +82 -0
  662. qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py +140 -0
  663. qiskit/transpiler/passes/optimization/consolidate_blocks.py +149 -0
  664. qiskit/transpiler/passes/optimization/cx_cancellation.py +65 -0
  665. qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py +162 -0
  666. qiskit/transpiler/passes/optimization/elide_permutations.py +91 -0
  667. qiskit/transpiler/passes/optimization/hoare_opt.py +420 -0
  668. qiskit/transpiler/passes/optimization/inverse_cancellation.py +95 -0
  669. qiskit/transpiler/passes/optimization/normalize_rx_angle.py +149 -0
  670. qiskit/transpiler/passes/optimization/optimize_1q_commutation.py +268 -0
  671. qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py +254 -0
  672. qiskit/transpiler/passes/optimization/optimize_1q_gates.py +384 -0
  673. qiskit/transpiler/passes/optimization/optimize_annotated.py +448 -0
  674. qiskit/transpiler/passes/optimization/optimize_cliffords.py +89 -0
  675. qiskit/transpiler/passes/optimization/optimize_swap_before_measure.py +71 -0
  676. qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py +41 -0
  677. qiskit/transpiler/passes/optimization/remove_final_reset.py +37 -0
  678. qiskit/transpiler/passes/optimization/remove_identity_equiv.py +69 -0
  679. qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py +37 -0
  680. qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py +47 -0
  681. qiskit/transpiler/passes/optimization/split_2q_unitaries.py +40 -0
  682. qiskit/transpiler/passes/optimization/template_matching/__init__.py +19 -0
  683. qiskit/transpiler/passes/optimization/template_matching/backward_match.py +749 -0
  684. qiskit/transpiler/passes/optimization/template_matching/forward_match.py +452 -0
  685. qiskit/transpiler/passes/optimization/template_matching/maximal_matches.py +77 -0
  686. qiskit/transpiler/passes/optimization/template_matching/template_matching.py +370 -0
  687. qiskit/transpiler/passes/optimization/template_matching/template_substitution.py +638 -0
  688. qiskit/transpiler/passes/optimization/template_optimization.py +158 -0
  689. qiskit/transpiler/passes/routing/__init__.py +22 -0
  690. qiskit/transpiler/passes/routing/algorithms/__init__.py +33 -0
  691. qiskit/transpiler/passes/routing/algorithms/token_swapper.py +105 -0
  692. qiskit/transpiler/passes/routing/algorithms/types.py +46 -0
  693. qiskit/transpiler/passes/routing/algorithms/util.py +103 -0
  694. qiskit/transpiler/passes/routing/basic_swap.py +166 -0
  695. qiskit/transpiler/passes/routing/commuting_2q_gate_routing/__init__.py +25 -0
  696. qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_block.py +60 -0
  697. qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py +395 -0
  698. qiskit/transpiler/passes/routing/commuting_2q_gate_routing/pauli_2q_evolution_commutation.py +145 -0
  699. qiskit/transpiler/passes/routing/commuting_2q_gate_routing/swap_strategy.py +306 -0
  700. qiskit/transpiler/passes/routing/layout_transformation.py +119 -0
  701. qiskit/transpiler/passes/routing/lookahead_swap.py +390 -0
  702. qiskit/transpiler/passes/routing/sabre_swap.py +447 -0
  703. qiskit/transpiler/passes/routing/star_prerouting.py +392 -0
  704. qiskit/transpiler/passes/routing/stochastic_swap.py +532 -0
  705. qiskit/transpiler/passes/routing/utils.py +35 -0
  706. qiskit/transpiler/passes/scheduling/__init__.py +27 -0
  707. qiskit/transpiler/passes/scheduling/alap.py +153 -0
  708. qiskit/transpiler/passes/scheduling/alignments/__init__.py +81 -0
  709. qiskit/transpiler/passes/scheduling/alignments/align_measures.py +255 -0
  710. qiskit/transpiler/passes/scheduling/alignments/check_durations.py +78 -0
  711. qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py +107 -0
  712. qiskit/transpiler/passes/scheduling/alignments/reschedule.py +250 -0
  713. qiskit/transpiler/passes/scheduling/asap.py +175 -0
  714. qiskit/transpiler/passes/scheduling/base_scheduler.py +310 -0
  715. qiskit/transpiler/passes/scheduling/dynamical_decoupling.py +312 -0
  716. qiskit/transpiler/passes/scheduling/padding/__init__.py +16 -0
  717. qiskit/transpiler/passes/scheduling/padding/base_padding.py +256 -0
  718. qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py +452 -0
  719. qiskit/transpiler/passes/scheduling/padding/pad_delay.py +82 -0
  720. qiskit/transpiler/passes/scheduling/scheduling/__init__.py +17 -0
  721. qiskit/transpiler/passes/scheduling/scheduling/alap.py +127 -0
  722. qiskit/transpiler/passes/scheduling/scheduling/asap.py +131 -0
  723. qiskit/transpiler/passes/scheduling/scheduling/base_scheduler.py +94 -0
  724. qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py +64 -0
  725. qiskit/transpiler/passes/scheduling/time_unit_conversion.py +165 -0
  726. qiskit/transpiler/passes/synthesis/__init__.py +20 -0
  727. qiskit/transpiler/passes/synthesis/aqc_plugin.py +153 -0
  728. qiskit/transpiler/passes/synthesis/high_level_synthesis.py +854 -0
  729. qiskit/transpiler/passes/synthesis/hls_plugins.py +1559 -0
  730. qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py +41 -0
  731. qiskit/transpiler/passes/synthesis/plugin.py +734 -0
  732. qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py +297 -0
  733. qiskit/transpiler/passes/synthesis/unitary_synthesis.py +1076 -0
  734. qiskit/transpiler/passes/utils/__init__.py +33 -0
  735. qiskit/transpiler/passes/utils/barrier_before_final_measurements.py +41 -0
  736. qiskit/transpiler/passes/utils/check_gate_direction.py +52 -0
  737. qiskit/transpiler/passes/utils/check_map.py +78 -0
  738. qiskit/transpiler/passes/utils/contains_instruction.py +45 -0
  739. qiskit/transpiler/passes/utils/control_flow.py +65 -0
  740. qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py +93 -0
  741. qiskit/transpiler/passes/utils/dag_fixed_point.py +36 -0
  742. qiskit/transpiler/passes/utils/error.py +69 -0
  743. qiskit/transpiler/passes/utils/filter_op_nodes.py +65 -0
  744. qiskit/transpiler/passes/utils/fixed_point.py +48 -0
  745. qiskit/transpiler/passes/utils/gate_direction.py +86 -0
  746. qiskit/transpiler/passes/utils/gates_basis.py +51 -0
  747. qiskit/transpiler/passes/utils/merge_adjacent_barriers.py +163 -0
  748. qiskit/transpiler/passes/utils/minimum_point.py +118 -0
  749. qiskit/transpiler/passes/utils/remove_barriers.py +49 -0
  750. qiskit/transpiler/passes/utils/remove_final_measurements.py +114 -0
  751. qiskit/transpiler/passes/utils/unroll_forloops.py +81 -0
  752. qiskit/transpiler/passmanager.py +490 -0
  753. qiskit/transpiler/passmanager_config.py +216 -0
  754. qiskit/transpiler/preset_passmanagers/__init__.py +73 -0
  755. qiskit/transpiler/preset_passmanagers/builtin_plugins.py +1045 -0
  756. qiskit/transpiler/preset_passmanagers/common.py +649 -0
  757. qiskit/transpiler/preset_passmanagers/generate_preset_pass_manager.py +626 -0
  758. qiskit/transpiler/preset_passmanagers/level0.py +113 -0
  759. qiskit/transpiler/preset_passmanagers/level1.py +120 -0
  760. qiskit/transpiler/preset_passmanagers/level2.py +119 -0
  761. qiskit/transpiler/preset_passmanagers/level3.py +119 -0
  762. qiskit/transpiler/preset_passmanagers/plugin.py +353 -0
  763. qiskit/transpiler/target.py +1319 -0
  764. qiskit/transpiler/timing_constraints.py +59 -0
  765. qiskit/user_config.py +262 -0
  766. qiskit/utils/__init__.py +89 -0
  767. qiskit/utils/classtools.py +146 -0
  768. qiskit/utils/deprecate_pulse.py +119 -0
  769. qiskit/utils/deprecation.py +490 -0
  770. qiskit/utils/lazy_tester.py +363 -0
  771. qiskit/utils/multiprocessing.py +56 -0
  772. qiskit/utils/optionals.py +347 -0
  773. qiskit/utils/parallel.py +191 -0
  774. qiskit/utils/units.py +143 -0
  775. qiskit/version.py +84 -0
  776. qiskit/visualization/__init__.py +288 -0
  777. qiskit/visualization/array.py +204 -0
  778. qiskit/visualization/bloch.py +778 -0
  779. qiskit/visualization/circuit/__init__.py +15 -0
  780. qiskit/visualization/circuit/_utils.py +675 -0
  781. qiskit/visualization/circuit/circuit_visualization.py +727 -0
  782. qiskit/visualization/circuit/latex.py +661 -0
  783. qiskit/visualization/circuit/matplotlib.py +2029 -0
  784. qiskit/visualization/circuit/qcstyle.py +278 -0
  785. qiskit/visualization/circuit/styles/__init__.py +13 -0
  786. qiskit/visualization/circuit/styles/bw.json +202 -0
  787. qiskit/visualization/circuit/styles/clifford.json +202 -0
  788. qiskit/visualization/circuit/styles/iqp-dark.json +214 -0
  789. qiskit/visualization/circuit/styles/iqp.json +214 -0
  790. qiskit/visualization/circuit/styles/textbook.json +202 -0
  791. qiskit/visualization/circuit/text.py +1844 -0
  792. qiskit/visualization/circuit_visualization.py +19 -0
  793. qiskit/visualization/counts_visualization.py +481 -0
  794. qiskit/visualization/dag_visualization.py +316 -0
  795. qiskit/visualization/exceptions.py +21 -0
  796. qiskit/visualization/gate_map.py +1485 -0
  797. qiskit/visualization/library.py +37 -0
  798. qiskit/visualization/pass_manager_visualization.py +308 -0
  799. qiskit/visualization/pulse_v2/__init__.py +21 -0
  800. qiskit/visualization/pulse_v2/core.py +901 -0
  801. qiskit/visualization/pulse_v2/device_info.py +173 -0
  802. qiskit/visualization/pulse_v2/drawings.py +253 -0
  803. qiskit/visualization/pulse_v2/events.py +254 -0
  804. qiskit/visualization/pulse_v2/generators/__init__.py +40 -0
  805. qiskit/visualization/pulse_v2/generators/barrier.py +76 -0
  806. qiskit/visualization/pulse_v2/generators/chart.py +208 -0
  807. qiskit/visualization/pulse_v2/generators/frame.py +436 -0
  808. qiskit/visualization/pulse_v2/generators/snapshot.py +133 -0
  809. qiskit/visualization/pulse_v2/generators/waveform.py +645 -0
  810. qiskit/visualization/pulse_v2/interface.py +458 -0
  811. qiskit/visualization/pulse_v2/layouts.py +387 -0
  812. qiskit/visualization/pulse_v2/plotters/__init__.py +17 -0
  813. qiskit/visualization/pulse_v2/plotters/base_plotter.py +53 -0
  814. qiskit/visualization/pulse_v2/plotters/matplotlib.py +201 -0
  815. qiskit/visualization/pulse_v2/stylesheet.py +312 -0
  816. qiskit/visualization/pulse_v2/types.py +242 -0
  817. qiskit/visualization/state_visualization.py +1518 -0
  818. qiskit/visualization/timeline/__init__.py +21 -0
  819. qiskit/visualization/timeline/core.py +480 -0
  820. qiskit/visualization/timeline/drawings.py +260 -0
  821. qiskit/visualization/timeline/generators.py +506 -0
  822. qiskit/visualization/timeline/interface.py +436 -0
  823. qiskit/visualization/timeline/layouts.py +115 -0
  824. qiskit/visualization/timeline/plotters/__init__.py +16 -0
  825. qiskit/visualization/timeline/plotters/base_plotter.py +58 -0
  826. qiskit/visualization/timeline/plotters/matplotlib.py +192 -0
  827. qiskit/visualization/timeline/stylesheet.py +301 -0
  828. qiskit/visualization/timeline/types.py +148 -0
  829. qiskit/visualization/transition_visualization.py +369 -0
  830. qiskit/visualization/utils.py +49 -0
  831. qiskit-1.3.0.dist-info/LICENSE.txt +203 -0
  832. qiskit-1.3.0.dist-info/METADATA +222 -0
  833. qiskit-1.3.0.dist-info/RECORD +836 -0
  834. qiskit-1.3.0.dist-info/WHEEL +5 -0
  835. qiskit-1.3.0.dist-info/entry_points.txt +76 -0
  836. qiskit-1.3.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1529 @@
1
+ # This code is part of Qiskit.
2
+ #
3
+ # (C) Copyright IBM 2017.
4
+ #
5
+ # This code is licensed under the Apache License, Version 2.0. You may
6
+ # obtain a copy of this license in the LICENSE.txt file in the root directory
7
+ # of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
8
+ #
9
+ # Any modifications or derivative works of this code must retain this
10
+ # copyright notice, and modified files need to carry a notice indicating
11
+ # that they have been altered from the originals.
12
+
13
+ """X, CX, CCX and multi-controlled X gates."""
14
+ from __future__ import annotations
15
+ from typing import Optional, Union, Type
16
+ from math import pi
17
+ import numpy
18
+ from qiskit.circuit.controlledgate import ControlledGate
19
+ from qiskit.circuit.singleton import SingletonGate, SingletonControlledGate, stdlib_singleton_key
20
+ from qiskit.circuit.quantumregister import QuantumRegister
21
+ from qiskit.circuit._utils import _ctrl_state_to_int, with_gate_array, with_controlled_gate_array
22
+ from qiskit._accelerate.circuit import StandardGate
23
+ from qiskit.utils.deprecation import deprecate_func
24
+
25
+ _X_ARRAY = [[0, 1], [1, 0]]
26
+ _SX_ARRAY = [[0.5 + 0.5j, 0.5 - 0.5j], [0.5 - 0.5j, 0.5 + 0.5j]]
27
+
28
+
29
+ @with_gate_array(_X_ARRAY)
30
+ class XGate(SingletonGate):
31
+ r"""The single-qubit Pauli-X gate (:math:`\sigma_x`).
32
+
33
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
34
+ with the :meth:`~qiskit.circuit.QuantumCircuit.x` method.
35
+
36
+ **Matrix Representation:**
37
+
38
+ .. math::
39
+
40
+ X = \begin{pmatrix}
41
+ 0 & 1 \\
42
+ 1 & 0
43
+ \end{pmatrix}
44
+
45
+ **Circuit symbol:**
46
+
47
+ .. code-block:: text
48
+
49
+ ┌───┐
50
+ q_0: ┤ X ├
51
+ └───┘
52
+
53
+ Equivalent to a :math:`\pi` radian rotation about the X axis.
54
+
55
+ .. note::
56
+
57
+ A global phase difference exists between the definitions of
58
+ :math:`RX(\pi)` and :math:`X`.
59
+
60
+ .. math::
61
+
62
+ RX(\pi) = \begin{pmatrix}
63
+ 0 & -i \\
64
+ -i & 0
65
+ \end{pmatrix}
66
+ = -i X
67
+
68
+ The gate is equivalent to a classical bit flip.
69
+
70
+ .. math::
71
+
72
+ |0\rangle \rightarrow |1\rangle \\
73
+ |1\rangle \rightarrow |0\rangle
74
+ """
75
+
76
+ _standard_gate = StandardGate.XGate
77
+
78
+ def __init__(self, label: Optional[str] = None, *, duration=None, unit="dt"):
79
+ """Create new X gate."""
80
+ super().__init__("x", 1, [], label=label, duration=duration, unit=unit)
81
+
82
+ _singleton_lookup_key = stdlib_singleton_key()
83
+
84
+ def _define(self):
85
+ """
86
+ gate x a { u3(pi,0,pi) a; }
87
+ """
88
+ # pylint: disable=cyclic-import
89
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
90
+ from .u3 import U3Gate
91
+
92
+ q = QuantumRegister(1, "q")
93
+ qc = QuantumCircuit(q, name=self.name)
94
+ rules = [(U3Gate(pi, 0, pi), [q[0]], [])]
95
+ for instr, qargs, cargs in rules:
96
+ qc._append(instr, qargs, cargs)
97
+
98
+ self.definition = qc
99
+
100
+ def control(
101
+ self,
102
+ num_ctrl_qubits: int = 1,
103
+ label: Optional[str] = None,
104
+ ctrl_state: Optional[Union[str, int]] = None,
105
+ annotated: bool = False,
106
+ ):
107
+ """Return a (multi-)controlled-X gate.
108
+
109
+ One control returns a CX gate. Two controls returns a CCX gate.
110
+
111
+ Args:
112
+ num_ctrl_qubits: number of control qubits.
113
+ label: An optional label for the gate [Default: ``None``]
114
+ ctrl_state: control state expressed as integer,
115
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
116
+ annotated: indicates whether the controlled gate should be implemented
117
+ as an annotated gate.
118
+
119
+ Returns:
120
+ ControlledGate: controlled version of this gate.
121
+ """
122
+ if not annotated:
123
+ gate = MCXGate(
124
+ num_ctrl_qubits=num_ctrl_qubits,
125
+ label=label,
126
+ ctrl_state=ctrl_state,
127
+ _base_label=self.label,
128
+ )
129
+ else:
130
+ gate = super().control(
131
+ num_ctrl_qubits=num_ctrl_qubits,
132
+ label=label,
133
+ ctrl_state=ctrl_state,
134
+ annotated=annotated,
135
+ )
136
+ return gate
137
+
138
+ def inverse(self, annotated: bool = False):
139
+ r"""Return inverted X gate (itself).
140
+
141
+ Args:
142
+ annotated: when set to ``True``, this is typically used to return an
143
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
144
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
145
+ is self-inverse.
146
+
147
+ Returns:
148
+ XGate: inverse gate (self-inverse).
149
+ """
150
+ return XGate() # self-inverse
151
+
152
+ def __eq__(self, other):
153
+ return isinstance(other, XGate)
154
+
155
+
156
+ @with_controlled_gate_array(_X_ARRAY, num_ctrl_qubits=1)
157
+ class CXGate(SingletonControlledGate):
158
+ r"""Controlled-X gate.
159
+
160
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
161
+ with the :meth:`~qiskit.circuit.QuantumCircuit.cx` and
162
+ :meth:`~qiskit.circuit.QuantumCircuit.cnot` methods.
163
+
164
+ **Circuit symbol:**
165
+
166
+ .. code-block:: text
167
+
168
+ q_0: ──■──
169
+ ┌─┴─┐
170
+ q_1: ┤ X ├
171
+ └───┘
172
+
173
+ **Matrix representation:**
174
+
175
+ .. math::
176
+
177
+ CX\ q_0, q_1 =
178
+ I \otimes |0\rangle\langle0| + X \otimes |1\rangle\langle1| =
179
+ \begin{pmatrix}
180
+ 1 & 0 & 0 & 0 \\
181
+ 0 & 0 & 0 & 1 \\
182
+ 0 & 0 & 1 & 0 \\
183
+ 0 & 1 & 0 & 0
184
+ \end{pmatrix}
185
+
186
+ .. note::
187
+
188
+ In Qiskit's convention, higher qubit indices are more significant
189
+ (little endian convention). In many textbooks, controlled gates are
190
+ presented with the assumption of more significant qubits as control,
191
+ which in our case would be q_1. Thus a textbook matrix for this
192
+ gate will be:
193
+
194
+ .. code-block:: text
195
+
196
+ ┌───┐
197
+ q_0: ┤ X ├
198
+ └─┬─┘
199
+ q_1: ──■──
200
+
201
+ .. math::
202
+
203
+ CX\ q_1, q_0 =
204
+ |0 \rangle\langle 0| \otimes I + |1 \rangle\langle 1| \otimes X =
205
+ \begin{pmatrix}
206
+ 1 & 0 & 0 & 0 \\
207
+ 0 & 1 & 0 & 0 \\
208
+ 0 & 0 & 0 & 1 \\
209
+ 0 & 0 & 1 & 0
210
+ \end{pmatrix}
211
+
212
+
213
+ In the computational basis, this gate flips the target qubit
214
+ if the control qubit is in the :math:`|1\rangle` state.
215
+ In this sense it is similar to a classical XOR gate.
216
+
217
+ .. math::
218
+ `|a, b\rangle \rightarrow |a, a \oplus b\rangle`
219
+ """
220
+
221
+ _standard_gate = StandardGate.CXGate
222
+
223
+ def __init__(
224
+ self,
225
+ label: Optional[str] = None,
226
+ ctrl_state: Optional[Union[str, int]] = None,
227
+ *,
228
+ duration=None,
229
+ unit="dt",
230
+ _base_label=None,
231
+ ):
232
+ """Create new CX gate."""
233
+ super().__init__(
234
+ "cx",
235
+ 2,
236
+ [],
237
+ num_ctrl_qubits=1,
238
+ label=label,
239
+ ctrl_state=ctrl_state,
240
+ base_gate=XGate(label=_base_label),
241
+ _base_label=_base_label,
242
+ duration=duration,
243
+ unit=unit,
244
+ )
245
+
246
+ _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=1)
247
+
248
+ def control(
249
+ self,
250
+ num_ctrl_qubits: int = 1,
251
+ label: Optional[str] = None,
252
+ ctrl_state: Optional[Union[str, int]] = None,
253
+ annotated: bool = False,
254
+ ):
255
+ """Return a controlled-X gate with more control lines.
256
+
257
+ Args:
258
+ num_ctrl_qubits: number of control qubits.
259
+ label: An optional label for the gate [Default: ``None``]
260
+ ctrl_state: control state expressed as integer,
261
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
262
+ annotated: indicates whether the controlled gate should be implemented
263
+ as an annotated gate.
264
+
265
+ Returns:
266
+ ControlledGate: controlled version of this gate.
267
+ """
268
+ if not annotated:
269
+ ctrl_state = _ctrl_state_to_int(ctrl_state, num_ctrl_qubits)
270
+ new_ctrl_state = (self.ctrl_state << num_ctrl_qubits) | ctrl_state
271
+ gate = MCXGate(
272
+ num_ctrl_qubits=num_ctrl_qubits + 1,
273
+ label=label,
274
+ ctrl_state=new_ctrl_state,
275
+ _base_label=self.label,
276
+ )
277
+ else:
278
+ gate = super().control(
279
+ num_ctrl_qubits=num_ctrl_qubits,
280
+ label=label,
281
+ ctrl_state=ctrl_state,
282
+ annotated=annotated,
283
+ )
284
+ return gate
285
+
286
+ def inverse(self, annotated: bool = False):
287
+ """Return inverted CX gate (itself).
288
+
289
+ Args:
290
+ annotated: when set to ``True``, this is typically used to return an
291
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
292
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
293
+ is self-inverse.
294
+
295
+ Returns:
296
+ CXGate: inverse gate (self-inverse).
297
+ """
298
+ return CXGate(ctrl_state=self.ctrl_state) # self-inverse
299
+
300
+ def __eq__(self, other):
301
+ return isinstance(other, CXGate) and self.ctrl_state == other.ctrl_state
302
+
303
+
304
+ @with_controlled_gate_array(_X_ARRAY, num_ctrl_qubits=2, cached_states=(3,))
305
+ class CCXGate(SingletonControlledGate):
306
+ r"""CCX gate, also known as Toffoli gate.
307
+
308
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
309
+ with the :meth:`~qiskit.circuit.QuantumCircuit.ccx` and
310
+ :meth:`~qiskit.circuit.QuantumCircuit.toffoli` methods.
311
+
312
+ **Circuit symbol:**
313
+
314
+ .. code-block:: text
315
+
316
+ q_0: ──■──
317
+
318
+ q_1: ──■──
319
+ ┌─┴─┐
320
+ q_2: ┤ X ├
321
+ └───┘
322
+
323
+ **Matrix representation:**
324
+
325
+ .. math::
326
+
327
+ CCX q_0, q_1, q_2 =
328
+ I \otimes I \otimes |0 \rangle \langle 0| + CX \otimes |1 \rangle \langle 1| =
329
+ \begin{pmatrix}
330
+ 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0\\
331
+ 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0\\
332
+ 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0\\
333
+ 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1\\
334
+ 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0\\
335
+ 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0\\
336
+ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0\\
337
+ 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0
338
+ \end{pmatrix}
339
+
340
+ .. note::
341
+
342
+ In Qiskit's convention, higher qubit indices are more significant
343
+ (little endian convention). In many textbooks, controlled gates are
344
+ presented with the assumption of more significant qubits as control,
345
+ which in our case would be q_2 and q_1. Thus a textbook matrix for this
346
+ gate will be:
347
+
348
+ .. code-block:: text
349
+
350
+ ┌───┐
351
+ q_0: ┤ X ├
352
+ └─┬─┘
353
+ q_1: ──■──
354
+
355
+ q_2: ──■──
356
+
357
+ .. math::
358
+
359
+ CCX\ q_2, q_1, q_0 =
360
+ |0 \rangle \langle 0| \otimes I \otimes I + |1 \rangle \langle 1| \otimes CX =
361
+ \begin{pmatrix}
362
+ 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0\\
363
+ 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0\\
364
+ 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0\\
365
+ 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0\\
366
+ 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0\\
367
+ 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0\\
368
+ 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1\\
369
+ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0
370
+ \end{pmatrix}
371
+
372
+ """
373
+
374
+ _standard_gate = StandardGate.CCXGate
375
+
376
+ def __init__(
377
+ self,
378
+ label: Optional[str] = None,
379
+ ctrl_state: Optional[Union[str, int]] = None,
380
+ *,
381
+ duration=None,
382
+ unit="dt",
383
+ _base_label=None,
384
+ ):
385
+ """Create new CCX gate."""
386
+ super().__init__(
387
+ "ccx",
388
+ 3,
389
+ [],
390
+ num_ctrl_qubits=2,
391
+ label=label,
392
+ ctrl_state=ctrl_state,
393
+ base_gate=XGate(label=_base_label),
394
+ duration=duration,
395
+ unit=unit,
396
+ )
397
+
398
+ _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=2)
399
+
400
+ def _define(self):
401
+ """
402
+ gate ccx a,b,c
403
+ {
404
+ h c; cx b,c; tdg c; cx a,c;
405
+ t c; cx b,c; tdg c; cx a,c;
406
+ t b; t c; h c; cx a,b;
407
+ t a; tdg b; cx a,b;}
408
+ """
409
+ # pylint: disable=cyclic-import
410
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
411
+ from .h import HGate
412
+ from .t import TGate, TdgGate
413
+
414
+ # ┌───┐
415
+ # q_0: ───────────────────■─────────────────────■────■───┤ T ├───■──
416
+ # │ ┌───┐ │ ┌─┴─┐┌┴───┴┐┌─┴─┐
417
+ # q_1: ───────■───────────┼─────────■───┤ T ├───┼──┤ X ├┤ Tdg ├┤ X ├
418
+ # ┌───┐┌─┴─┐┌─────┐┌─┴─┐┌───┐┌─┴─┐┌┴───┴┐┌─┴─┐├───┤└┬───┬┘└───┘
419
+ # q_2: ┤ H ├┤ X ├┤ Tdg ├┤ X ├┤ T ├┤ X ├┤ Tdg ├┤ X ├┤ T ├─┤ H ├──────
420
+ # └───┘└───┘└─────┘└───┘└───┘└───┘└─────┘└───┘└───┘ └───┘
421
+ q = QuantumRegister(3, "q")
422
+ qc = QuantumCircuit(q, name=self.name)
423
+ rules = [
424
+ (HGate(), [q[2]], []),
425
+ (CXGate(), [q[1], q[2]], []),
426
+ (TdgGate(), [q[2]], []),
427
+ (CXGate(), [q[0], q[2]], []),
428
+ (TGate(), [q[2]], []),
429
+ (CXGate(), [q[1], q[2]], []),
430
+ (TdgGate(), [q[2]], []),
431
+ (CXGate(), [q[0], q[2]], []),
432
+ (TGate(), [q[1]], []),
433
+ (TGate(), [q[2]], []),
434
+ (HGate(), [q[2]], []),
435
+ (CXGate(), [q[0], q[1]], []),
436
+ (TGate(), [q[0]], []),
437
+ (TdgGate(), [q[1]], []),
438
+ (CXGate(), [q[0], q[1]], []),
439
+ ]
440
+ for instr, qargs, cargs in rules:
441
+ qc._append(instr, qargs, cargs)
442
+
443
+ self.definition = qc
444
+
445
+ def control(
446
+ self,
447
+ num_ctrl_qubits: int = 1,
448
+ label: Optional[str] = None,
449
+ ctrl_state: Optional[Union[str, int]] = None,
450
+ annotated: bool = False,
451
+ ):
452
+ """Controlled version of this gate.
453
+
454
+ Args:
455
+ num_ctrl_qubits: number of control qubits.
456
+ label: An optional label for the gate [Default: ``None``]
457
+ ctrl_state: control state expressed as integer,
458
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
459
+ annotated: indicates whether the controlled gate should be implemented
460
+ as an annotated gate.
461
+
462
+ Returns:
463
+ ControlledGate: controlled version of this gate.
464
+ """
465
+ if not annotated:
466
+ ctrl_state = _ctrl_state_to_int(ctrl_state, num_ctrl_qubits)
467
+ new_ctrl_state = (self.ctrl_state << num_ctrl_qubits) | ctrl_state
468
+ gate = MCXGate(
469
+ num_ctrl_qubits=num_ctrl_qubits + 2,
470
+ label=label,
471
+ ctrl_state=new_ctrl_state,
472
+ _base_label=self.label,
473
+ )
474
+ else:
475
+ gate = super().control(
476
+ num_ctrl_qubits=num_ctrl_qubits,
477
+ label=label,
478
+ ctrl_state=ctrl_state,
479
+ annotated=annotated,
480
+ )
481
+ return gate
482
+
483
+ def inverse(self, annotated: bool = False):
484
+ """Return an inverted CCX gate (also a CCX).
485
+
486
+ Args:
487
+ annotated: when set to ``True``, this is typically used to return an
488
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
489
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
490
+ is self-inverse.
491
+
492
+ Returns:
493
+ CCXGate: inverse gate (self-inverse).
494
+ """
495
+ return CCXGate(ctrl_state=self.ctrl_state) # self-inverse
496
+
497
+ def __eq__(self, other):
498
+ return isinstance(other, CCXGate) and self.ctrl_state == other.ctrl_state
499
+
500
+
501
+ @with_gate_array(
502
+ [
503
+ [1, 0, 0, 0, 0, 0, 0, 0],
504
+ [0, 1, 0, 0, 0, 0, 0, 0],
505
+ [0, 0, 1, 0, 0, 0, 0, 0],
506
+ [0, 0, 0, 0, 0, 0, 0, -1j],
507
+ [0, 0, 0, 0, 1, 0, 0, 0],
508
+ [0, 0, 0, 0, 0, -1, 0, 0],
509
+ [0, 0, 0, 0, 0, 0, 1, 0],
510
+ [0, 0, 0, 1j, 0, 0, 0, 0],
511
+ ]
512
+ )
513
+ class RCCXGate(SingletonGate):
514
+ """The simplified Toffoli gate, also referred to as Margolus gate.
515
+
516
+ The simplified Toffoli gate implements the Toffoli gate up to relative phases.
517
+ This implementation requires three CX gates which is the minimal amount possible,
518
+ as shown in https://arxiv.org/abs/quant-ph/0312225.
519
+ Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places
520
+ where the Toffoli gate is uncomputed again.
521
+
522
+ This concrete implementation is from https://arxiv.org/abs/1508.03273, the dashed box
523
+ of Fig. 3.
524
+
525
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
526
+ with the :meth:`~qiskit.circuit.QuantumCircuit.rccx` method.
527
+ """
528
+
529
+ _standard_gate = StandardGate.RCCXGate
530
+
531
+ def __init__(self, label: Optional[str] = None, *, duration=None, unit="dt"):
532
+ """Create a new simplified CCX gate."""
533
+ super().__init__("rccx", 3, [], label=label, duration=duration, unit=unit)
534
+
535
+ _singleton_lookup_key = stdlib_singleton_key()
536
+
537
+ def _define(self):
538
+ """
539
+ gate rccx a,b,c
540
+ { u2(0,pi) c;
541
+ u1(pi/4) c;
542
+ cx b, c;
543
+ u1(-pi/4) c;
544
+ cx a, c;
545
+ u1(pi/4) c;
546
+ cx b, c;
547
+ u1(-pi/4) c;
548
+ u2(0,pi) c;
549
+ }
550
+ """
551
+ # pylint: disable=cyclic-import
552
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
553
+ from .u1 import U1Gate
554
+ from .u2 import U2Gate
555
+
556
+ q = QuantumRegister(3, "q")
557
+ qc = QuantumCircuit(q, name=self.name)
558
+ rules = [
559
+ (U2Gate(0, pi), [q[2]], []), # H gate
560
+ (U1Gate(pi / 4), [q[2]], []), # T gate
561
+ (CXGate(), [q[1], q[2]], []),
562
+ (U1Gate(-pi / 4), [q[2]], []), # inverse T gate
563
+ (CXGate(), [q[0], q[2]], []),
564
+ (U1Gate(pi / 4), [q[2]], []),
565
+ (CXGate(), [q[1], q[2]], []),
566
+ (U1Gate(-pi / 4), [q[2]], []), # inverse T gate
567
+ (U2Gate(0, pi), [q[2]], []), # H gate
568
+ ]
569
+ for instr, qargs, cargs in rules:
570
+ qc._append(instr, qargs, cargs)
571
+
572
+ self.definition = qc
573
+
574
+ def __eq__(self, other):
575
+ return isinstance(other, RCCXGate)
576
+
577
+
578
+ @with_controlled_gate_array(_SX_ARRAY, num_ctrl_qubits=3, cached_states=(7,))
579
+ class C3SXGate(SingletonControlledGate):
580
+ """The 3-qubit controlled sqrt-X gate.
581
+
582
+ This implementation is based on Page 17 of [1].
583
+
584
+ References:
585
+ [1] Barenco et al., 1995. https://arxiv.org/pdf/quant-ph/9503016.pdf
586
+ """
587
+
588
+ _standard_gate = StandardGate.C3SXGate
589
+
590
+ def __init__(
591
+ self,
592
+ label: Optional[str] = None,
593
+ ctrl_state: Optional[Union[str, int]] = None,
594
+ *,
595
+ duration=None,
596
+ unit="dt",
597
+ _base_label=None,
598
+ ):
599
+ """Create a new 3-qubit controlled sqrt-X gate.
600
+
601
+ Args:
602
+ label: An optional label for the gate [Default: ``None``]
603
+ ctrl_state: control state expressed as integer,
604
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
605
+ """
606
+ from .sx import SXGate
607
+
608
+ super().__init__(
609
+ "c3sx",
610
+ 4,
611
+ [],
612
+ num_ctrl_qubits=3,
613
+ label=label,
614
+ ctrl_state=ctrl_state,
615
+ base_gate=SXGate(label=_base_label),
616
+ duration=duration,
617
+ unit=unit,
618
+ )
619
+
620
+ _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=3)
621
+
622
+ def _define(self):
623
+ """
624
+ gate c3sqrtx a,b,c,d
625
+ {
626
+ h d; cu1(pi/8) a,d; h d;
627
+ cx a,b;
628
+ h d; cu1(-pi/8) b,d; h d;
629
+ cx a,b;
630
+ h d; cu1(pi/8) b,d; h d;
631
+ cx b,c;
632
+ h d; cu1(-pi/8) c,d; h d;
633
+ cx a,c;
634
+ h d; cu1(pi/8) c,d; h d;
635
+ cx b,c;
636
+ h d; cu1(-pi/8) c,d; h d;
637
+ cx a,c;
638
+ h d; cu1(pi/8) c,d; h d;
639
+ }
640
+ """
641
+ # pylint: disable=cyclic-import
642
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
643
+ from .u1 import CU1Gate
644
+ from .h import HGate
645
+
646
+ angle = numpy.pi / 8
647
+ q = QuantumRegister(4, name="q")
648
+ rules = [
649
+ (HGate(), [q[3]], []),
650
+ (CU1Gate(angle), [q[0], q[3]], []),
651
+ (HGate(), [q[3]], []),
652
+ (CXGate(), [q[0], q[1]], []),
653
+ (HGate(), [q[3]], []),
654
+ (CU1Gate(-angle), [q[1], q[3]], []),
655
+ (HGate(), [q[3]], []),
656
+ (CXGate(), [q[0], q[1]], []),
657
+ (HGate(), [q[3]], []),
658
+ (CU1Gate(angle), [q[1], q[3]], []),
659
+ (HGate(), [q[3]], []),
660
+ (CXGate(), [q[1], q[2]], []),
661
+ (HGate(), [q[3]], []),
662
+ (CU1Gate(-angle), [q[2], q[3]], []),
663
+ (HGate(), [q[3]], []),
664
+ (CXGate(), [q[0], q[2]], []),
665
+ (HGate(), [q[3]], []),
666
+ (CU1Gate(angle), [q[2], q[3]], []),
667
+ (HGate(), [q[3]], []),
668
+ (CXGate(), [q[1], q[2]], []),
669
+ (HGate(), [q[3]], []),
670
+ (CU1Gate(-angle), [q[2], q[3]], []),
671
+ (HGate(), [q[3]], []),
672
+ (CXGate(), [q[0], q[2]], []),
673
+ (HGate(), [q[3]], []),
674
+ (CU1Gate(angle), [q[2], q[3]], []),
675
+ (HGate(), [q[3]], []),
676
+ ]
677
+ qc = QuantumCircuit(q)
678
+ for instr, qargs, cargs in rules:
679
+ qc._append(instr, qargs, cargs)
680
+
681
+ self.definition = qc
682
+
683
+ def __eq__(self, other):
684
+ return isinstance(other, C3SXGate) and self.ctrl_state == other.ctrl_state
685
+
686
+
687
+ @with_controlled_gate_array(_X_ARRAY, num_ctrl_qubits=3, cached_states=(7,))
688
+ class C3XGate(SingletonControlledGate):
689
+ r"""The X gate controlled on 3 qubits.
690
+
691
+ This implementation uses :math:`\sqrt{T}` and 14 CNOT gates.
692
+ """
693
+
694
+ _standard_gate = StandardGate.C3XGate
695
+
696
+ def __init__(
697
+ self,
698
+ label: Optional[str] = None,
699
+ ctrl_state: Optional[Union[str, int]] = None,
700
+ *,
701
+ _base_label=None,
702
+ duration=None,
703
+ unit="dt",
704
+ ):
705
+ """Create a new 3-qubit controlled X gate."""
706
+ super().__init__(
707
+ "mcx",
708
+ 4,
709
+ [],
710
+ num_ctrl_qubits=3,
711
+ label=label,
712
+ ctrl_state=ctrl_state,
713
+ base_gate=XGate(label=_base_label),
714
+ duration=duration,
715
+ unit=unit,
716
+ )
717
+
718
+ _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=3)
719
+
720
+ # seems like open controls not happening?
721
+ def _define(self):
722
+ """
723
+ gate c3x a,b,c,d
724
+ {
725
+ h d;
726
+ p(pi/8) a;
727
+ p(pi/8) b;
728
+ p(pi/8) c;
729
+ p(pi/8) d;
730
+ cx a, b;
731
+ p(-pi/8) b;
732
+ cx a, b;
733
+ cx b, c;
734
+ p(-pi/8) c;
735
+ cx a, c;
736
+ p(pi/8) c;
737
+ cx b, c;
738
+ p(-pi/8) c;
739
+ cx a, c;
740
+ cx c, d;
741
+ p(-pi/8) d;
742
+ cx b, d;
743
+ p(pi/8) d;
744
+ cx c, d;
745
+ p(-pi/8) d;
746
+ cx a, d;
747
+ p(pi/8) d;
748
+ cx c, d;
749
+ p(-pi/8) d;
750
+ cx b, d;
751
+ p(pi/8) d;
752
+ cx c, d;
753
+ p(-pi/8) d;
754
+ cx a, d;
755
+ h d;
756
+ }
757
+ """
758
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
759
+
760
+ q = QuantumRegister(4, name="q")
761
+ qc = QuantumCircuit(q, name=self.name)
762
+ qc.h(3)
763
+ qc.p(pi / 8, [0, 1, 2, 3])
764
+ qc.cx(0, 1)
765
+ qc.p(-pi / 8, 1)
766
+ qc.cx(0, 1)
767
+ qc.cx(1, 2)
768
+ qc.p(-pi / 8, 2)
769
+ qc.cx(0, 2)
770
+ qc.p(pi / 8, 2)
771
+ qc.cx(1, 2)
772
+ qc.p(-pi / 8, 2)
773
+ qc.cx(0, 2)
774
+ qc.cx(2, 3)
775
+ qc.p(-pi / 8, 3)
776
+ qc.cx(1, 3)
777
+ qc.p(pi / 8, 3)
778
+ qc.cx(2, 3)
779
+ qc.p(-pi / 8, 3)
780
+ qc.cx(0, 3)
781
+ qc.p(pi / 8, 3)
782
+ qc.cx(2, 3)
783
+ qc.p(-pi / 8, 3)
784
+ qc.cx(1, 3)
785
+ qc.p(pi / 8, 3)
786
+ qc.cx(2, 3)
787
+ qc.p(-pi / 8, 3)
788
+ qc.cx(0, 3)
789
+ qc.h(3)
790
+
791
+ self.definition = qc
792
+
793
+ def control(
794
+ self,
795
+ num_ctrl_qubits: int = 1,
796
+ label: Optional[str] = None,
797
+ ctrl_state: Optional[Union[str, int]] = None,
798
+ annotated: bool = False,
799
+ ):
800
+ """Controlled version of this gate.
801
+
802
+ Args:
803
+ num_ctrl_qubits: number of control qubits.
804
+ label: An optional label for the gate [Default: ``None``]
805
+ ctrl_state: control state expressed as integer,
806
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
807
+ annotated: indicates whether the controlled gate should be implemented
808
+ as an annotated gate.
809
+
810
+ Returns:
811
+ ControlledGate: controlled version of this gate.
812
+ """
813
+ if not annotated:
814
+ ctrl_state = _ctrl_state_to_int(ctrl_state, num_ctrl_qubits)
815
+ new_ctrl_state = (self.ctrl_state << num_ctrl_qubits) | ctrl_state
816
+ gate = MCXGate(
817
+ num_ctrl_qubits=num_ctrl_qubits + 3,
818
+ label=label,
819
+ ctrl_state=new_ctrl_state,
820
+ _base_label=self.label,
821
+ )
822
+ else:
823
+ gate = super().control(
824
+ num_ctrl_qubits=num_ctrl_qubits,
825
+ label=label,
826
+ ctrl_state=ctrl_state,
827
+ annotated=annotated,
828
+ )
829
+ return gate
830
+
831
+ def inverse(self, annotated: bool = False):
832
+ """Invert this gate. The C3X is its own inverse.
833
+
834
+ Args:
835
+ annotated: when set to ``True``, this is typically used to return an
836
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
837
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
838
+ is self-inverse.
839
+
840
+ Returns:
841
+ C3XGate: inverse gate (self-inverse).
842
+ """
843
+ return C3XGate(ctrl_state=self.ctrl_state)
844
+
845
+ def __eq__(self, other):
846
+ return isinstance(other, C3XGate) and self.ctrl_state == other.ctrl_state
847
+
848
+
849
+ @with_gate_array(
850
+ [
851
+ [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
852
+ [0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
853
+ [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
854
+ [0, 0, 0, 1j, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
855
+ [0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
856
+ [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
857
+ [0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0],
858
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1],
859
+ [0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0],
860
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
861
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0],
862
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, -1j, 0, 0, 0, 0],
863
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0],
864
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0],
865
+ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0],
866
+ [0, 0, 0, 0, 0, 0, 0, -1, 0, 0, 0, 0, 0, 0, 0, 0],
867
+ ]
868
+ )
869
+ class RC3XGate(SingletonGate):
870
+ """The simplified 3-controlled Toffoli gate.
871
+
872
+ The simplified Toffoli gate implements the Toffoli gate up to relative phases.
873
+ Note, that the simplified Toffoli is not equivalent to the Toffoli. But can be used in places
874
+ where the Toffoli gate is uncomputed again.
875
+
876
+ This concrete implementation is from https://arxiv.org/abs/1508.03273, the complete circuit
877
+ of Fig. 4.
878
+
879
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
880
+ with the :meth:`~qiskit.circuit.QuantumCircuit.rcccx` method.
881
+ """
882
+
883
+ _standard_gate = StandardGate.RC3XGate
884
+
885
+ def __init__(self, label: Optional[str] = None, *, duration=None, unit="dt"):
886
+ """Create a new RC3X gate."""
887
+ super().__init__("rcccx", 4, [], label=label, duration=duration, unit=unit)
888
+
889
+ _singleton_lookup_key = stdlib_singleton_key()
890
+
891
+ def _define(self):
892
+ """
893
+ gate rc3x a,b,c,d
894
+ { u2(0,pi) d;
895
+ u1(pi/4) d;
896
+ cx c,d;
897
+ u1(-pi/4) d;
898
+ u2(0,pi) d;
899
+ cx a,d;
900
+ u1(pi/4) d;
901
+ cx b,d;
902
+ u1(-pi/4) d;
903
+ cx a,d;
904
+ u1(pi/4) d;
905
+ cx b,d;
906
+ u1(-pi/4) d;
907
+ u2(0,pi) d;
908
+ u1(pi/4) d;
909
+ cx c,d;
910
+ u1(-pi/4) d;
911
+ u2(0,pi) d;
912
+ }
913
+ """
914
+ # pylint: disable=cyclic-import
915
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
916
+ from .u1 import U1Gate
917
+ from .u2 import U2Gate
918
+
919
+ q = QuantumRegister(4, "q")
920
+ qc = QuantumCircuit(q, name=self.name)
921
+ rules = [
922
+ (U2Gate(0, pi), [q[3]], []), # H gate
923
+ (U1Gate(pi / 4), [q[3]], []), # T gate
924
+ (CXGate(), [q[2], q[3]], []),
925
+ (U1Gate(-pi / 4), [q[3]], []), # inverse T gate
926
+ (U2Gate(0, pi), [q[3]], []),
927
+ (CXGate(), [q[0], q[3]], []),
928
+ (U1Gate(pi / 4), [q[3]], []),
929
+ (CXGate(), [q[1], q[3]], []),
930
+ (U1Gate(-pi / 4), [q[3]], []),
931
+ (CXGate(), [q[0], q[3]], []),
932
+ (U1Gate(pi / 4), [q[3]], []),
933
+ (CXGate(), [q[1], q[3]], []),
934
+ (U1Gate(-pi / 4), [q[3]], []),
935
+ (U2Gate(0, pi), [q[3]], []),
936
+ (U1Gate(pi / 4), [q[3]], []),
937
+ (CXGate(), [q[2], q[3]], []),
938
+ (U1Gate(-pi / 4), [q[3]], []),
939
+ (U2Gate(0, pi), [q[3]], []),
940
+ ]
941
+ for instr, qargs, cargs in rules:
942
+ qc._append(instr, qargs, cargs)
943
+
944
+ self.definition = qc
945
+
946
+ def __eq__(self, other):
947
+ return isinstance(other, RC3XGate)
948
+
949
+
950
+ @with_controlled_gate_array(_X_ARRAY, num_ctrl_qubits=4, cached_states=(15,))
951
+ class C4XGate(SingletonControlledGate):
952
+ """The 4-qubit controlled X gate.
953
+
954
+ This implementation is based on Page 21, Lemma 7.5, of [1], with the use
955
+ of the relative phase version of c3x, the rc3x [2].
956
+
957
+ References:
958
+ 1. Barenco et al., 1995. https://arxiv.org/pdf/quant-ph/9503016.pdf
959
+ 2. Maslov, 2015. https://arxiv.org/abs/1508.03273
960
+ """
961
+
962
+ def __init__(
963
+ self,
964
+ label: Optional[str] = None,
965
+ ctrl_state: Optional[Union[str, int]] = None,
966
+ *,
967
+ duration=None,
968
+ unit="dt",
969
+ _base_label=None,
970
+ ):
971
+ """Create a new 4-qubit controlled X gate."""
972
+ if unit is None:
973
+ unit = "dt"
974
+ super().__init__(
975
+ "mcx",
976
+ 5,
977
+ [],
978
+ num_ctrl_qubits=4,
979
+ label=label,
980
+ ctrl_state=ctrl_state,
981
+ base_gate=XGate(label=_base_label),
982
+ duration=duration,
983
+ unit=unit,
984
+ )
985
+
986
+ _singleton_lookup_key = stdlib_singleton_key(num_ctrl_qubits=4)
987
+
988
+ # seems like open controls not happening?
989
+ def _define(self):
990
+ """
991
+ gate c3sqrtx a,b,c,d
992
+ {
993
+ h d; cu1(pi/8) a,d; h d;
994
+ cx a,b;
995
+ h d; cu1(-pi/8) b,d; h d;
996
+ cx a,b;
997
+ h d; cu1(pi/8) b,d; h d;
998
+ cx b,c;
999
+ h d; cu1(-pi/8) c,d; h d;
1000
+ cx a,c;
1001
+ h d; cu1(pi/8) c,d; h d;
1002
+ cx b,c;
1003
+ h d; cu1(-pi/8) c,d; h d;
1004
+ cx a,c;
1005
+ h d; cu1(pi/8) c,d; h d;
1006
+ }
1007
+ gate c4x a,b,c,d,e
1008
+ {
1009
+ h e; cu1(pi/2) d,e; h e;
1010
+ rc3x a,b,c,d;
1011
+ h e; cu1(-pi/2) d,e; h e;
1012
+ rc3x a,b,c,d;
1013
+ c3sqrtx a,b,c,e;
1014
+ }
1015
+ """
1016
+ # pylint: disable=cyclic-import
1017
+ from qiskit.circuit.quantumcircuit import QuantumCircuit
1018
+ from .u1 import CU1Gate
1019
+ from .h import HGate
1020
+
1021
+ q = QuantumRegister(5, name="q")
1022
+ qc = QuantumCircuit(q, name=self.name)
1023
+ rules = [
1024
+ (HGate(), [q[4]], []),
1025
+ (CU1Gate(numpy.pi / 2), [q[3], q[4]], []),
1026
+ (HGate(), [q[4]], []),
1027
+ (RC3XGate(), [q[0], q[1], q[2], q[3]], []),
1028
+ (HGate(), [q[4]], []),
1029
+ (CU1Gate(-numpy.pi / 2), [q[3], q[4]], []),
1030
+ (HGate(), [q[4]], []),
1031
+ (RC3XGate().inverse(), [q[0], q[1], q[2], q[3]], []),
1032
+ (C3SXGate(), [q[0], q[1], q[2], q[4]], []),
1033
+ ]
1034
+ for instr, qargs, cargs in rules:
1035
+ qc._append(instr, qargs, cargs)
1036
+
1037
+ self.definition = qc
1038
+
1039
+ def control(
1040
+ self,
1041
+ num_ctrl_qubits: int = 1,
1042
+ label: Optional[str] = None,
1043
+ ctrl_state: Optional[Union[str, int]] = None,
1044
+ annotated: bool = False,
1045
+ ):
1046
+ """Controlled version of this gate.
1047
+
1048
+ Args:
1049
+ num_ctrl_qubits: number of control qubits.
1050
+ label: An optional label for the gate [Default: ``None``]
1051
+ ctrl_state: control state expressed as integer,
1052
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
1053
+ annotated: indicates whether the controlled gate should be implemented
1054
+ as an annotated gate.
1055
+
1056
+ Returns:
1057
+ ControlledGate: controlled version of this gate.
1058
+ """
1059
+ if not annotated:
1060
+ ctrl_state = _ctrl_state_to_int(ctrl_state, num_ctrl_qubits)
1061
+ new_ctrl_state = (self.ctrl_state << num_ctrl_qubits) | ctrl_state
1062
+ gate = MCXGate(
1063
+ num_ctrl_qubits=num_ctrl_qubits + 4,
1064
+ label=label,
1065
+ ctrl_state=new_ctrl_state,
1066
+ _base_label=self.label,
1067
+ )
1068
+ else:
1069
+ gate = super().control(
1070
+ num_ctrl_qubits=num_ctrl_qubits,
1071
+ label=label,
1072
+ ctrl_state=ctrl_state,
1073
+ annotated=annotated,
1074
+ )
1075
+ return gate
1076
+
1077
+ def inverse(self, annotated: bool = False):
1078
+ """Invert this gate. The C4X is its own inverse.
1079
+
1080
+ Args:
1081
+ annotated: when set to ``True``, this is typically used to return an
1082
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
1083
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
1084
+ is self-inverse.
1085
+
1086
+ Returns:
1087
+ C4XGate: inverse gate (self-inverse).
1088
+ """
1089
+ return C4XGate(ctrl_state=self.ctrl_state)
1090
+
1091
+ def __eq__(self, other):
1092
+ return isinstance(other, C4XGate) and self.ctrl_state == other.ctrl_state
1093
+
1094
+
1095
+ class MCXGate(ControlledGate):
1096
+ """The general, multi-controlled X gate.
1097
+
1098
+ Can be applied to a :class:`~qiskit.circuit.QuantumCircuit`
1099
+ with the :meth:`~qiskit.circuit.QuantumCircuit.mcx` method.
1100
+ """
1101
+
1102
+ def __new__(
1103
+ cls,
1104
+ num_ctrl_qubits: Optional[int] = None,
1105
+ label: Optional[str] = None,
1106
+ ctrl_state: Optional[Union[str, int]] = None,
1107
+ *,
1108
+ duration=None,
1109
+ unit="dt",
1110
+ _base_label=None,
1111
+ ):
1112
+ """Create a new MCX instance.
1113
+
1114
+ Depending on the number of controls and which mode of the MCX, this creates an
1115
+ explicit CX, CCX, C3X or C4X instance or a generic MCX gate.
1116
+ """
1117
+ # The CXGate and CCXGate will be implemented for all modes of the MCX, and
1118
+ # the C3XGate and C4XGate are handled in the gate definition.
1119
+ explicit: dict[int, Type[ControlledGate]] = {1: CXGate, 2: CCXGate}
1120
+ gate_class = explicit.get(num_ctrl_qubits, None)
1121
+ if gate_class is not None:
1122
+ gate = gate_class.__new__(
1123
+ gate_class, label=label, ctrl_state=ctrl_state, _base_label=_base_label
1124
+ )
1125
+ # if __new__ does not return the same type as cls, init is not called
1126
+ gate.__init__(
1127
+ label=label,
1128
+ ctrl_state=ctrl_state,
1129
+ _base_label=_base_label,
1130
+ duration=duration,
1131
+ unit=unit,
1132
+ )
1133
+ return gate
1134
+ return super().__new__(cls)
1135
+
1136
+ def __init__(
1137
+ self,
1138
+ num_ctrl_qubits: int,
1139
+ label: Optional[str] = None,
1140
+ ctrl_state: Optional[Union[str, int]] = None,
1141
+ *,
1142
+ duration=None,
1143
+ unit="dt",
1144
+ _name="mcx",
1145
+ _base_label=None,
1146
+ ):
1147
+ """Create new MCX gate."""
1148
+ num_ancilla_qubits = self.__class__.get_num_ancilla_qubits(num_ctrl_qubits)
1149
+ super().__init__(
1150
+ _name,
1151
+ num_ctrl_qubits + 1 + num_ancilla_qubits,
1152
+ [],
1153
+ num_ctrl_qubits=num_ctrl_qubits,
1154
+ label=label,
1155
+ ctrl_state=ctrl_state,
1156
+ base_gate=XGate(label=_base_label),
1157
+ )
1158
+
1159
+ def inverse(self, annotated: bool = False):
1160
+ """Invert this gate. The MCX is its own inverse.
1161
+
1162
+ Args:
1163
+ annotated: when set to ``True``, this is typically used to return an
1164
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
1165
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
1166
+ is self-inverse.
1167
+
1168
+ Returns:
1169
+ MCXGate: inverse gate (self-inverse).
1170
+ """
1171
+ return MCXGate(num_ctrl_qubits=self.num_ctrl_qubits, ctrl_state=self.ctrl_state)
1172
+
1173
+ @staticmethod
1174
+ @deprecate_func(
1175
+ additional_msg=(
1176
+ "For an MCXGate it is no longer possible to know the number of ancilla qubits "
1177
+ "that would be eventually used by the transpiler when the gate is created. "
1178
+ "Instead, it is recommended to use MCXGate and let HighLevelSynthesis choose "
1179
+ "the best synthesis method depending on the number of ancilla qubits available. "
1180
+ "However, if a specific synthesis method using a specific number of ancilla "
1181
+ "qubits is require, one can create a custom gate by calling the corresponding "
1182
+ "synthesis function directly."
1183
+ ),
1184
+ since="1.3",
1185
+ pending=True,
1186
+ )
1187
+ def get_num_ancilla_qubits(num_ctrl_qubits: int, mode: str = "noancilla") -> int:
1188
+ """Get the number of required ancilla qubits without instantiating the class.
1189
+
1190
+ This staticmethod might be necessary to check the number of ancillas before
1191
+ creating the gate, or to use the number of ancillas in the initialization.
1192
+ """
1193
+ if mode == "noancilla":
1194
+ return 0
1195
+ if mode in ["recursion", "advanced"]:
1196
+ return int(num_ctrl_qubits > 4)
1197
+ if mode[:7] == "v-chain" or mode[:5] == "basic":
1198
+ return max(0, num_ctrl_qubits - 2)
1199
+ raise AttributeError(f"Unsupported mode ({mode}) specified!")
1200
+
1201
+ def _define(self):
1202
+ """This definition is based on MCPhaseGate implementation."""
1203
+ # pylint: disable=cyclic-import
1204
+ from qiskit.synthesis.multi_controlled import synth_mcx_noaux_v24
1205
+
1206
+ qc = synth_mcx_noaux_v24(self.num_ctrl_qubits)
1207
+ self.definition = qc
1208
+
1209
+ @property
1210
+ def num_ancilla_qubits(self):
1211
+ """The number of ancilla qubits."""
1212
+ return self.__class__.get_num_ancilla_qubits(self.num_ctrl_qubits)
1213
+
1214
+ def control(
1215
+ self,
1216
+ num_ctrl_qubits: int = 1,
1217
+ label: Optional[str] = None,
1218
+ ctrl_state: Optional[Union[str, int]] = None,
1219
+ annotated: bool = False,
1220
+ ):
1221
+ """Return a multi-controlled-X gate with more control lines.
1222
+
1223
+ Args:
1224
+ num_ctrl_qubits: number of control qubits.
1225
+ label: An optional label for the gate [Default: ``None``]
1226
+ ctrl_state: control state expressed as integer,
1227
+ string (e.g. ``'110'``), or ``None``. If ``None``, use all 1s.
1228
+ annotated: indicates whether the controlled gate should be implemented
1229
+ as an annotated gate.
1230
+
1231
+ Returns:
1232
+ ControlledGate: controlled version of this gate.
1233
+ """
1234
+ if not annotated and ctrl_state is None:
1235
+ # use __class__ so this works for derived classes
1236
+ gate = self.__class__(
1237
+ self.num_ctrl_qubits + num_ctrl_qubits,
1238
+ label=label,
1239
+ ctrl_state=ctrl_state,
1240
+ _base_label=self.label,
1241
+ )
1242
+ else:
1243
+ gate = super().control(num_ctrl_qubits, label=label, ctrl_state=ctrl_state)
1244
+ return gate
1245
+
1246
+
1247
+ class MCXGrayCode(MCXGate):
1248
+ r"""Implement the multi-controlled X gate using the Gray code.
1249
+
1250
+ This delegates the implementation to the MCU1 gate, since :math:`X = H \cdot U1(\pi) \cdot H`.
1251
+ """
1252
+
1253
+ def __new__(
1254
+ cls,
1255
+ num_ctrl_qubits: Optional[int] = None,
1256
+ label: Optional[str] = None,
1257
+ ctrl_state: Optional[Union[str, int]] = None,
1258
+ *,
1259
+ duration=None,
1260
+ unit="dt",
1261
+ _base_label=None,
1262
+ ):
1263
+ """Create a new MCXGrayCode instance"""
1264
+ # if 1 to 4 control qubits, create explicit gates
1265
+ explicit = {1: CXGate, 2: CCXGate, 3: C3XGate, 4: C4XGate}
1266
+ gate_class = explicit.get(num_ctrl_qubits, None)
1267
+ if gate_class is not None:
1268
+ gate = gate_class.__new__(
1269
+ gate_class,
1270
+ label=label,
1271
+ ctrl_state=ctrl_state,
1272
+ _base_label=_base_label,
1273
+ duration=duration,
1274
+ unit=unit,
1275
+ )
1276
+ # if __new__ does not return the same type as cls, init is not called
1277
+ gate.__init__(
1278
+ label=label,
1279
+ ctrl_state=ctrl_state,
1280
+ duration=duration,
1281
+ unit=unit,
1282
+ )
1283
+ return gate
1284
+ return super().__new__(cls)
1285
+
1286
+ @deprecate_func(
1287
+ additional_msg=(
1288
+ "It is recommended to use MCXGate and let HighLevelSynthesis choose "
1289
+ "the best synthesis method depending on the number of ancilla qubits available. "
1290
+ "If this specific synthesis method is required, one can specify it using the "
1291
+ "high-level-synthesis plugin `gray_code` for MCX gates, or, alternatively, "
1292
+ "one can use synth_mcx_gray_code to construct the gate directly."
1293
+ ),
1294
+ since="1.3",
1295
+ pending=True,
1296
+ )
1297
+ def __init__(
1298
+ self,
1299
+ num_ctrl_qubits: int,
1300
+ label: Optional[str] = None,
1301
+ ctrl_state: Optional[Union[str, int]] = None,
1302
+ ):
1303
+ super().__init__(num_ctrl_qubits, label=label, ctrl_state=ctrl_state, _name="mcx_gray")
1304
+
1305
+ def inverse(self, annotated: bool = False):
1306
+ """Invert this gate. The MCX is its own inverse.
1307
+
1308
+ Args:
1309
+ annotated: when set to ``True``, this is typically used to return an
1310
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
1311
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
1312
+ is self-inverse.
1313
+
1314
+ Returns:
1315
+ MCXGrayCode: inverse gate (self-inverse).
1316
+ """
1317
+ return MCXGrayCode(num_ctrl_qubits=self.num_ctrl_qubits, ctrl_state=self.ctrl_state)
1318
+
1319
+ def _define(self):
1320
+ """Define the MCX gate using the Gray code."""
1321
+ # pylint: disable=cyclic-import
1322
+ from qiskit.synthesis.multi_controlled import synth_mcx_gray_code
1323
+
1324
+ qc = synth_mcx_gray_code(self.num_ctrl_qubits)
1325
+ self.definition = qc
1326
+
1327
+
1328
+ class MCXRecursive(MCXGate):
1329
+ """Implement the multi-controlled X gate using recursion.
1330
+
1331
+ Using a single clean ancilla qubit, the multi-controlled X gate is split into
1332
+ four sub-registers, each one of them uses the V-chain method.
1333
+
1334
+ The method is based on Lemma 9 of [2], first shown in Lemma 7.3 of [1].
1335
+
1336
+ References:
1337
+ 1. Barenco et al., 1995. https://arxiv.org/pdf/quant-ph/9503016.pdf
1338
+ 2. Iten et al., 2015. https://arxiv.org/abs/1501.06911
1339
+ """
1340
+
1341
+ @deprecate_func(
1342
+ additional_msg=(
1343
+ "It is recommended to use MCXGate and let HighLevelSynthesis choose "
1344
+ "the best synthesis method depending on the number of ancilla qubits available. "
1345
+ "If this specific synthesis method is required, one can specify it using the "
1346
+ "high-level-synthesis plugin '1_clean_b95' for MCX gates, or, alternatively, "
1347
+ "one can use synth_mcx_1_clean to construct the gate directly."
1348
+ ),
1349
+ since="1.3",
1350
+ pending=True,
1351
+ )
1352
+ def __init__(
1353
+ self,
1354
+ num_ctrl_qubits: int,
1355
+ label: Optional[str] = None,
1356
+ ctrl_state: Optional[Union[str, int]] = None,
1357
+ *,
1358
+ duration=None,
1359
+ unit="dt",
1360
+ _base_label=None,
1361
+ ):
1362
+ super().__init__(
1363
+ num_ctrl_qubits,
1364
+ label=label,
1365
+ ctrl_state=ctrl_state,
1366
+ _name="mcx_recursive",
1367
+ duration=duration,
1368
+ unit=unit,
1369
+ _base_label=None,
1370
+ )
1371
+
1372
+ @staticmethod
1373
+ def get_num_ancilla_qubits(num_ctrl_qubits: int, mode: str = "recursion"):
1374
+ """Get the number of required ancilla qubits."""
1375
+ return MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode)
1376
+
1377
+ def inverse(self, annotated: bool = False):
1378
+ """Invert this gate. The MCX is its own inverse.
1379
+
1380
+ Args:
1381
+ annotated: when set to ``True``, this is typically used to return an
1382
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
1383
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
1384
+ is self-inverse.
1385
+
1386
+ Returns:
1387
+ MCXRecursive: inverse gate (self-inverse).
1388
+ """
1389
+ return MCXRecursive(num_ctrl_qubits=self.num_ctrl_qubits, ctrl_state=self.ctrl_state)
1390
+
1391
+ def _define(self):
1392
+ """Define the MCX gate using recursion."""
1393
+
1394
+ # pylint: disable=cyclic-import
1395
+ from qiskit.synthesis.multi_controlled import synth_mcx_1_clean_b95
1396
+
1397
+ qc = synth_mcx_1_clean_b95(self.num_ctrl_qubits)
1398
+ self.definition = qc
1399
+
1400
+
1401
+ class MCXVChain(MCXGate):
1402
+ """Implement the multi-controlled X gate using a V-chain of CX gates."""
1403
+
1404
+ def __new__(
1405
+ cls,
1406
+ num_ctrl_qubits: Optional[int] = None,
1407
+ dirty_ancillas: bool = False, # pylint: disable=unused-argument
1408
+ label: Optional[str] = None,
1409
+ ctrl_state: Optional[Union[str, int]] = None,
1410
+ *,
1411
+ duration=None,
1412
+ unit="dt",
1413
+ _base_label=None,
1414
+ relative_phase: bool = False, # pylint: disable=unused-argument
1415
+ action_only: bool = False, # pylint: disable=unused-argument
1416
+ ):
1417
+ """Create a new MCX instance.
1418
+
1419
+ This must be defined anew to include the additional argument ``dirty_ancillas``.
1420
+ """
1421
+ return super().__new__(
1422
+ cls,
1423
+ num_ctrl_qubits,
1424
+ label=label,
1425
+ ctrl_state=ctrl_state,
1426
+ _base_label=_base_label,
1427
+ duration=duration,
1428
+ unit=unit,
1429
+ )
1430
+
1431
+ @deprecate_func(
1432
+ additional_msg=(
1433
+ "It is recommended to use MCXGate and let HighLevelSynthesis choose "
1434
+ "the best synthesis method depending on the number of ancilla qubits available. "
1435
+ "If this specific synthesis method is required, one can specify it using the "
1436
+ "high-level-synthesis plugins `n_clean_m15` (using clean ancillas) or "
1437
+ "`n_dirty_i15` (using dirty ancillas) for MCX gates. Alternatively, one can "
1438
+ "use synth_mcx_n_dirty_i15 and synth_mcx_n_clean_m15 to construct the gate directly."
1439
+ ),
1440
+ since="1.3",
1441
+ pending=True,
1442
+ )
1443
+ def __init__(
1444
+ self,
1445
+ num_ctrl_qubits: int,
1446
+ dirty_ancillas: bool = False,
1447
+ label: Optional[str] = None,
1448
+ ctrl_state: Optional[Union[str, int]] = None,
1449
+ *,
1450
+ duration=None,
1451
+ unit="dt",
1452
+ _base_label=None,
1453
+ relative_phase: bool = False,
1454
+ action_only: bool = False,
1455
+ ):
1456
+ """
1457
+ Args:
1458
+ dirty_ancillas: when set to ``True``, the method applies an optimized multicontrolled-X gate
1459
+ up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8
1460
+ from arXiv:1501.06911, with at most 8*k - 6 CNOT gates.
1461
+ For k within the range {1, ..., ceil(n/2)}. And for n representing the total number of
1462
+ qubits.
1463
+ relative_phase: when set to ``True``, the method applies the optimized multicontrolled-X gate
1464
+ up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative
1465
+ phases of the ``action part`` cancel out with the phases of the ``reset part``.
1466
+
1467
+ action_only: when set to ``True``, the method applies only the action part of lemma 8
1468
+ from arXiv:1501.06911.
1469
+
1470
+ """
1471
+ super().__init__(
1472
+ num_ctrl_qubits,
1473
+ label=label,
1474
+ ctrl_state=ctrl_state,
1475
+ _name="mcx_vchain",
1476
+ _base_label=_base_label,
1477
+ duration=duration,
1478
+ unit=unit,
1479
+ )
1480
+ self._dirty_ancillas = dirty_ancillas
1481
+ self._relative_phase = relative_phase
1482
+ self._action_only = action_only
1483
+ super().__init__(num_ctrl_qubits, label=label, ctrl_state=ctrl_state, _name="mcx_vchain")
1484
+
1485
+ def inverse(self, annotated: bool = False):
1486
+ """Invert this gate. The MCX is its own inverse.
1487
+
1488
+ Args:
1489
+ annotated: when set to ``True``, this is typically used to return an
1490
+ :class:`.AnnotatedOperation` with an inverse modifier set instead of a concrete
1491
+ :class:`.Gate`. However, for this class this argument is ignored as this gate
1492
+ is self-inverse.
1493
+
1494
+ Returns:
1495
+ MCXVChain: inverse gate (self-inverse).
1496
+ """
1497
+ return MCXVChain(
1498
+ num_ctrl_qubits=self.num_ctrl_qubits,
1499
+ dirty_ancillas=self._dirty_ancillas,
1500
+ ctrl_state=self.ctrl_state,
1501
+ relative_phase=self._relative_phase,
1502
+ action_only=self._action_only,
1503
+ )
1504
+
1505
+ @staticmethod
1506
+ def get_num_ancilla_qubits(num_ctrl_qubits: int, mode: str = "v-chain"):
1507
+ """Get the number of required ancilla qubits."""
1508
+ return MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode)
1509
+
1510
+ def _define(self):
1511
+ """Define the MCX gate using a V-chain of CX gates."""
1512
+
1513
+ if self._dirty_ancillas:
1514
+ # pylint: disable=cyclic-import
1515
+ from qiskit.synthesis.multi_controlled import synth_mcx_n_dirty_i15
1516
+
1517
+ qc = synth_mcx_n_dirty_i15(
1518
+ self.num_ctrl_qubits,
1519
+ self._relative_phase,
1520
+ self._action_only,
1521
+ )
1522
+
1523
+ else: # use clean ancillas
1524
+ # pylint: disable=cyclic-import
1525
+ from qiskit.synthesis.multi_controlled import synth_mcx_n_clean_m15
1526
+
1527
+ qc = synth_mcx_n_clean_m15(self.num_ctrl_qubits)
1528
+
1529
+ self.definition = qc