Skip to content

Commit a631098

Browse files
missed a couple of doc updates in xferfcn
Co-authored-by: Ben Greiner <code@bnavigator.de>
1 parent 178bfa0 commit a631098

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

control/xferfcn.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,22 +237,26 @@ def __call__(self, x, squeeze=True):
237237
Returns the complex frequency response `sys(x)` where `x` is `s` for
238238
continuous-time systems and `z` for discrete-time systems.
239239
240+
In general the system may be multiple input, multiple output (MIMO), where
241+
`m = self.inputs` number of inputs and `p = self.outputs` number of
242+
outputs.
243+
240244
To evaluate at a frequency omega in radians per second, enter
241245
``x = omega * 1j``, for continuous-time systems, or
242246
``x = exp(1j * omega * dt)`` for discrete-time systems. Or use
243247
:meth:`TransferFunction.frequency_response`.
244248
245249
Parameters
246250
----------
247-
x: complex array_like or complex
251+
x : complex array_like or complex
248252
Complex frequencies
249-
squeeze: bool, optional (default=True)
253+
squeeze : bool, optional (default=True)
250254
If True and `sys` is single input single output (SISO), returns a
251-
1D array or scalar depending on the length of `x`.
255+
1D array rather than a 3D array.
252256
253257
Returns
254258
-------
255-
fresp : (self.outputs, self.inputs, len(x)) or len(x) complex ndarray
259+
fresp : (p, m, len(x)) complex ndarray or or (len(x), ) complex ndarray
256260
The frequency response of the system. Array is `len(x)` if and
257261
only if system is SISO and ``squeeze=True``.
258262

0 commit comments

Comments
 (0)