Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7651] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-09-04 18:56:25
|
Revision: 7651
http://octave.svn.sourceforge.net/octave/?rev=7651&view=rev
Author: paramaniac
Date: 2010-09-04 18:56:19 +0000 (Sat, 04 Sep 2010)
Log Message:
-----------
control: upgrade texinfo strings of robust control functions
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/augw.m
trunk/octave-forge/main/control/inst/h2syn.m
trunk/octave-forge/main/control/inst/hinfsyn.m
trunk/octave-forge/main/control/inst/mixsyn.m
Modified: trunk/octave-forge/main/control/inst/augw.m
===================================================================
--- trunk/octave-forge/main/control/inst/augw.m 2010-09-04 18:18:17 UTC (rev 7650)
+++ trunk/octave-forge/main/control/inst/augw.m 2010-09-04 18:56:19 UTC (rev 7651)
@@ -19,6 +19,28 @@
## @deftypefn{Function File} {@var{P} =} augw (@var{G}, @var{W1}, @var{W2}, @var{W3})
## Extend plant for stacked S/KS/T problem. Subsequently, the robust control problem
## can be solved by h2syn or hinfsyn.
+##
+## @strong{Inputs}
+## @table @var
+## @item G
+## LTI model of plant.
+## @item W1
+## LTI model of performance weight. Bounds the largest singular values of sensitivity @var{S}.
+## Model must be empty, SISO or of appropriate size.
+## @item W2
+## LTI model to penalize large control inputs. Bounds the largest singular values of @var{KS}.
+## Model must be empty, SISO or of appropriate size.
+## @item W3
+## LTI model of robustness and noise sensitivity weight. Bounds the largest singular values of
+## complementary sensitivity @var{T}. Model must be empty, SISO or of appropriate size.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item P
+## State-space model of augmented plant.
+## @end table
+##
## @example
## @group
##
Modified: trunk/octave-forge/main/control/inst/h2syn.m
===================================================================
--- trunk/octave-forge/main/control/inst/h2syn.m 2010-09-04 18:18:17 UTC (rev 7650)
+++ trunk/octave-forge/main/control/inst/h2syn.m 2010-09-04 18:56:19 UTC (rev 7651)
@@ -26,12 +26,12 @@
## @item P
## Generalized plant.
## @item nmeas
-## Number of measured outputs e. The last nmeas outputs of P are connected to the
-## inputs of controller K. The remaining outputs z (indices 1 to p-nmeas) are used
+## Number of measured outputs e. The last nmeas outputs of @var{P} are connected to the
+## inputs of controller @var{K}. The remaining outputs z (indices 1 to p-nmeas) are used
## to calculate the H-2 norm.
## @item ncon
-## Number of controlled inputs u. The last ncon inputs of P are connected to the
-## outputs of controller K. The remaining inputs r (indices 1 to m-ncon) are excited
+## Number of controlled inputs u. The last ncon inputs of @var{P} are connected to the
+## outputs of controller @var{K}. The remaining inputs r (indices 1 to m-ncon) are excited
## by a harmonic test signal.
## @end table
##
@@ -40,9 +40,9 @@
## @item K
## State-space model of the H-2 optimal controller.
## @item N
-## State-space model of the lower LFT of P and K.
+## State-space model of the lower LFT of @var{P} and @var{K}.
## @item gamma
-## H-2 norm of N.
+## H-2 norm of @var{N}.
## @end table
##
## @example
Modified: trunk/octave-forge/main/control/inst/hinfsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/hinfsyn.m 2010-09-04 18:18:17 UTC (rev 7650)
+++ trunk/octave-forge/main/control/inst/hinfsyn.m 2010-09-04 18:56:19 UTC (rev 7651)
@@ -27,15 +27,15 @@
## @item P
## Generalized plant.
## @item nmeas
-## Number of measured outputs e. The last nmeas outputs of P are connected to the
-## inputs of controller K. The remaining outputs z (indices 1 to p-nmeas) are used
+## Number of measured outputs e. The last nmeas outputs of @var{P} are connected to the
+## inputs of controller @var{K}. The remaining outputs z (indices 1 to p-nmeas) are used
## to calculate the H-infinity norm.
## @item ncon
-## Number of controlled inputs u. The last ncon inputs of P are connected to the
-## outputs of controller K. The remaining inputs r (indices 1 to m-ncon) are excited
+## Number of controlled inputs u. The last ncon inputs of @var{P} are connected to the
+## outputs of controller @var{K}. The remaining inputs r (indices 1 to m-ncon) are excited
## by a harmonic test signal.
## @item gmax
-## The maximum value of the H-infinity norm of N. It is assumed that gmax is
+## The maximum value of the H-infinity norm of @var{N}. It is assumed that @var{gmax} is
## sufficiently large so that the controller is admissible.
## @end table
##
@@ -44,9 +44,9 @@
## @item K
## State-space model of the H-infinity (sub-)optimal controller.
## @item N
-## State-space model of the lower LFT of P and K.
+## State-space model of the lower LFT of @var{P} and @var{K}.
## @item gamma
-## L-infinity norm of N.
+## L-infinity norm of @var{N}.
## @end table
##
## @example
Modified: trunk/octave-forge/main/control/inst/mixsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/mixsyn.m 2010-09-04 18:18:17 UTC (rev 7650)
+++ trunk/octave-forge/main/control/inst/mixsyn.m 2010-09-04 18:56:19 UTC (rev 7651)
@@ -17,12 +17,38 @@
## -*- texinfo -*-
## @deftypefn{Function File} {[@var{K}, @var{N}, @var{gamma}] =} mixsyn (@var{G}, @var{W1}, @var{W2}, @var{W3})
-## Solve stacked S/KS/T H-inf problem, i.e. bound the largest singular values
+## Solve stacked S/KS/T H-inf problem. Bound the largest singular values
## of S (for performance), K S (to penalize large inputs) and
## T (for robustness and to avoid sensitivity to noise).
## In other words, the inputs r are excited by a harmonic test signal.
## Then the algorithm tries to find a controller K which minimizes
-## the H-infinity norm calculated from the outputs z.
+## the H-infinity norm calculated from the outputs z.
+##
+## @strong{Inputs}
+## @table @var
+## @item G
+## LTI model of plant.
+## @item W1
+## LTI model of performance weight. Bounds the largest singular values of sensitivity @var{S}.
+## Model must be empty, SISO or of appropriate size.
+## @item W2
+## LTI model to penalize large control inputs. Bounds the largest singular values of @var{KS}.
+## Model must be empty, SISO or of appropriate size.
+## @item W3
+## LTI model of robustness and noise sensitivity weight. Bounds the largest singular values of
+## complementary sensitivity @var{T}. Model must be empty, SISO or of appropriate size.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item K
+## State-space model of the H-infinity (sub-)optimal controller.
+## @item N
+## State-space model of the lower LFT of @var{P} and @var{K}.
+## @item gamma
+## L-infinity norm of @var{N}.
+## @end table
+##
## @example
## @group
##
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
