Skip to content

Documentation update #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 24, 2020
Merged

Documentation update #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
802b47b
DOC: fix typos, equation numbering in doc/flatsys.rst
murrayrm Jan 5, 2020
7b9d1a9
small updates to statefbk.py docstrings
murrayrm Jan 18, 2020
4f49094
update setup.py contract info
murrayrm Jan 20, 2020
17c1840
small fixes to iosys docstrings (from samlaf)
murrayrm May 17, 2020
97c4a65
TRV: fix indentation in docstring
murrayrm Dec 22, 2020
3e6347f
update lqr() return type documentation (addresses #418)
murrayrm Dec 22, 2020
6ff59f0
Added 2D array/matrix note to all functions using _ssmatrix + numpydo…
murrayrm Dec 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion control/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,11 @@ class and functions. If flat is `False`, then matrices are
of the Numpy `matrix` class. Set `warn` to false to omit display of
the warning message.

Notes
-----
Prior to release 0.9.x, the default type for 2D arrays is the Numpy
`matrix` class. Starting in release 0.9.0, the default type for state
space operations is a 2D array.
"""
if flag and warn:
warnings.warn("Return type numpy.matrix is soon to be deprecated.",
Expand All @@ -179,4 +184,4 @@ def use_legacy_defaults(version):
third_digit = int(version[4])
use_numpy_matrix(True) # alternatively: set_defaults('statesp', use_numpy_matrix=True)
else:
raise ValueError('''version number not recognized. Possible values range from '0.1' to '0.8.4'.''')
raise ValueError('''version number not recognized. Possible values range from '0.1' to '0.8.4'.''')
2 changes: 1 addition & 1 deletion control/iosys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,7 +780,7 @@ def __init__(self, syslist, connections=[], inplist=[], outlist=[],

The InterconnectedSystem class is used to represent an input/output
system that consists of an interconnection between a set of subystems.
The outputs of each subsystem can be summed together to to provide
The outputs of each subsystem can be summed together to provide
inputs to other subsystems. The overall system inputs and outputs can
be any subset of subsystem inputs and outputs.

Expand Down
Loading