Skip to content

Commit

Permalink
Document the expand paratmer to propagators.
Browse files Browse the repository at this point in the history
  • Loading branch information
hodgestar committed Jun 23, 2021
1 parent 538435d commit a208b0b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion src/qutip_qip/circuit.py
Original file line number Diff line number Diff line change
Expand Up @@ -1235,8 +1235,20 @@ def adjacent_gates(self):

def propagators(self, expand=True):
"""
Propagator matrix calculator for N qubits returning the individual
Propagator matrix calculator returning the individual
steps as unitary matrices operating from left to right.
Parameters
----------
expand : bool, optional
Whether to expand the unitary matrices for the individual
steps to the full Hilbert space for N qubits.
Defaults to ``True``.
If ``False``, the unitary matrices will not be expanded and the
list of unitaries will need to be combined with the list of
gates in order to determine which qubits the unitaries should
act on.
Returns
-------
U_list : list
Expand Down

0 comments on commit a208b0b

Please sign in to comment.