8000 update docstrings and user documentation · python-control/python-control@77a75a6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 77a75a6

Browse files
murrayrmmurrayrm
committed
update docstrings and user documentation
1 parent aa106ba commit 77a75a6

File tree

6 files changed

+6
-19
lines changed

6 files changed

+6
-19
lines changed

‎control/config.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,6 @@ def use_matlab_defaults():
202202
The following conventions are used:
203203
* Bode plots plot gain in dB, phase in degrees, frequency in
204204
rad/sec, with grids
205-
* State space class and functions use Numpy matrix objects
206205
207206
Examples
208207
--------

‎control/iosys.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2227,8 +2227,6 @@ def ss(*args, **kwargs):
22272227
y[k] &= C x[k] + D u[k]
22282228
22292229
The matrices can be given as *array like* data types or strings.
2230-
Everything that the constructor of :class:`numpy.matrix` accepts is
2231-
permissible here too.
22322230
22332231
``ss(args, inputs=['u1', ..., 'up'], outputs=['y1', ..., 'yq'], states=['x1', ..., 'xn'])``
22342232
Create a system with named input, output, and state signals.

‎control/statesp.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -453,10 +453,6 @@ def _remove_useless_states(self):
453453
"""
454454

455455
# Search for useless states and get indices of these states.
456-
#
457-
# Note: shape from np.where depends on whether we are storing state
458-
# space objects as np.matrix or np.array. Code below will work
459-
# correctly in either case.
460456
ax1_A = np.where(~self.A.any(axis=1))[0]
461457
ax1_B = np.where(~self.B.any(axis=1))[0]
462458
ax0_A = np.where(~self.A.any(axis=0))[-1]
@@ -488,12 +484,11 @@ def __str__(self):
488484
return string
489485

490486
# represent to implement a re-loadable version
491-
# TODO: remove the conversion to array when matrix is no longer used
492487
def __repr__(self):
493488
"""Print state-space system in loadable form."""
494489
return "StateSpace({A}, {B}, {C}, {D}{dt})".format(
495-
A=asarray(self.A).__repr__(), B=asarray(self.B).__repr__(),
496-
C=asarray(self.C).__repr__(), D=asarray(self.D).__repr__(),
490+
A=self.A.__repr__(), B=self.B.__repr__(),
491+
C=self.C.__repr__(), D=self.D.__repr__(),
497492
dt=(isdtime(self, strict=True) and ", {}".format(self.dt)) or '')
498493

499494
def _latex_partitioned_stateless(self):

‎control/stochsys.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ def lqe(*args, **kwargs):
8787
8888
Returns
8989
-------
90-
L : 2D array (or matrix)
90+
L : 2D array
9191
Kalman estimator gain
92-
P : 2D array (or matrix)
92+
P : 2D array
9393
Solution to Riccati equation
9494
9595
.. math::
@@ -221,9 +221,9 @@ def dlqe(*args, **kwargs):
221221
222222
Returns
223223
-------
224-
L : 2D array (or matrix)
224+
L : 2D array
225225
Kalman estimator gain
226-
P : 2D array (or matrix)
226+
P : 2D array
227227
Solution to Riccati equation
228228
229229
.. math::

‎doc/control.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,5 @@ Utility functions and conversions
197197
unwrap
198198
use_fbs_defaults
199199
use_matlab_defaults
200-
use_numpy_matrix
201200

202201

‎doc/conventions.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -303,9 +303,6 @@ Selected variables that can be configured, along with their default values:
303303
* freqplot.feature_periphery_decade (1.0): How many decades to include in
304304
the frequency range on both sides of features (poles, zeros).
305305

306-
* statesp.use_numpy_matrix (True): set the return type for state space
307-
matrices to `numpy.matrix` (verus numpy.ndarray)
308-
309306
* statesp.default_dt and xferfcn.default_dt (None): set the default value
310307
of dt when constructing new LTI systems
311308

@@ -322,5 +319,4 @@ Functions that can be used to set standard configurations:
322319
reset_defaults
323320
use_fbs_defaults
324321
use_matlab_defaults
325-
use_numpy_matrix
326322
use_legacy_defaults

0 commit comments

Comments
 (0)
0