Skip to content

Commit

Permalink
Minor updates documentation Operators
Browse files Browse the repository at this point in the history
  • Loading branch information
renezander90 committed Dec 16, 2024
1 parent 0c5c8ad commit b1d7d59
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Methods
:toctree: generated/

FermionicOperator.dagger
FermionicOperator.hermitize
FermionicOperator.ground_state_energy
FermionicOperator.from_pyscf
FermionicOperator.from_openfermion
FermionicOperator.reduce
FermionicOperator.from_pyscf
FermionicOperator.get_measurement
FermionicOperator.ground_state_energy
FermionicOperator.hermitize
FermionicOperator.reduce
FermionicOperator.to_qubit_operator
FermionicOperator.trotterization
4 changes: 2 additions & 2 deletions src/qrisp/operators/fermionic/fermionic_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ def ground_state_energy(self):
Returns
-------
E : float
float
The ground state energy.
"""
Expand Down Expand Up @@ -674,7 +674,7 @@ def get_measurement(
Parameters
----------
qarg : QuantumVariable or list[Qubit]
qarg : :ref:`QuantumVariable` or list[Qubit]
The quantum argument to evaluate the Hamiltonian on.
mapping_type : str
The strategy on how to map the FermionicOperator to a QubitOperator. Default is ``jordan_wigner``
Expand Down
14 changes: 7 additions & 7 deletions src/qrisp/operators/qubit/qubit_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class QubitOperator(Hamiltonian):
& = (X_0X_1 + X_0Y_1 - Y_0X_1 + Y_0Y_1)/4
\end{align}
Recently a much more efficient method of simulating ``A`` and ``C`` `has
Recently, a much more efficient method of simulating ``A`` and ``C`` `has
been proposed by Kornell and Selinger <https://arxiv.org/abs/2310.12256>`_,
which avoids decomposing these Operators into Paulis strings
but instead simulates
Expand Down Expand Up @@ -547,12 +547,12 @@ def from_matrix(self, matrix):
Parameters
----------
matrix : numpy.ndarray or scipy.csr_matrix
matrix : numpy.ndarray or scipy.sparse.csr_matrix
The matrix.
Returns
-------
O : QubitOperator
QubitOperator
The operator represented by the matrix.
Expand Down Expand Up @@ -625,7 +625,7 @@ def to_sparse_matrix(self, factor_amount=None):
Returns
-------
M : scipy.sparse.csr_matrix
scipy.sparse.csr_matrix
The sparse matrix representing the operator.
"""
Expand Down Expand Up @@ -734,7 +734,7 @@ def to_pauli(self):
Returns
-------
QubitOperator
An operator that contains only Pauli-Factor.
An operator that contains only Pauli factors.
Examples
--------
Expand Down Expand Up @@ -768,7 +768,7 @@ def adjoint(self):
Examples
--------
We create a QubitOperator and inspect it' adjoint.
We create a QubitOperator and inspect its adjoint.
>>> from qrisp.operators import A,C,Z
>>> H = A(0)*C(1)*Z(2)
Expand Down Expand Up @@ -818,7 +818,7 @@ def ground_state_energy(self):
Returns
-------
E : float
float
The ground state energy.
"""
Expand Down

0 comments on commit b1d7d59

Please sign in to comment.