[Octave-cvsupdate] SF.net SVN: octave:[7656] trunk/octave-forge/main/control/inst

[<par...@us...>]

Revision: 7656
          http://octave.svn.sourceforge.net/octave/?rev=7656&view=rev
Author:   paramaniac
Date:     2010-09-04 21:28:24 +0000 (Sat, 04 Sep 2010)

Log Message:
-----------
control: upgrade even more texinfo strings

Modified Paths:
--------------
    trunk/octave-forge/main/control/inst/estim.m
    trunk/octave-forge/main/control/inst/kalman.m

Modified: trunk/octave-forge/main/control/inst/estim.m
===================================================================
--- trunk/octave-forge/main/control/inst/estim.m	2010-09-04 21:12:41 UTC (rev 7655)
+++ trunk/octave-forge/main/control/inst/estim.m	2010-09-04 21:28:24 UTC (rev 7656)
@@ -19,6 +19,26 @@
 ## @deftypefn {Function File} {@var{est} =} estim (@var{sys}, @var{l})
 ## @deftypefnx {Function File} {@var{est} =} estim (@var{sys}, @var{l}, @var{sensors}, @var{known})
 ## Return state estimator for a given estimator gain
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item l
+## State feedback matrix.
+## @item sensors
+## Indices of measured output signals y from @var{sys}. If omitted, all outputs are measured.
+## @item known
+## Indices of known input signals u (deterministic) to @var{sys}. All other inputs to @var{sys}
+## are assumed stochastic. If argument @var{known} is omitted, no inputs u are known.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item est
+## State-space model of estimator.
+## @end table
+## @seealso{kalman, place}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/kalman.m
===================================================================
--- trunk/octave-forge/main/control/inst/kalman.m	2010-09-04 21:12:41 UTC (rev 7655)
+++ trunk/octave-forge/main/control/inst/kalman.m	2010-09-04 21:28:24 UTC (rev 7656)
@@ -22,20 +22,6 @@
 ## @deftypefnx {Function File} {[@var{est}, @var{g}, @var{x}] =} kalman (@var{sys}, @var{q}, @var{r}, @var{s}, @var{sensors}, @var{known})
 ## Design Kalman estimator for LTI systems.
 ##
-## @example
-## @group
-##                                  u  +-------+         ^
-##       +---------------------------->|       |-------> y
-##       |    +-------+     +       y  |  est  |         ^
-## u ----+--->|       |----->(+)------>|       |-------> x
-##            |  sys  |       ^ +      +-------+
-## w -------->|       |       |
-##            +-------+       | v
-##
-## Q = cov (w, w')     R = cov (v, v')     S = cov (w, v')
-## @end group
-## @end example
-##
 ## @strong{Inputs}
 ## @table @var
 ## @item sys
@@ -45,12 +31,12 @@
 ## @item R
 ## Covariance of white measurement noise.
 ## @item S
-## Optional cross term covariance. Default value is S = 0.
+## Optional cross term covariance. Default value is zero.
 ## @item sensors
-## Indices of measured output signals y from sys. If omitted, all outputs are measured.
+## Indices of measured output signals y from @var{sys}. If omitted, all outputs are measured.
 ## @item known
-## Indices of known input signals u (deterministic) to sys. All other inputs to sys
-## are assumed stochastic. If argument known is omitted, no inputs u are known.
+## Indices of known input signals u (deterministic) to @var{sys}. All other inputs to @var{sys}
+## are assumed stochastic. If argument @var{known} is omitted, no inputs u are known.
 ## @end table
 ##
 ## @strong{Outputs}
@@ -62,6 +48,21 @@
 ## @item X
 ## Solution of the Riccati equation.
 ## @end table
+##
+## @example
+## @group
+##                                  u  +-------+         ^
+##       +---------------------------->|       |-------> y
+##       |    +-------+     +       y  |  est  |         ^
+## u ----+--->|       |----->(+)------>|       |-------> x
+##            |  sys  |       ^ +      +-------+
+## w -------->|       |       |
+##            +-------+       | v
+##
+## Q = cov (w, w')     R = cov (v, v')     S = cov (w, v')
+## @end group
+## @end example
+##
 ## @seealso{care, dare, estim, lqr}
 ## @end deftypefn
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.