Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

TaperedPauliSumOp

TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)

GitHub(opens in a new tab)

Bases: qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp

Class for PauliSumOp after tapering

Parameters

  • primitive (SparsePauliOp) – The SparsePauliOp which defines the behavior of the underlying function.
  • z2_symmetries (Z2Symmetries) – Z2 symmetries which the Operator has.
  • coeff (Union[complex, ParameterExpression]) – A coefficient multiplying the primitive.

Raises

TypeError – invalid parameters.


Methods Defined Here

assign_parameters

TaperedPauliSumOp.assign_parameters(param_dict)

Binds scalar values to any Terra Parameters in the coefficients or primitives of the Operator, or substitutes one Parameter for another. This method differs from Terra’s assign_parameters in that it also supports lists of values to assign for a give Parameter, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an OpList. If lists of parameterizations are used, every Parameter in the param_dict must have the same length list of parameterizations.

Parameters

param_dict (dict) – The dictionary of Parameters to replace, and values or lists of values by which to replace them.

Return type

OperatorBase

Returns

The OperatorBase with the Parameters in self replaced by the values or Parameters in param_dict. If param_dict contains parameterization lists, this OperatorBase is an OpList.


Attributes

INDENTATION

= '  '

coeff

The scalar coefficient multiplying the Operator.

Return type

Union[complex, ParameterExpression]

Returns

The coefficient.

coeffs

Return the Pauli coefficients.

grouping_type

Type of Grouping

Type

Returns

Return type

str

instance_id

Return the unique instance id.

Return type

int

num_qubits

Return type

int

parameters

primitive

qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp

The primitive defining the underlying function of the Operator.

Return type

Union[QuantumCircuit, Operator, Pauli, SparsePauliOp, OperatorBase]

Returns

The primitive object.

settings

Return operator settings.

Return type

Dict

z2_symmetries

Z2 symmetries which the Operator has.

Return type

Z2Symmetries

Returns

The Z2 Symmetries.

Was this page helpful?
Report a bug or request content on GitHub.