Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7658] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-09-05 05:54:24
|
Revision: 7658
http://octave.svn.sourceforge.net/octave/?rev=7658&view=rev
Author: paramaniac
Date: 2010-09-05 05:54:14 +0000 (Sun, 05 Sep 2010)
Log Message:
-----------
control: work on texinfo strings
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/@tf/tf.m
trunk/octave-forge/main/control/inst/dlyap.m
trunk/octave-forge/main/control/inst/gensig.m
trunk/octave-forge/main/control/inst/isctrb.m
trunk/octave-forge/main/control/inst/isobsv.m
trunk/octave-forge/main/control/inst/lyap.m
Modified: trunk/octave-forge/main/control/inst/@tf/tf.m
===================================================================
--- trunk/octave-forge/main/control/inst/@tf/tf.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/@tf/tf.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -26,9 +26,11 @@
## @strong{Inputs}
## @table @var
## @item num
-## Numerator or cell of numerators.
+## Numerator or cell of numerators. Row vector containing the exponents
+## of the polynomial in descending order.
## @item den
-## Denominator or cell of denominators.
+## Denominator or cell of denominators. Row vector containing the exponents
+## of the polynomial in descending order.
## @item tsam
## Sampling time. If @var{tsam} is not specified, a continuous-time
## model is assumed.
Modified: trunk/octave-forge/main/control/inst/dlyap.m
===================================================================
--- trunk/octave-forge/main/control/inst/dlyap.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/dlyap.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -22,6 +22,7 @@
## Solve discrete-time Lyapunov or Sylvester equations.
## Uses SLICOT SB03MD, SB04QD and SG03AD by courtesy of NICONET e.V.
## <http://www.slicot.org>
+##
## @example
## @group
## AXA' - X + B = 0 (Lyapunov Equation)
Modified: trunk/octave-forge/main/control/inst/gensig.m
===================================================================
--- trunk/octave-forge/main/control/inst/gensig.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/gensig.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -34,7 +34,7 @@
## @item tau
## Duration of one period in seconds.
## @item tfinal
-## Optional duration of the signal in seconds. Default duration is 5 periods
+## Optional duration of the signal in seconds. Default duration is 5 periods.
## @item tsam
## Optional sampling time in seconds. Default spacing is tau/64.
## @end table
Modified: trunk/octave-forge/main/control/inst/isctrb.m
===================================================================
--- trunk/octave-forge/main/control/inst/isctrb.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/isctrb.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -17,7 +17,9 @@
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{retval}, @var{u}] =} isctrb (@var{sys}, @var{tol})
+## @deftypefn {Function File} {[@var{retval}, @var{u}] =} isctrb (@var{sys})
+## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isctrb (@var{sys}, @var{tol})
+## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isctrb (@var{a}, @var{b})
## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isctrb (@var{a}, @var{b}, @var{tol})
## Logical check for system controllability.
## Uses SLICOT AB01OD by courtesy of NICONET e.V.
@@ -26,23 +28,23 @@
## @strong{Inputs}
## @table @var
## @item sys
-## system data structure
+## LTI model.
## @item a
-## @itemx b
-## @var{n} by @var{n}, @var{n} by @var{m} matrices, respectively
+## State transition matrix.
+## @item b
+## Input matrix.
## @item tol
-## optional roundoff parameter. Default value: 0
+## Optional roundoff parameter. Default value is zero.
## @end table
##
## @strong{Outputs}
## @table @var
## @item retval
-## Logical flag; returns true (1) if the system @var{sys} or the
-## pair (@var{a}, @var{b}) is controllable, whichever was passed as input
-## arguments.
+## Logical flag; true (1) if the system is controllable.
## @item u
-## @var{u} is an orthogonal basis of the controllable subspace.
+## An orthogonal basis of the controllable subspace.
## @end table
+##
## @seealso{isobsv}
## @end deftypefn
Modified: trunk/octave-forge/main/control/inst/isobsv.m
===================================================================
--- trunk/octave-forge/main/control/inst/isobsv.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/isobsv.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -17,17 +17,34 @@
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{retval}, @var{u}] =} isobsv (@var{a}, @var{c}, @var{tol})
+## @deftypefn {Function File} {[@var{retval}, @var{u}] =} isobsv (@var{sys})
## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isobsv (@var{sys}, @var{tol})
+## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isobsv (@var{a}, @var{c})
+## @deftypefnx {Function File} {[@var{retval}, @var{u}] =} isobsv (@var{a}, @var{c}, @var{tol})
## Logical check for system observability.
+## Uses SLICOT AB01OD by courtesy of NICONET e.V.
+## <http://www.slicot.org>
##
-## Default: tol = @code{tol = 10*norm(a,"fro")*eps}
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item a
+## State transition matrix.
+## @item c
+## Measurement matrix.
+## @item tol
+## Optional roundoff parameter. Default value is zero.
+## @end table
##
-## Returns 1 if the system @var{sys} or the pair (@var{a}, @var{c}) is
-## observable, 0 if not.
+## @strong{Outputs}
+## @table @var
+## @item retval
+## Logical flag; true (1) if the system is observable.
+## @item u
+## An orthogonal basis of the observable subspace.
+## @end table
##
-## See @command{isctrb} for detailed description of arguments
-## and default values.
## @seealso{isctrb}
## @end deftypefn
Modified: trunk/octave-forge/main/control/inst/lyap.m
===================================================================
--- trunk/octave-forge/main/control/inst/lyap.m 2010-09-04 22:10:46 UTC (rev 7657)
+++ trunk/octave-forge/main/control/inst/lyap.m 2010-09-05 05:54:14 UTC (rev 7658)
@@ -22,6 +22,7 @@
## Solve continuous-time Lyapunov or Sylvester equations.
## Uses SLICOT SB03MD, SB04MD and SG03AD by courtesy of NICONET e.V.
## <http://www.slicot.org>
+##
## @example
## @group
## AX + XA' + B = 0 (Lyapunov Equation)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
