Skip to main content
This is a list of the classical types that are built-in in Qmod. For more information regarding classical types see: classical types. Members:
NameDescription
PauliEnumeration for the Pauli matrices used in quantum computing.
PauliTermA term in a Hamiltonian, represented as a product of single-qubit Pauli matrices.
IndexedPauliA single-qubit Pauli matrix on a specific qubit given by its index.
SparsePauliTermA term in the Hamiltonian, represented as a sparse product of single-qubit Pauli matrices.
SparsePauliOpRepresents a collection of sparse Pauli operators.

​
Pauli

Enumeration for the Pauli matrices used in quantum computing. Represents the four Pauli matrices used in quantum mechanics: Identity (I), X, Y, and Z operators. The Pauli matrices are defined as: I=(1001)I = \begin{pmatrix} 1 & 0 \\ 0 & 1 \end{pmatrix} X=(0110)X = \begin{pmatrix} 0 & 1 \\ 1 & 0 \end{pmatrix} Y=(0−ii0)Y = \begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix} Z=(100−1)Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 \end{pmatrix} Attributes:
NameTypeDescription
I
X
Y
Z

​
I

I = '0'

​
X

X = '1'

​
Y

Y = '2'

​
Z

Z = '3'

​
PauliTerm

A term in a Hamiltonian, represented as a product of single-qubit Pauli matrices. Attributes:
NameTypeDescription
pauliCArray[Pauli]The list of the chosen Pauli operators in the term, corresponds to a product of them.
coefficientCRealThe coefficient of the term (floating number).

​
pauli

pauli: CArray[Pauli]

​
coefficient

coefficient: CReal

​
IndexedPauli

A single-qubit Pauli matrix on a specific qubit given by its index. Attributes:
NameTypeDescription
pauliPauliThe Pauli operator.
indexCIntThe index of the qubit being operated on.

​
pauli

pauli: Pauli

​
index

index: CInt

​
SparsePauliTerm

A term in the Hamiltonian, represented as a sparse product of single-qubit Pauli matrices. Attributes: paulis (CArray[IndexedPauli]): The list of chosen sparse Pauli operators in the term corresponds to a product of them. (See IndexedPauli) coefficient (CReal): The coefficient of the term (floating number). Methods:
NameDescription
cmp_paulis

​
paulis

paulis: CArray[IndexedPauli]

​
coefficient

coefficient: CReal

​
SparsePauliOp

Represents a collection of sparse Pauli operators. Attributes:
NameTypeDescription
termsCArray[SparsePauliTerm]The list of chosen sparse Pauli terms, corresponds to a product of them. (See: SparsePauliTerm)
num_qubitsCIntThe number of qubits in the Hamiltonian.

​
terms

terms: list[SparsePauliTerm]

​
num_qubits

num_qubits: int options: show_source: false show_if_no_docstring: false options: show_source: false show_if_no_docstring: false Members:
NameDescription
SparsePauliOpRepresents a collection of sparse Pauli operators.
PauliEnumeration for the Pauli matrices used in quantum computing.

​
SparsePauliOp

Represents a collection of sparse Pauli operators. Attributes:
NameTypeDescription
termsCArray[SparsePauliTerm]The list of chosen sparse Pauli terms, corresponds to a product of them. (See: SparsePauliTerm)
num_qubitsCIntThe number of qubits in the Hamiltonian.

​
terms

terms: list[SparsePauliTerm]

​
num_qubits

num_qubits: int

​
Pauli

Enumeration for the Pauli matrices used in quantum computing. Represents the four Pauli matrices used in quantum mechanics: Identity (I), X, Y, and Z operators. The Pauli matrices are defined as: I=(1001)I = \begin{pmatrix} 1 & 0 \\ 0 & 1 \end{pmatrix} X=(0110)X = \begin{pmatrix} 0 & 1 \\ 1 & 0 \end{pmatrix} Y=(0−ii0)Y = \begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix} Z=(100−1)Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 \end{pmatrix} Attributes:
NameTypeDescription
I
X
Y
Z

​
I

I = '0'

​
X

X = '1'

​
Y

Y = '2'

​
Z

Z = '3'
options: show_source: false show_if_no_docstring: false