Skip to content

Commit 03f0e28

Browse files
committed
docstring and signature tweaks
1 parent ea45b03 commit 03f0e28

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

control/timeresp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ def shape_matches(s_legal, s_actual):
621621

622622

623623
# Forced response of a linear system
624-
def forced_response(sys, T=None, U=0., X0=0., issiso=False, transpose=False,
624+
def forced_response(sys, T=None, U=0., X0=0., transpose=False,
625625
interpolate=False, return_x=None, squeeze=None):
626626
"""Simulate the output of a linear system.
627627

doc/conventions.rst

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,12 @@ Types:
134134
* **Arguments** can be **arrays**, **matrices**, or **nested lists**.
135135
* **Return values** are **arrays** (not matrices).
136136

137-
The time vector is either 1D, or 2D with shape (1, n)::
137+
The time vector is a 1D array with shape (n, )::
138138

139-
T = [[t1, t2, t3, ..., tn ]]
139+
T = [t1, t2, t3, ..., tn ]
140140

141141
Input, state, and output all follow the same convention. Columns are different
142-
points in time, rows are different components. When there is only one row, a
143-
1D object is accepted or returned, which adds convenience for SISO systems::
142+
points in time, rows are different components::
144143

145144
U = [[u1(t1), u1(t2), u1(t3), ..., u1(tn)]
146145
[u2(t1), u2(t2), u2(t3), ..., u2(tn)]
@@ -153,6 +152,9 @@ points in time, rows are different components. When there is only one row, a
153152
So, U[:,2] is the system's input at the third point in time; and U[1] or U[1,:]
154153
is the sequence of values for the system's second input.
155154

155+
When there is only one row, a 1D object is accepted or returned, which adds
156+
convenience for SISO systems:
157+
156158
The initial conditions are either 1D, or 2D with shape (j, 1)::
157159

158160
X0 = [[x1]
@@ -230,27 +232,29 @@ on standard configurations.
230232
231233
Selected variables that can be configured, along with their default values:
232234
233-
* freqplot.dB (False): Bode plot magnitude plotted in dB (otherwise powers of 10)
235+
* freqplot.dB (False): Bode plot magnitude plotted in dB (otherwise powers
236+
of 10)
234237
235238
* freqplot.deg (True): Bode plot phase plotted in degrees (otherwise radians)
236239
237-
* freqplot.Hz (False): Bode plot frequency plotted in Hertz (otherwise rad/sec)
240+
* freqplot.Hz (False): Bode plot frequency plotted in Hertz (otherwise
241+
rad/sec)
238242
239243
* freqplot.grid (True): Include grids for magnitude and phase plots
240244
241245
* freqplot.number_of_samples (1000): Number of frequency points in Bode plots
242246
243-
* freqplot.feature_periphery_decade (1.0): How many decades to include in the
244-
frequency range on both sides of features (poles, zeros).
247+
* freqplot.feature_periphery_decade (1.0): How many decades to include in
248+
the frequency range on both sides of features (poles, zeros).
245249
246-
* statesp.use_numpy_matrix (True): set the return type for state space matrices to
247-
`numpy.matrix` (verus numpy.ndarray)
250+
* statesp.use_numpy_matrix (True): set the return type for state space
251+
matrices to `numpy.matrix` (verus numpy.ndarray)
248252
249-
* statesp.default_dt and xferfcn.default_dt (None): set the default value of dt when
250-
constructing new LTI systems
253+
* statesp.default_dt and xferfcn.default_dt (None): set the default value
254+
of dt when constructing new LTI systems
251255
252-
* statesp.remove_useless_states (True): remove states that have no effect on the
253-
input-output dynamics of the system
256+
* statesp.remove_useless_states (True): remove states that have no effect
257+
on the input-output dynamics of the system
254258
255259
Additional parameter variables are documented in individual functions
256260

0 commit comments

Comments
 (0)