z i7SrSSKJr SSKrSSKJr SSKJr SSK J r SSK J r SSK Jr S S KJrJrJr SSS jjr"S S \5rg)zVA generalized QAOA quantum circuit with a support of custom initial states and mixers.) annotationsN)ParameterVector)QuantumCircuit)QuantumRegister) SparsePauliOp) BaseOperator)EvolvedOperatorAnsatz_is_pauli_identityevolved_operator_ansatzc &URnUc%[U5nUR[U55 Uc5[R "[U5Vs/sH nSU/S4PM snU5nSS/n UR [X/UUU UUS9SS9$s snf)a-A generalized QAOA quantum circuit with a support of custom initial states and mixers. Examples: To define the QAOA ansatz we require a cost Hamiltonian, encoding the classical optimization problem: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit.quantum_info import SparsePauliOp from qiskit.circuit.library import qaoa_ansatz cost_operator = SparsePauliOp(["ZZII", "IIZZ", "ZIIZ"]) ansatz = qaoa_ansatz(cost_operator, reps=3, insert_barriers=True) ansatz.draw("mpl") Args: cost_operator: The operator representing the cost of the optimization problem, denoted as :math:`U(C, \gamma)` in [1]. reps: The integer determining the depth of the circuit, called :math:`p` in [1]. initial_state: An optional initial state to use, which defaults to a layer of Hadamard gates preparing the :math:`|+\rangle^{\otimes n}` state. If a custom mixer is chosen, this circuit should be set to prepare its ground state, to appropriately fulfill the annealing conditions. mixer_operator: An optional custom mixer, which defaults to global Pauli-:math:`X` rotations. This is denoted as :math:`U(B, \beta)` in [1]. If this is set, the ``initial_state`` might also require modification. insert_barriers: Whether to insert barriers in-between the cost and mixer operators. name: The name of the circuit. flatten: If ``True``, a flat circuit is returned instead of nesting it inside multiple layers of gate objects. Setting this to ``False`` is significantly less performant, especially for parameter binding, but can be desirable for a cleaner visualization. References: [1] Farhi et al., A Quantum Approximate Optimization Algorithm. `arXiv:1411.4028 `_ Xr γβ)repsinsert_barriersparameter_prefixnameflattenF)copy) num_qubitsrhrangerfrom_sparse_listcomposer ) cost_operatorr initial_statemixer_operatorrrrrirs d/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/circuit/library/n_local/qaoa_ansatz.py qaoa_ansatzr!!sb))J&z2 j)*&77$)*$5 6$5qcA3]$5 6  d|    ++-   !   7sBc^\rSrSrSrSSU4SjjjrSSU4Sjjjr\SSj5r\RSSj5r\SSj5r \S5r \ RSS j5r \SS j5r \ RSS j5r \SS j5r \ RSS j5r \S5r\RSSj5r\SSj5rU4SjrSrU=r$) QAOAAnsatzlzA generalized QAOA quantum circuit with a support of custom initial states and mixers. References: [1] Farhi et al., A Quantum Approximate Optimization Algorithm. `arXiv:1411.4028 `_ cn>[TU]X%US9 SUlX lX0lX@lSUlXlg)a Args: cost_operator (BaseOperator or OperatorBase, optional): The operator representing the cost of the optimization problem, denoted as :math:`U(C, \gamma)` in the original paper. Must be set either in the constructor or via property setter. reps (int): The integer parameter p, which determines the depth of the circuit, as specified in the original paper, default is 1. initial_state (QuantumCircuit, optional): An optional initial state to use. If `None` is passed then a set of Hadamard gates is applied as an initial state to all qubits. mixer_operator (BaseOperator or OperatorBase or QuantumCircuit, optional): An optional custom mixer to use instead of the global X-rotations, denoted as :math:`U(B, \beta)` in the original paper. Can be an operator or an optionally parameterized quantum circuit. name (str): A name of the circuit, default 'qaoa' flatten: Set this to ``True`` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you're using this circuit for anything besides visualization its **strongly** recommended to set this flag to ``True`` to avoid a large performance overhead for parameter binding. )rrrN)super__init___cost_operator_reps_initial_state_mixer_boundsr)selfrrrrrr __class__s r r'QAOAAnsatz.__init__usC@ dw?" 5B$ HL +c>Sn[TU]U5(dgURcSnU(a [S5eURb\URR UR :wa8SnU(a/[SURR SUR 35eUR b\UR R UR :wa8SnU(a/[SUR R SUR 35eU$)z,Check if the current configuration is valid.TFzIThe operator representing the cost of the optimization problem is not setz*The number of qubits of the initial state z: does not match the number of qubits of the cost operator z"The number of qubits of the mixer )r&_check_configurationr ValueErrorrrr)r-raise_on_failurevalidr.s r r2QAOAAnsatz._check_configurationsw+,<==    %E _    )d.@.@.K.Kt.^E @ASASA^A^@_AAE@QS    *t/B/B/M/MQUQ`Q`/`E 89L9L9W9W8XAAE@QS  r0cZURb UR$[UR[5(agSS[R -4nSn/n[ UR5(dX0RU/-- n[ UR5(dX0RU/-- nU$)aThe parameter bounds for the unbound parameters in the circuit. Returns: A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. Nr)NN) r, isinstancerrnppir rr)r- beta_bounds gamma_boundsboundss r parameter_boundsQAOAAnsatz.parameter_boundss << #<<  d))> : :!bee)n # :<!$"5"566 ii;-/ /F!$"4"455 ii<.0 0F r0cXlg)zGSet the parameter bounds. Args: bounds: The new parameter bounds. N)r,)r-r>s r r?r@s  r0c2URUR/$)zThe operators that are evolved in this circuit. Returns: List[Union[BaseOperator, OperatorBase, QuantumCircuit]]: The operators to be evolved (and circuits) in this ansatz. )rrr-s r operatorsQAOAAnsatz.operatorss""D$7$788r0cUR$)zReturns an operator representing the cost of the optimization problem. Returns: BaseOperator or OperatorBase: cost operator. )r(rCs r rQAOAAnsatz.cost_operators"""r0cdXl[URSS9/UlUR 5 g)zmSets cost operator. Args: cost_operator (BaseOperator or OperatorBase, optional): cost operator to set. q)rN)r(rrqregs _invalidate)r-rs r rrGs+,%dooC@A  r0cUR$)zHReturns the `reps` parameter, which determines the depth of the circuit.)r)rCs r rQAOAAnsatz.repsszzr0c0XlUR5 g)zSets the `reps` parameter.N)r)rK)r-rs r rrM s  r0cURb UR$URS:a;[UR5nUR[ UR55 U$g)z.Returns an optional initial state as a circuitNr)r*rrrrr-rs r rQAOAAnsatz.initial_statesX    *&& & ??Q *4??;M OOE$//2 3 r0c0XlUR5 g)zSets initial state.N)r*rKrPs r rrQ"s, r0cURb UR$URb\URRn[U5Vs/sHnSU-S-SX- S- --S4PM nn[R "U5nU$gs snf)zReturns an optional mixer operator expressed as an operator or a quantum circuit. Returns: BaseOperator or OperatorBase or QuantumCircuit, optional: mixer operator or circuit. NIrr )r+rrrr from_list)r-rleft mixer_termsmixers r rQAOAAnsatz.mixer_operator*s ;; ";;     )++66J SXXbRcRc$tc!C:+UR(ag[TU] 5 [UR5(aSOSn[ UR [5(aUR RnO[UR 5(aSOSn[SURU-5n[SURU-5n/n[UR5H;nURXFU-US-U-5 URX6U-US-U-5 M= UR[[UR U55SS9 g)z(If not already built, build the circuit.Nrr rrT)inplace) _is_builtr&_buildr rr9rrnum_parametersrrrextendassign_parametersdictzipordered_parameters)r-num_cost num_mixerbetasgammas reorderedrepr.s r r`QAOAAnsatz._buildUs >>  +4+=+=>>1A d))> : :++::I/0C0CDD!Idii)&;< tyy8';<  #C   V(NcAg5IJ K   U?cAg5JK L$ tC(?(?$KLVZ[r0)r,r(r*r+r)rrJ)Nr NNQAOAN)rintrQuantumCircuit | Nonerstrrz bool | None)T)r4boolreturnrr)rs.list[tuple[float | None, float | None]] | None)r>rtrsNone)rslist)rsru)rsro)rrorsru)rsrp)rrprsru)__name__ __module__ __qualname____firstlineno____doc__r'r2propertyr?setterrDrrrrrr`__static_attributes__ __classcell__)r.s@r r#r#lsr/3#++++- ++  ++++++Z  D899## [[   2.. \\r0r#)r NNFrnT)rrrrorrprzBaseOperator | Nonerrrrrqrrrrsr)r{ __future__rnumpyr:qiskit.circuit.parametervectorrqiskit.circuit.quantumcircuitrqiskit.circuitrqiskit.quantum_infor+qiskit.quantum_info.operators.base_operatorrr r r r!r#r0r rs]#:8*-D+/*.!HH H)H( H  H  HHHVC\&C\r0