Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[9401] trunk/octave-forge/extra/control-devel/inst
|
From: <par...@us...> - 2011-12-15 21:49:16
|
Revision: 9401
http://octave.svn.sourceforge.net/octave/?rev=9401&view=rev
Author: paramaniac
Date: 2011-12-15 21:49:10 +0000 (Thu, 15 Dec 2011)
Log Message:
-----------
control: describe key/value pairs (4)
Modified Paths:
--------------
trunk/octave-forge/extra/control-devel/inst/__modred_ab09id__.m
trunk/octave-forge/extra/control-devel/inst/btamodred.m
trunk/octave-forge/extra/control-devel/inst/spamodred.m
Modified: trunk/octave-forge/extra/control-devel/inst/__modred_ab09id__.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/__modred_ab09id__.m 2011-12-15 21:30:02 UTC (rev 9400)
+++ trunk/octave-forge/extra/control-devel/inst/__modred_ab09id__.m 2011-12-15 21:49:10 UTC (rev 9401)
@@ -85,10 +85,10 @@
key = lower (varargin{k});
val = varargin{k+1};
switch (key)
- case {"left", "v"}
+ case {"left", "output", "v"}
[av, bv, cv, dv, jobv] = __modred_check_weight__ (val, dt, p, []);
- case {"right", "w"}
+ case {"right", "input", "w"}
[aw, bw, cw, dw, jobw] = __modred_check_weight__ (val, dt, [], m);
case {"order", "n", "nr"}
Modified: trunk/octave-forge/extra/control-devel/inst/btamodred.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/btamodred.m 2011-12-15 21:30:02 UTC (rev 9400)
+++ trunk/octave-forge/extra/control-devel/inst/btamodred.m 2011-12-15 21:49:10 UTC (rev 9401)
@@ -101,6 +101,61 @@
## @end table
## @end table
##
+##
+## @strong{Option Keys and Values}
+## @table @var
+## @item "order", "nr"
+## The desired order of the resulting reduced order system @var{Gr}.
+## If not specified, @var{nr} is chosen automatically.
+##
+## @item "left", "output"
+## LTI model of the left/output frequency weighting.
+## Default value is an identity matrix.
+##
+## @item "right", "input"
+## LTI model of the right/input frequency weighting.
+## Default value is an identity matrix.
+##
+## @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 "alpha"
+## Specifies the ALPHA-stability boundary for the eigenvalues
+## of the state dynamics matrix @var{G.A}. For a continuous-time
+## system, ALPHA <= 0 is the boundary value for
+## the real parts of eigenvalues, while for a discrete-time
+## system, 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 systems and
+## 1 for discrete-time systems.
+##
+## @item "tol1"
+## If @var{"order"} is not specified, @var{tol1} contains the tolerance for
+## determining the order of the reduced model.
+## For model reduction, the recommended value of @var{tol1} is
+## c*info.hsv(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
+## model. TOL2 <= TOL1.
+## If not specified, ns*eps*info.hsv(1) is chosen.
+##
+## @item "equil", "scale"
+## Boolean indicating whether equilibration (scaling) should be
+## performed on system @var{G} prior to order reduction.
+## Default value is true if @code{G.scaled == false} and
+## false if @code{G.scaled == true}.
+## @end table
+##
## @strong{Algorithm}@*
## Uses SLICOT AB09ID by courtesy of
## @uref{http://www.slicot.org, NICONET e.V.}
Modified: trunk/octave-forge/extra/control-devel/inst/spamodred.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/spamodred.m 2011-12-15 21:30:02 UTC (rev 9400)
+++ trunk/octave-forge/extra/control-devel/inst/spamodred.m 2011-12-15 21:49:10 UTC (rev 9401)
@@ -61,6 +61,61 @@
## @end table
## @end table
##
+##
+## @strong{Option Keys and Values}
+## @table @var
+## @item "order", "nr"
+## The desired order of the resulting reduced order system @var{Gr}.
+## If not specified, @var{nr} is chosen automatically.
+##
+## @item "left", "output"
+## LTI model of the left/output frequency weighting.
+## Default value is an identity matrix.
+##
+## @item "right", "input"
+## LTI model of the right/input frequency weighting.
+## Default value is an identity matrix.
+##
+## @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 "alpha"
+## Specifies the ALPHA-stability boundary for the eigenvalues
+## of the state dynamics matrix @var{G.A}. For a continuous-time
+## system, ALPHA <= 0 is the boundary value for
+## the real parts of eigenvalues, while for a discrete-time
+## system, 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 systems and
+## 1 for discrete-time systems.
+##
+## @item "tol1"
+## If @var{"order"} is not specified, @var{tol1} contains the tolerance for
+## determining the order of the reduced model.
+## For model reduction, the recommended value of @var{tol1} is
+## c*info.hsv(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
+## model. TOL2 <= TOL1.
+## If not specified, ns*eps*info.hsv(1) is chosen.
+##
+## @item "equil", "scale"
+## Boolean indicating whether equilibration (scaling) should be
+## performed on system @var{G} prior to order reduction.
+## Default value is true if @code{G.scaled == false} and
+## false if @code{G.scaled == true}.
+## @end table
+##
## @strong{Algorithm}@*
## Uses SLICOT AB09ID 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.
|
