Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7649] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-09-04 17:30:49
|
Revision: 7649
http://octave.svn.sourceforge.net/octave/?rev=7649&view=rev
Author: paramaniac
Date: 2010-09-04 17:30:43 +0000 (Sat, 04 Sep 2010)
Log Message:
-----------
control: upgrade texinfo strings of time response functions
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/impulse.m
trunk/octave-forge/main/control/inst/initial.m
trunk/octave-forge/main/control/inst/lsim.m
trunk/octave-forge/main/control/inst/step.m
Modified: trunk/octave-forge/main/control/inst/impulse.m
===================================================================
--- trunk/octave-forge/main/control/inst/impulse.m 2010-09-04 13:45:06 UTC (rev 7648)
+++ trunk/octave-forge/main/control/inst/impulse.m 2010-09-04 17:30:43 UTC (rev 7649)
@@ -21,6 +21,35 @@
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys}, @var{tfinal})
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys}, @var{tfinal}, @var{dt})
## Impulse response of LTI system.
+## If no output arguments are given, the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item t
+## Time vector. Should be evenly spaced. If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item tfinal
+## Optional simulation horizon. If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item dt
+## Optional sampling time. Be sure to choose it small enough to capture transient
+## phenomena. If not specified, it is calculated by the poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item y
+## Output response array. Has as many rows as time samples (length of t)
+## and as many columns as outputs.
+## @item t
+## Time row vector.
+## @item x
+## State trajectories array. Has length(t) rows and as many columns as states.
+## @end table
+##
+## @seealso{initial, lsim, step}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/initial.m
===================================================================
--- trunk/octave-forge/main/control/inst/initial.m 2010-09-04 13:45:06 UTC (rev 7648)
+++ trunk/octave-forge/main/control/inst/initial.m 2010-09-04 17:30:43 UTC (rev 7649)
@@ -21,8 +21,7 @@
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} initial (@var{sys}, @var{x0}, @var{tfinal})
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} initial (@var{sys}, @var{x0}, @var{tfinal}, @var{dt})
## Initial condition response of state-space model.
-## If no output arguments are given, the response is printed on the screen;
-## otherwise, the response is computed and returned.
+## If no output arguments are given, the response is printed on the screen.
##
## @strong{Inputs}
## @table @var
@@ -30,12 +29,15 @@
## State-space model.
## @item x0
## Vector of initial conditions for each state.
+## @item t
+## Optional time vector. Should be evenly spaced. If not specified, it is calculated
+## by the poles of the system to reflect adequately the response transients.
## @item tfinal
-## Optional simulation horizon. If not specified, it will be calculated by
+## Optional simulation horizon. If not specified, it is calculated by
## the poles of the system to reflect adequately the response transients.
## @item dt
## Optional sampling time. Be sure to choose it small enough to capture transient
-## phenomena. If not specified, it will be calculated by the poles of the system.
+## phenomena. If not specified, it is calculated by the poles of the system.
## @end table
##
## @strong{Outputs}
Modified: trunk/octave-forge/main/control/inst/lsim.m
===================================================================
--- trunk/octave-forge/main/control/inst/lsim.m 2010-09-04 13:45:06 UTC (rev 7648)
+++ trunk/octave-forge/main/control/inst/lsim.m 2010-09-04 17:30:43 UTC (rev 7649)
@@ -21,6 +21,32 @@
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} lsim (@var{sys}, @var{u}, @var{t}, @var{x0}, @var{method})
## Simulate LTI model response to arbitrary inputs. If no output arguments are given,
## the system response is plotted on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item t
+## Time vector. Should be evenly spaced.
+## @item x0
+## Vector of initial conditions for each state.
+## @item method
+## Discretization method for continuous-time models. Default value is zoh
+## (zero-order hold). All methods from c2d are supported.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item y
+## Output response array. Has as many rows as time samples (length of t)
+## and as many columns as outputs.
+## @item t
+## Time row vector.
+## @item x
+## State trajectories array. Has length(t) rows and as many columns as states.
+## @end table
+##
+## @seealso{impulse, initial, step}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/step.m
===================================================================
--- trunk/octave-forge/main/control/inst/step.m 2010-09-04 13:45:06 UTC (rev 7648)
+++ trunk/octave-forge/main/control/inst/step.m 2010-09-04 17:30:43 UTC (rev 7649)
@@ -21,6 +21,35 @@
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} step (@var{sys}, @var{tfinal})
## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} step (@var{sys}, @var{tfinal}, @var{dt})
## Step response of LTI system.
+## If no output arguments are given, the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item t
+## Time vector. Should be evenly spaced. If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item tfinal
+## Optional simulation horizon. If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item dt
+## Optional sampling time. Be sure to choose it small enough to capture transient
+## phenomena. If not specified, it is calculated by the poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item y
+## Output response array. Has as many rows as time samples (length of t)
+## and as many columns as outputs.
+## @item t
+## Time row vector.
+## @item x
+## State trajectories array. Has length(t) rows and as many columns as states.
+## @end table
+##
+## @seealso{impulse, initial, lsim}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
