@@ -1486,14 +1486,21 @@ def input_output_response(
14861486 ----------
14871487 sys : InputOutputSystem
14881488 Input/output system to simulate.
1489+
14891490 T : array-like
14901491 Time steps at which the input is defined; values must be evenly spaced.
1492+
14911493 U : array-like or number, optional
14921494 Input array giving input at each time `T` (default = 0).
1495+
14931496 X0 : array-like or number, optional
14941497 Initial condition (default = 0).
1498+
14951499 return_x : bool, optional
1500+ If True, return the state vector when assigning to a tuple (default =
1501+ False). See :func:`forced_response` for more details.
14961502 If True, return the values of the state at each time (default = False).
1503+
14971504 squeeze : bool, optional
14981505 If True and if the system has a single output, return the system
14991506 output as a 1D array rather than a 2D array. If False, return the
@@ -1502,15 +1509,25 @@ def input_output_response(
15021509
15031510 Returns
15041511 -------
1505- T : array
1506- Time values of the output.
1507- yout : array
1508- Response of the system. If the system is SISO and squeeze is not
1509- True, the array is 1D (indexed by time). If the system is not SISO or
1510- squeeze is False, the array is 2D (indexed by the output number and
1511- time).
1512- xout : array
1513- Time evolution of the state vector (if return_x=True).
1512+ results : TimeResponseData
1513+ Time response represented as a :class:`TimeResponseData` object
1514+ containing the following properties:
1515+
1516+ * time (array): Time values of the output.
1517+
1518+ * outputs (array): Response of the system. If the system is SISO and
1519+ `squeeze` is not True, the array is 1D (indexed by time). If the
1520+ system is not SISO or `squeeze` is False, the array is 2D (indexed
1521+ by output and time).
1522+
1523+ * states (array): Time evolution of the state vector, represented as
1524+ a 2D array indexed by state and time.
1525+
1526+ * inputs (array): Input(s) to the system, indexed by input and time.
1527+
1528+ The return value of the system can also be accessed by assigning the
1529+ function to a tuple of length 2 (time, output) or of length 3 (time,
1530+ output, state) if ``return_x`` is ``True``.
15141531
15151532 Other parameters
15161533 ----------------
0 commit comments