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