Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a bug in the
rotating_wave_approximation
function for whenmodel
is aLindbladModel
andreturn_signal_map=True
. The signature of the returned signal mapping function was inconsistent with the documentation, and has been fixed to restore consistency.Details and comments
For a
LindbladModel
the rwa signal mapping function must act on both the Hamiltonian signals as well as the dissipator signals. The documentation for therotating_wave_approximation
implies that the returned signal mapping function, in the case of aLindbladModel
, should have a single argument, corresponding to the structure of theLindbladModel.signals
property, which contains both the Hamiltonian and dissipator signals in a two-entry tuple.Currently, however, the signal mapping function returned by
rotating_wave_approximation
accepts the Hamiltonian and dissipator signals as two separate arguments, which is inconsistent. This PR fixes this to be consistent with the documentation.