fix time series inconsistency between continuous and discrete time simulations #295
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.
As pointed out in issue #239, there is an inconsistency between the way that continuous time simulations and discrete time simulations return their outputs for single output systems. In continuous time, the code follows the documentation and the following works:
However, in discrete time simulations the returned value for
y
had shape(1, len(t))
, which meant that you had to do the following for discrete time systems:The problem was that for continuous time simulations
forced_response()
(the ultimate function that gets called) had annp.squeeze()
at the end but this wasn't present for discrete time simulations. This PR fixes that problem so that the behavior is consistent, resolving the bug in issue #239.Other small changes:
Added unit tests that catch the original bug
Added a
squeeze
keyword that controls whether this behavior is implemented (default =True
).Did some PEP8 cleanup on
timeresponse.py
Note that this may make some existing code break since discrete time simulations can now return an output that is a 1D array instead of 2D. The fix is either to remove the output index (
y[0]
becomesy
) or set thesqueeze
keyword toFalse
).