HamiltonianGate
class qiskit.circuit.library.HamiltonianGate(data, time, label=None)
Bases: Gate
Class for representing evolution by a Hamiltonian operator as a gate.
This gate resolves to a UnitaryGate as , which can be decomposed into basis gates if it is 2 qubits or less, or simulated directly in Aer for more qubits.
Parameters
- data (np.ndarray | Gate | BaseOperator) – A hermitian operator.
- time (float |ParameterExpression) – Time evolution parameter.
- label (str | None) – Unitary name for backend [Default: None].
Raises
ValueError – if input data is not an N-qubit unitary operator.
Attributes
base_class
Get the base class of this instruction. This is guaranteed to be in the inheritance tree of self.
The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for _all_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioural perspective. In particular, you should not override base_class if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrised gate with a particular set of parameters for the purposes of distinguishing it in a Target from the full parametrised gate.
This is often exactly equivalent to type(obj), except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example:
>>> isinstance(XGate(), XGate)
True
>>> type(XGate()) is XGate
False
>>> XGate().base_class is XGate
TrueIn general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that Instruction.name should be a more suitable discriminator in most situations.
condition
The classical condition on the instruction.
condition_bits
Get Clbits in condition.
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
definition
Return definition in terms of other basic gates.
duration
Get the duration.
label
Return instruction label
mutable
Is this instance is a mutable unique instance or not.
If this attribute is False the gate instance is a shared singleton and is not mutable.
name
Return the name.
num_clbits
Return the number of clbits.
num_qubits
Return the number of qubits.
params
return instruction params.
unit
Get the time unit of duration.
Methods
adjoint
adjoint()
Return the adjoint of the unitary.
conjugate
conjugate()
Return the conjugate of the Hamiltonian.
inverse
inverse()
Return the adjoint of the unitary.
qasm
qasm()
Raise an error, as QASM is not defined for the HamiltonianGate.
The method qiskit.circuit.library.hamiltonian_gate.HamiltonianGate.qasm() is deprecated as of qiskit-terra 0.25.0. It will be removed in the Qiskit 1.0 release.
transpose
transpose()
Return the transpose of the Hamiltonian.
validate_parameter
validate_parameter(parameter)
Hamiltonian parameter has to be an ndarray, operator or float.