Mercurial > hg > octave-nkf
comparison scripts/control/step.m @ 3425:8625164a0a39
[project @ 2000-01-13 08:31:37 by jwe]
author | jwe |
---|---|
date | Thu, 13 Jan 2000 08:32:16 +0000 |
parents | ae7adbb591e8 |
children |
comparison
equal
deleted
inserted
replaced
3424:61e40232a4e8 | 3425:8625164a0a39 |
---|---|
1 ## Copyright (C) 1996 Auburn University. All rights reserved. | 1 ## Copyright (C) 1996 Auburn University. All rights reserved. |
2 ## | 2 ## |
3 ## This file is part of Octave. | 3 ## This file is part of Octave. |
4 ## | 4 ## |
5 ## Octave is free software; you can redistribute it and/or modify it | 5 ## Octave is free software; you can redistribute it and/or modify it |
6 ## under the terms of the GNU General Public License as published by the | 6 ## under the terms of the GNU General Public License as published by the |
7 ## Free Software Foundation; either version 2, or (at your option) any | 7 ## Free Software Foundation; either version 2, or (at your option) any |
8 ## later version. | 8 ## later version. |
9 ## | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but WITHOUT | 10 ## Octave is distributed in the hope that it will be useful, but WITHOUT |
11 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | 11 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | 12 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ## for more details. | 13 ## for more details. |
14 ## | 14 ## |
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, write to the Free | 16 ## along with Octave; see the file COPYING. If not, write to the Free |
17 ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. | 17 ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File } {[@var{y}, @var{t}] =} step (@var{sys}@{, @var{inp},@var{tstop}, @var{n}@}) | 20 ## @deftypefn {Function File} {[@var{y}, @var{t}] =} step (@var{sys}@{, @var{inp},@var{tstop}, @var{n}@}) |
21 ## Step response for a linear system. | 21 ## Step response for a linear system. |
22 ## The system can be discrete or multivariable (or both). | 22 ## The system can be discrete or multivariable (or both). |
23 ## If no output arguments are specified, @code{step} | 23 ## If no output arguments are specified, @code{step} |
24 ## produces a plot or the step response data for system @var{sys}. | 24 ## produces a plot or the step response data for system @var{sys}. |
25 ## | 25 ## |
26 ## @strong{Inputs} | 26 ## @strong{Inputs} |
27 ## @table @var | 27 ## @table @var |
28 ## @item sys | 28 ## @item sys |
29 ## System data structure. | 29 ## System data structure. |
30 ## @item inp | 30 ## @item inp |
31 ## Index of input being excited | 31 ## Index of input being excited |
32 ## @item tstop | 32 ## @item tstop |
33 ## The argument @var{tstop} (scalar value) denotes the time when the | 33 ## The argument @var{tstop} (scalar value) denotes the time when the |
34 ## simulation should end. | 34 ## simulation should end. |
35 ## @item n | 35 ## @item n |
36 ## the number of data values. | 36 ## the number of data values. |
37 ## | 37 ## |
38 ## Both parameters @var{tstop} and @var{n} can be omitted and will be | 38 ## Both parameters @var{tstop} and @var{n} can be omitted and will be |
39 ## computed from the eigenvalues of the A-Matrix. | 39 ## computed from the eigenvalues of the A-Matrix. |
40 ## @end table | 40 ## @end table |
41 ## @strong{Outputs} | 41 ## @strong{Outputs} |
42 ## @var{y}, @var{t}: impulse response | 42 ## @var{y}, @var{t}: impulse response |
43 ## | 43 ## |
44 ## When invoked with the output paramter y the plot is not displayed. | 44 ## When invoked with the output paramter y the plot is not displayed. |
45 ## @end deftypefn | 45 ## @end deftypefn |
46 ## @seealso{impulse and stepimp} | 46 ## @seealso{impulse and stepimp} |
47 | 47 |
48 ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> | 48 ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> |
49 ## Created: September 30, 1997 | 49 ## Created: September 30, 1997 |