PauliStringSum

Base class: Object

Object that represents a sum of Pauli strings.

Represents a sum $\sum_n c_n P_n$ of Pauli strings $P_n$ and a complex coefficients $c_n$ where each term in the sum is a PauliString.

Constructors

PauliStringSum(const PauliString term) -> PauliStringSum

Constructs a PauliStringSum from one PauliString.

Parameters

• term: The initial PauliString.

Returns

A new PauliStringSum containing the supplied term.

PauliStringSum(integer num_spins) -> PauliStringSum

Constructs an empty PauliStringSum.

Parameters

• num_spins: The number of spins in the system, from 1 through 256.

Returns

An empty PauliStringSum for the requested system size.

PauliStringSum(const PauliStringSum other) -> PauliStringSum

Constructs a PauliStringSum by cloning an existing sum.

Parameters

• other: The PauliStringSum to copy.

Returns

A new copy of the PauliStringSum.

Members

Name	Description
adjoint	Adjoints a PauliStringSum in place.
adjointed	Returns the adjoint of a PauliStringSum.
append	Appends another PauliStringSum.
commutator	Calculates the commutator of two PauliStringSums.
display	Displays terms from a PauliStringSum.
expval	Calculates the expectation value of a PauliStringSum.
multiplied	Returns the product of two PauliStringSums.
multiply	Right-multiplies a PauliStringSum by a PauliString in place.
num_spins	Returns the number of spins represented by a PauliStringSum.
pauli_rotate	Conjugates $S$ in place by $U=e^{i\theta Q}$, producing $U^\dagger S U$.‌
pauli_rotated	Returns $U^\dagger S U$ for $U=e^{i\theta Q}$.‌
prune	Removes terms below a coefficient tolerance or above a maximum weight.
size	Returns the number of terms in a PauliStringSum.
transform_coefficients	Transforms every coefficient in a PauliStringSum.
weight_distribution	Returns the weight distribution of a PauliStringSum.