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

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

Revision: 10642
          http://octave.svn.sourceforge.net/octave/?rev=10642&view=rev
Author:   paramaniac
Date:     2012-06-20 05:42:56 +0000 (Wed, 20 Jun 2012)
Log Message:
-----------
control: specify matrix dimensions in help texts

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	2012-06-19 20:23:47 UTC (rev 10641)
+++ trunk/octave-forge/main/control/inst/dlqr.m	2012-06-20 05:42:56 UTC (rev 10642)
@@ -27,29 +27,29 @@
 ## @strong{Inputs}
 ## @table @var
 ## @item sys
-## Continuous or discrete-time LTI model.
+## Continuous or discrete-time LTI model (p-by-m, n states).
 ## @item a
-## State transition matrix of discrete-time system.
+## State transition matrix of discrete-time system (n-by-n).
 ## @item b
-## Input matrix of discrete-time system.
+## Input matrix of discrete-time system (n-by-m).
 ## @item q
-## State weighting matrix.
+## State weighting matrix (n-by-n).
 ## @item r
-## Input weighting matrix.
+## Input weighting matrix (m-by-m).
 ## @item s
-## Optional cross term matrix.  If @var{s} is not specified, a zero matrix is assumed.
+## Optional cross term matrix (n-by-m).  If @var{s} is not specified, a zero matrix is assumed.
 ## @item e
-## Optional descriptor matrix.  If @var{e} is not specified, an identity matrix is assumed.
+## Optional descriptor matrix (n-by-n).  If @var{e} is not specified, an identity matrix is assumed.
 ## @end table
 ##
 ## @strong{Outputs}
 ## @table @var
 ## @item g
-## State feedback matrix.
+## State feedback matrix (m-by-n).
 ## @item x
-## Unique stabilizing solution of the discrete-time Riccati equation.
+## Unique stabilizing solution of the discrete-time Riccati equation (n-by-n).
 ## @item l
-## Closed-loop poles.
+## Closed-loop poles (n-by-1).
 ## @end table
 ##
 ## @strong{Equations}

Modified: trunk/octave-forge/main/control/inst/lqr.m
===================================================================
--- trunk/octave-forge/main/control/inst/lqr.m	2012-06-19 20:23:47 UTC (rev 10641)
+++ trunk/octave-forge/main/control/inst/lqr.m	2012-06-20 05:42:56 UTC (rev 10642)
@@ -27,29 +27,29 @@
 ## @strong{Inputs}
 ## @table @var
 ## @item sys
-## Continuous or discrete-time LTI model.
+## Continuous or discrete-time LTI model (p-by-m, n states).
 ## @item a
-## State transition matrix of continuous-time system.
+## State transition matrix of continuous-time system (n-by-n).
 ## @item b
-## Input matrix of continuous-time system.
+## Input matrix of continuous-time system (n-by-m).
 ## @item q
-## State weighting matrix.
+## State weighting matrix (n-by-n).
 ## @item r
-## Input weighting matrix.
+## Input weighting matrix (m-by-m).
 ## @item s
-## Optional cross term matrix.  If @var{s} is not specified, a zero matrix is assumed.
+## Optional cross term matrix (n-by-m).  If @var{s} is not specified, a zero matrix is assumed.
 ## @item e
-## Optional descriptor matrix.  If @var{e} is not specified, an identity matrix is assumed.
+## Optional descriptor matrix (n-by-n).  If @var{e} is not specified, an identity matrix is assumed.
 ## @end table
 ##
 ## @strong{Outputs}
 ## @table @var
 ## @item g
-## State feedback matrix.
+## State feedback matrix (m-by-n).
 ## @item x
-## Unique stabilizing solution of the continuous-time Riccati equation.
+## Unique stabilizing solution of the continuous-time Riccati equation (n-by-n).
 ## @item l
-## Closed-loop poles.
+## Closed-loop poles (n-by-1).
 ## @end table
 ##
 ## @strong{Equations}

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