Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7852] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-10-16 22:45:42
|
Revision: 7852
http://octave.svn.sourceforge.net/octave/?rev=7852&view=rev
Author: paramaniac
Date: 2010-10-16 22:45:35 +0000 (Sat, 16 Oct 2010)
Log Message:
-----------
control: doc fixes
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-10-16 22:10:19 UTC (rev 7851)
+++ trunk/octave-forge/main/control/inst/augw.m 2010-10-16 22:45:35 UTC (rev 7852)
@@ -17,7 +17,7 @@
## -*- texinfo -*-
## @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
+## Extend plant for stacked S/KS/T problem. Subsequently, the robust control problem
## can be solved by h2syn or hinfsyn.
##
## @strong{Inputs}
@@ -25,16 +25,19 @@
## @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.
+## LTI model of performance weight. Bounds the largest singular values of sensitivity @var{S}.
+## Model must be empty @code{[]}, 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.
+## LTI model to penalize large control inputs. Bounds the largest singular values of @var{KS}.
+## Model must be empty @code{[]}, 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.
+## LTI model of robustness and noise sensitivity weight. Bounds the largest singular values of
+## complementary sensitivity @var{T}. Model must be empty @code{[]}, SISO or of appropriate size.
## @end table
##
+## All inputs must be proper/realizable.
+## Scalars, vectors and matrices are possible instead of LTI models.
+##
## @strong{Outputs}
## @table @var
## @item P
Modified: trunk/octave-forge/main/control/inst/h2syn.m
===================================================================
--- trunk/octave-forge/main/control/inst/h2syn.m 2010-10-16 22:10:19 UTC (rev 7851)
+++ trunk/octave-forge/main/control/inst/h2syn.m 2010-10-16 22:45:35 UTC (rev 7852)
@@ -24,14 +24,14 @@
## @strong{Inputs}
## @table @var
## @item P
-## Generalized plant.
+## Generalized plant. Must be a proper/realizable LTI model.
## @item nmeas
-## 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
+## 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 @var{P} are connected to the
-## outputs of controller @var{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
##
Modified: trunk/octave-forge/main/control/inst/hinfsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/hinfsyn.m 2010-10-16 22:10:19 UTC (rev 7851)
+++ trunk/octave-forge/main/control/inst/hinfsyn.m 2010-10-16 22:45:35 UTC (rev 7852)
@@ -25,17 +25,17 @@
## @strong{Inputs}
## @table @var
## @item P
-## Generalized plant.
+## Generalized plant. Must be a proper/realizable LTI model.
## @item nmeas
-## 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
+## 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 @var{P} are connected to the
-## outputs of controller @var{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 @var{N}. It is assumed that @var{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
##
Modified: trunk/octave-forge/main/control/inst/mixsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/mixsyn.m 2010-10-16 22:10:19 UTC (rev 7851)
+++ trunk/octave-forge/main/control/inst/mixsyn.m 2010-10-16 22:45:35 UTC (rev 7852)
@@ -17,11 +17,11 @@
## -*- texinfo -*-
## @deftypefn{Function File} {[@var{K}, @var{N}, @var{gamma}] =} mixsyn (@var{G}, @var{W1}, @var{W2}, @var{W3}, @dots{})
-## 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).
+## Solve stacked S/KS/T H-inf problem. Bound the largest singular values
+## of @var{S} (for performance), @var{K S} (to penalize large inputs) and
+## @var{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
+## Then the algorithm tries to find a controller @var{K} which minimizes
## the H-infinity norm calculated from the outputs z.
##
## @strong{Inputs}
@@ -29,16 +29,21 @@
## @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 or proper, SISO or of appropriate size.
+## LTI model of performance weight. Bounds the largest singular values of sensitivity @var{S}.
+## Model must be empty @code{[]}, 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 or proper, SISO or of appropriate size.
+## LTI model to penalize large control inputs. Bounds the largest singular values of @var{KS}.
+## Model must be empty @code{[]}, 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 or proper, SISO or of appropriate size.
+## LTI model of robustness and noise sensitivity weight. Bounds the largest singular values of
+## complementary sensitivity @var{T}. Model must be empty @code{[]}, SISO or of appropriate size.
+## @item @dots{}
+## Optional arguments of @command {hinfsyn}. Type @command{help hinfsyn} for more information.
## @end table
##
+## All inputs must be proper/realizable.
+## Scalars, vectors and matrices are possible instead of LTI models.
+##
## @strong{Outputs}
## @table @var
## @item K
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
