Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7751] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-09-17 23:02:32
|
Revision: 7751
http://octave.svn.sourceforge.net/octave/?rev=7751&view=rev
Author: paramaniac
Date: 2010-09-17 23:02:26 +0000 (Fri, 17 Sep 2010)
Log Message:
-----------
control: doc fix
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/@ss/ss.m
trunk/octave-forge/main/control/inst/@tf/tf.m
trunk/octave-forge/main/control/inst/dss.m
trunk/octave-forge/main/control/inst/mixsyn.m
Modified: trunk/octave-forge/main/control/inst/@ss/ss.m
===================================================================
--- trunk/octave-forge/main/control/inst/@ss/ss.m 2010-09-17 21:39:33 UTC (rev 7750)
+++ trunk/octave-forge/main/control/inst/@ss/ss.m 2010-09-17 23:02:26 UTC (rev 7751)
@@ -19,23 +19,26 @@
## @deftypefn {Function File} {@var{sys} =} ss (@var{sys})
## @deftypefnx {Function File} {@var{sys} =} ss (@var{d})
## @deftypefnx {Function File} {@var{sys} =} ss (@var{a}, @var{b}, @var{c})
-## @deftypefnx {Function File} {@var{sys} =} ss (@var{a}, @var{b}, @var{c}, @var{d})
-## @deftypefnx {Function File} {@var{sys} =} ss (@var{a}, @var{b}, @var{c}, @var{d}, @var{tsam})
+## @deftypefnx {Function File} {@var{sys} =} ss (@var{a}, @var{b}, @var{c}, @var{d}, @dots{})
+## @deftypefnx {Function File} {@var{sys} =} ss (@var{a}, @var{b}, @var{c}, @var{d}, @var{tsam}, @dots{})
## Create or convert to state-space model.
##
## @strong{Inputs}
## @table @var
## @item a
-## State transition matrix.
+## State transition matrix (n-by-n).
## @item b
-## Input matrix.
+## Input matrix (n-by-m).
## @item c
-## Measurement matrix.
+## Measurement matrix (p-by-n).
## @item d
-## Feedthrough matrix.
+## Feedthrough matrix (p-by-m).
## @item tsam
## Sampling time. If @var{tsam} is not specified, a continuous-time
## model is assumed.
+## @item @dots{}
+## Optional pairs of properties and values.
+## Type @command{set (ss)} for more information.
## @end table
##
## @strong{Outputs}
@@ -44,7 +47,7 @@
## State-space model.
## @end table
##
-## @seealso{tf}
+## @seealso{tf, dss}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/@tf/tf.m
===================================================================
--- trunk/octave-forge/main/control/inst/@tf/tf.m 2010-09-17 21:39:33 UTC (rev 7750)
+++ trunk/octave-forge/main/control/inst/@tf/tf.m 2010-09-17 23:02:26 UTC (rev 7751)
@@ -19,8 +19,8 @@
## @deftypefn {Function File} {@var{s} =} tf (@var{"s"})
## @deftypefnx {Function File} {@var{z} =} tf (@var{"z"}, @var{tsam})
## @deftypefnx {Function File} {@var{sys} =} tf (@var{sys})
-## @deftypefnx {Function File} {@var{sys} =} tf (@var{num}, @var{den})
-## @deftypefnx {Function File} {@var{sys} =} tf (@var{num}, @var{den}, @var{tsam})
+## @deftypefnx {Function File} {@var{sys} =} tf (@var{num}, @var{den}, @dots{})
+## @deftypefnx {Function File} {@var{sys} =} tf (@var{num}, @var{den}, @var{tsam}, @dots{})
## Create or convert to transfer function model.
##
## @strong{Inputs}
@@ -34,6 +34,9 @@
## @item tsam
## Sampling time. If @var{tsam} is not specified, a continuous-time
## model is assumed.
+## @item @dots{}
+## Optional pairs of properties and values.
+## Type @command{set (tf)} for more information.
## @end table
##
## @strong{Outputs}
@@ -49,7 +52,7 @@
## @end group
## @end example
##
-## @seealso{ss}
+## @seealso{ss, dss}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/dss.m
===================================================================
--- trunk/octave-forge/main/control/inst/dss.m 2010-09-17 21:39:33 UTC (rev 7750)
+++ trunk/octave-forge/main/control/inst/dss.m 2010-09-17 23:02:26 UTC (rev 7751)
@@ -18,25 +18,28 @@
## -*- texinfo -*-
## @deftypefn {Function File} {@var{sys} =} dss (@var{sys})
## @deftypefnx {Function File} {@var{sys} =} dss (@var{d})
-## @deftypefnx {Function File} {@var{sys} =} dss (@var{a}, @var{b}, @var{c}, @var{d}, @var{e})
-## @deftypefnx {Function File} {@var{sys} =} dss (@var{a}, @var{b}, @var{c}, @var{d}, @var{e}, @var{tsam})
-## Create or convert to state-space model.
+## @deftypefnx {Function File} {@var{sys} =} dss (@var{a}, @var{b}, @var{c}, @var{d}, @var{e}, @dots{})
+## @deftypefnx {Function File} {@var{sys} =} dss (@var{a}, @var{b}, @var{c}, @var{d}, @var{e}, @var{tsam}, @dots{})
+## Create or convert to descriptor state-space model.
##
## @strong{Inputs}
## @table @var
## @item a
-## State transition matrix.
+## State transition matrix (n-by-n).
## @item b
-## Input matrix.
+## Input matrix (n-by-m).
## @item c
-## Measurement matrix.
+## Measurement matrix (p-by-n).
## @item d
-## Feedthrough matrix.
+## Feedthrough matrix (p-by-m).
## @item e
-## Descriptor matrix.
+## Descriptor matrix (n-by-n).
## @item tsam
## Sampling time. If @var{tsam} is not specified, a continuous-time
## model is assumed.
+## @item @dots{}
+## Optional pairs of properties and values.
+## Type @command{set (dss)} for more information.
## @end table
##
## @strong{Outputs}
@@ -45,7 +48,7 @@
## Descriptor state-space model.
## @end table
##
-## @seealso{ss}
+## @seealso{ss, tf}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
@@ -55,14 +58,25 @@
function sys = dss (varargin)
switch (nargin)
- case {0, 2, 3, 4}
- print_usage ();
+ case 0 # useful for "set (dss)"
+ sys = ss ();
case 1 # static gain
sys = ss (varargin{1});
+ case {2, 3, 4}
+ print_usage ();
+
otherwise # general case
sys = ss (varargin{[1:4, 6:end]}, "e", varargin{5});
endswitch
-endfunction
\ No newline at end of file
+endfunction
+
+## NOTE: The author prefers "dss (e, a, b, c, d)" since we write
+## .
+## E x = A x + B u, y = C x + D u
+##
+## but this would break compatibility to a widespread
+## commercial implementation of the octave language.
+## There's no way to tell e and d apart if n = m = p.
\ No newline at end of file
Modified: trunk/octave-forge/main/control/inst/mixsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/mixsyn.m 2010-09-17 21:39:33 UTC (rev 7750)
+++ trunk/octave-forge/main/control/inst/mixsyn.m 2010-09-17 23:02:26 UTC (rev 7751)
@@ -16,7 +16,7 @@
## along with this program. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn{Function File} {[@var{K}, @var{N}, @var{gamma}] =} mixsyn (@var{G}, @var{W1}, @var{W2}, @var{W3})
+## @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).
@@ -30,13 +30,13 @@
## 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.
+## Model must be empty or proper, 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.
+## Model must be empty or proper, 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.
+## complementary sensitivity @var{T}. Model must be empty or proper, SISO or of appropriate size.
## @end table
##
## @strong{Outputs}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
