Skip to content

Commit 94322c8

Browse files
committed
Merge remote-tracking branch 'origin/call-method' into call-method
2 parents 4ad33db + 17bc2a8 commit 94322c8

4 files changed

Lines changed: 35 additions & 13 deletions

File tree

control/frdata.py

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,10 +352,11 @@ def eval(self, omega, squeeze=True):
352352
entry in the omega vector. An interpolating FRD can return
353353
intermediate values.
354354
355+
Parameters
356+
----------
355357
squeeze: bool, optional (default=True)
356358
If True and sys is single input, single output (SISO), return a
357359
1D array or scalar the same length as omega.
358-
359360
"""
360361
omega_array = np.array(omega, ndmin=1) # array-like version of omega
361362
if any(omega_array.imag > 0):
@@ -391,12 +392,24 @@ def __call__(self, s, squeeze=True):
391392
transfer function. For a MIMO transfer fuction, returns a
392393
matrix of values.
393394
394-
Raises an error if s is not purely imaginary.
395-
395+
Parameters
396+
----------
397+
s : scalar or array_like
398+
Complex frequencies
396399
squeeze: bool, optional (default=True)
397400
If True and sys is single input, single output (SISO), return a
398401
1D array or scalar depending on omega's length.
399402
403+
Returns
404+
-------
405+
ndarray or scalar
406+
Frequency response
407+
408+
Raises
409+
------
410+
ValueError
411+
If `s` is not purely imaginary.
412+
400413
"""
401414
if any(abs(np.array(s, ndmin=1).real) > 0):
402415
raise ValueError("__call__: FRD systems can only accept"

control/lti.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ def evalfr(sys, x, squeeze=True):
436436
----------
437437
sys: StateSpace or TransferFunction
438438
Linear system
439-
x: scalar or array-like
439+
x: scalar or array_like
440440
Complex number
441441
squeeze: bool, optional (default=True)
442442
If True and sys is single input, single output (SISO), return a

control/statesp.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -469,11 +469,14 @@ def slycot_horner(self, s):
469469
for a more user-friendly interface.
470470
471471
Parameters
472-
s : array-like
472+
----------
473+
s : array_like
474+
Complex frequency
473475
474476
Returns
475-
output : array of size (outputs, inputs, len(s))
476-
477+
-------
478+
output : (outputs, inputs, len(s)) complex ndarray
479+
Frequency response
477480
"""
478481
from slycot import tb05ad
479482

@@ -517,11 +520,14 @@ def horner(self, s):
517520
for a more user-friendly interface.
518521
519522
Parameters
520-
s : array-like
523+
----------
524+
s : array_like
525+
Complex frequencies
521526
522527
Returns
523-
output : array of size (outputs, inputs, len(s))
524-
528+
-------
529+
output : (outputs, inputs, len(s)) complex ndarray
530+
Frequency response
525531
"""
526532
s_arr = np.array(s, ndmin=1) # force to be an array
527533
# Preallocate

control/xferfcn.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,14 @@ def horner(self, s):
233233
for a more user-friendly interface.
234234
235235
Parameters
236-
s : array-like
236+
----------
237+
s : array_like
238+
Complex frequencies
237239
238240
Returns
239-
output : array of size (outputs, inputs, len(s))
240-
241+
-------
242+
output : (outputs, inputs, len(s)) complex ndarray
243+
Frequency response
241244
"""
242245
s_arr = np.array(s, ndmin=1) # force to be an array
243246
out = empty((self.outputs, self.inputs, len(s_arr)), dtype=complex)

0 commit comments

Comments
 (0)