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

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

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

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

Modified Paths:
--------------
    trunk/octave-forge/main/control/inst/dlqr.m
    trunk/octave-forge/main/control/inst/lqr.m

Modified: trunk/octave-forge/main/control/inst/dlqr.m
===================================================================
--- trunk/octave-forge/main/control/inst/dlqr.m	2010-09-04 20:23:38 UTC (rev 7654)
+++ trunk/octave-forge/main/control/inst/dlqr.m	2010-09-04 21:12:41 UTC (rev 7655)
@@ -20,8 +20,46 @@
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{sys}, @var{q}, @var{r}, @var{s})
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{a}, @var{b}, @var{q}, @var{r})
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
-## Return linear-quadratic state-feedback gain matrix g for a LTI system as well as
-## the solution x of the associated riccati equation and the closed-loop poles l.
+## Linear-quadratic regulator for discrete-time systems.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## Continuous or discrete-time LTI model.
+## @item a
+## State transition matrix of discrete-time system.
+## @item b
+## Input matrix of discrete-time system.
+## @item q
+## State weighting matrix.
+## @item r
+## Control weighting matrix.
+## @item s
+## Optional cross term matrix. If @var{s} is not specified, a zero matrix is assumed.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item g
+## State feedback matrix.
+## @item x
+## Unique stabilizing solution of the discrete-time Riccati equation.
+## @item l
+## Closed-loop poles.
+## @end table
+##
+## @example
+## @group
+## x[k+1] = A x[k] + B u[k],   x[0] = x0
+##
+##         /inf
+## J(x0) = | (x' Q x  +  u' R u  +  2 x' S u)  dt
+##         /0
+##
+## L = eig (A - B*G)
+## @end group
+## @end example
+## @seealso{dare, care, lqr}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/lqr.m
===================================================================
--- trunk/octave-forge/main/control/inst/lqr.m	2010-09-04 20:23:38 UTC (rev 7654)
+++ trunk/octave-forge/main/control/inst/lqr.m	2010-09-04 21:12:41 UTC (rev 7655)
@@ -20,9 +20,47 @@
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{sys}, @var{q}, @var{r}, @var{s})
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{a}, @var{b}, @var{q}, @var{r})
 ## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
-## Linear-quadratic regulator. Return linear-quadratic state-feedback gain matrix g for a LTI system
-## as well as the solution x of the associated riccati equation and the closed-loop poles l.
-## @seealso{care, dare}
+## Linear-quadratic regulator.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## Continuous or discrete-time LTI model.
+## @item a
+## State transition matrix of continuous-time system.
+## @item b
+## Input matrix of continuous-time system.
+## @item q
+## State weighting matrix.
+## @item r
+## Control weighting matrix.
+## @item s
+## Optional cross term matrix. If @var{s} is not specified, a zero matrix is assumed.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item g
+## State feedback matrix.
+## @item x
+## Unique stabilizing solution of the continuous-time Riccati equation.
+## @item l
+## Closed-loop poles.
+## @end table
+##
+## @example
+## @group
+## .
+## x = A x + B u,   x(0) = x0
+##
+##         /inf
+## J(x0) = | (x' Q x  +  u' R u  +  2 x' S u)  dt
+##         /0
+##
+## L = eig (A - B*G)
+## @end group
+## @end example
+## @seealso{care, dare, dlqr}
 ## @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.