[Octave-cvsupdate] SF.net SVN: octave:[9398] trunk/octave-forge/extra/control-devel/inst

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

Revision: 9398
          http://octave.svn.sourceforge.net/octave/?rev=9398&view=rev
Author:   paramaniac
Date:     2011-12-15 21:19:41 +0000 (Thu, 15 Dec 2011)
Log Message:
-----------
control: describe key/value pairs (3)

Modified Paths:
--------------
    trunk/octave-forge/extra/control-devel/inst/btaconred.m
    trunk/octave-forge/extra/control-devel/inst/spaconred.m

Modified: trunk/octave-forge/extra/control-devel/inst/btaconred.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/btaconred.m	2011-12-15 21:14:45 UTC (rev 9397)
+++ trunk/octave-forge/extra/control-devel/inst/btaconred.m	2011-12-15 21:19:41 UTC (rev 9398)
@@ -60,6 +60,77 @@
 ## @end table
 ## @end table
 ##
+## @strong{Option Keys and Values}
+## @table @var
+## @item "order", "ncr"
+## The desired order of the resulting reduced order controller @var{Kr}.
+## If not specified, @var{ncr} is chosen automatically.
+##
+## @item "method"
+## Order reduction approach to be used as follows:
+## @table @var
+## @item "sr", "b"
+## Use the square-root Balance & Truncate method.
+## @item "bfsr", "f"
+## Use the balancing-free square-root Balance & Truncate method.  Default method.
+## @end table
+##
+## @item "weight"
+## Specifies the type of frequency-weighting as follows:
+## @table @var
+## @item "none"
+## No weightings are used (V = I, W = I).  Default value.
+## @item "left", "output"
+## Use stability enforcing left (output) weighting
+## @example
+##           -1
+## V = (I-G*K) *G ,  (W = I)
+## @end example         
+## @item "right", "input"
+## Use stability enforcing right (input) weighting
+## @example
+##           -1
+## W = (I-G*K) *G ,  (V = I)
+## @end example                    
+## @item "both", "performance"
+## Use stability and performance enforcing weightings
+## @example
+##           -1                -1
+## V = (I-G*K) *G ,  W = (I-G*K)
+## @end example
+## @end table
+##
+## @item "alpha"
+## Specifies the ALPHA-stability boundary for the eigenvalues
+## of the state dynamics matrix @var{K.A}.  For a continuous-time
+## controller, ALPHA <= 0 is the boundary value for
+## the real parts of eigenvalues, while for a discrete-time
+## controller, 0 <= ALPHA <= 1 represents the
+## boundary value for the moduli of eigenvalues.
+## The ALPHA-stability domain does not include the boundary.
+## Default value is 0 for continuous-time controllers and
+## 1 for discrete-time controllers.
+##
+## @item "tol1"
+## If @var{"order"} is not specified, @var{tol1} contains the tolerance for
+## determining the order of the reduced controller.
+## For model reduction, the recommended value of @var{tol1} is
+## c*info.hsvc(1), where c lies in the interval [0.00001, 0.001].
+## If @var{"order"} is specified, the value of @var{tol1} is ignored.
+##
+## @item "tol2"
+## The tolerance for determining the order of a minimal
+## realization of the ALPHA-stable part of the given
+## controller.  TOL2 <= TOL1.
+## If not specified, ncs*eps*info.hsvc(1) is chosen.
+##
+## @item "equil", "scale"
+## Boolean indicating whether equilibration (scaling) should be
+## performed on @var{G} and @var{K} prior to order reduction.
+## Default value is false if both @code{G.scaled == true, K.scaled == true}
+## and true otherwise.
+## @end table
+##
 ## @strong{Algorithm}@*
 ## Uses SLICOT SB16AD by courtesy of
 ## @uref{http://www.slicot.org, NICONET e.V.}

Modified: trunk/octave-forge/extra/control-devel/inst/spaconred.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/spaconred.m	2011-12-15 21:14:45 UTC (rev 9397)
+++ trunk/octave-forge/extra/control-devel/inst/spaconred.m	2011-12-15 21:19:41 UTC (rev 9398)
@@ -60,6 +60,77 @@
 ## @end table
 ## @end table
 ##
+## @strong{Option Keys and Values}
+## @table @var
+## @item "order", "ncr"
+## The desired order of the resulting reduced order controller @var{Kr}.
+## If not specified, @var{ncr} is chosen automatically.
+##
+## @item "method"
+## Order reduction approach to be used as follows:
+## @table @var
+## @item "sr", "s"
+## Use the square-root Singular Perturbation Approximation method.
+## @item "bfsr", "p"
+## Use the balancing-free square-root Singular Perturbation Approximation method.  Default method.
+## @end table
+##
+## @item "weight"
+## Specifies the type of frequency-weighting as follows:
+## @table @var
+## @item "none"
+## No weightings are used (V = I, W = I).  Default value.
+## @item "left", "output"
+## Use stability enforcing left (output) weighting
+## @example
+##           -1
+## V = (I-G*K) *G ,  (W = I)
+## @end example         
+## @item "right", "input"
+## Use stability enforcing right (input) weighting
+## @example
+##           -1
+## W = (I-G*K) *G ,  (V = I)
+## @end example                    
+## @item "both", "performance"
+## Use stability and performance enforcing weightings
+## @example
+##           -1                -1
+## V = (I-G*K) *G ,  W = (I-G*K)
+## @end example
+## @end table
+##
+## @item "alpha"
+## Specifies the ALPHA-stability boundary for the eigenvalues
+## of the state dynamics matrix @var{K.A}.  For a continuous-time
+## controller, ALPHA <= 0 is the boundary value for
+## the real parts of eigenvalues, while for a discrete-time
+## controller, 0 <= ALPHA <= 1 represents the
+## boundary value for the moduli of eigenvalues.
+## The ALPHA-stability domain does not include the boundary.
+## Default value is 0 for continuous-time controllers and
+## 1 for discrete-time controllers.
+##
+## @item "tol1"
+## If @var{"order"} is not specified, @var{tol1} contains the tolerance for
+## determining the order of the reduced controller.
+## For model reduction, the recommended value of @var{tol1} is
+## c*info.hsvc(1), where c lies in the interval [0.00001, 0.001].
+## If @var{"order"} is specified, the value of @var{tol1} is ignored.
+##
+## @item "tol2"
+## The tolerance for determining the order of a minimal
+## realization of the ALPHA-stable part of the given
+## controller.  TOL2 <= TOL1.
+## If not specified, ncs*eps*info.hsvc(1) is chosen.
+##
+## @item "equil", "scale"
+## Boolean indicating whether equilibration (scaling) should be
+## performed on @var{G} and @var{K} prior to order reduction.
+## Default value is false if both @code{G.scaled == true, K.scaled == true}
+## and true otherwise.
+## @end table
+##
 ## @strong{Algorithm}@*
 ## Uses SLICOT SB16AD by courtesy of
 ## @uref{http://www.slicot.org, NICONET e.V.}

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