Skip to content

Commit

Permalink
Add missing docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
fdmalone committed Jul 2, 2024
1 parent 714cf13 commit 2de3d0f
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions recirq/qcqmc/trial_wf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,8 @@
import openfermion as of
import scipy.sparse

from recirq.qcqmc import (
bitstrings,
config,
converters,
data,
fermion_mode,
hamiltonian,
layer_spec,
qubit_maps,
)
from recirq.qcqmc import (bitstrings, config, converters, data, fermion_mode,
hamiltonian, layer_spec, qubit_maps)


@attrs.frozen
Expand Down Expand Up @@ -225,6 +217,12 @@ def get_rotated_hamiltonians(
) -> Tuple[fqe.hamiltonians.hamiltonian.Hamiltonian, float, scipy.sparse.csc_matrix]:
"""A helper method that gets the hamiltonians in the basis of the trial_wf.
Args:
hamiltonian_data: A specification of the hamiltonian.
one_body_basis_change_mat: A change of basis matrix.
mode_qubit_map: A mapping from fermion modes to cirq Qids.
ordered_qubits: A sequence of cirq Qids which specifies the correct ordering of the qubits.
Returns:
The hamiltonian in FQE form, minus a constant energy shift.
The constant part of the Hamiltonian missing from the FQE Hamiltonian.
Expand Down

0 comments on commit 2de3d0f

Please sign in to comment.