[Octave-cvsupdate] SF.net SVN: octave:[7650] trunk/octave-forge/main/control/inst

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

Revision: 7650
          http://octave.svn.sourceforge.net/octave/?rev=7650&view=rev
Author:   paramaniac
Date:     2010-09-04 18:18:17 +0000 (Sat, 04 Sep 2010)

Log Message:
-----------
control: upgrade texinfo strings of frequency response functions

Modified Paths:
--------------
    trunk/octave-forge/main/control/inst/bode.m
    trunk/octave-forge/main/control/inst/dcgain.m
    trunk/octave-forge/main/control/inst/freqresp.m
    trunk/octave-forge/main/control/inst/nichols.m
    trunk/octave-forge/main/control/inst/nyquist.m
    trunk/octave-forge/main/control/inst/rlocus.m
    trunk/octave-forge/main/control/inst/sigma.m

Modified: trunk/octave-forge/main/control/inst/bode.m
===================================================================
--- trunk/octave-forge/main/control/inst/bode.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/bode.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -18,7 +18,29 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {[@var{mag}, @var{pha}, @var{w}] =} bode (@var{sys})
 ## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} bode (@var{sys}, @var{w})
-## Bode diagram of LTI model's frequency response.
+## Bode diagram of frequency response. If no output arguments are given,
+## the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI system. Must be a single-input and single-output (SISO) system.
+## @item w
+## Optional vector of frequency values. If @var{w} is not specified, it
+## is calculated by the zeros and poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item mag
+## Vector of magnitude. Has length of frequency vector @var{w}.
+## @item pha
+## Vector of phase. Has length of frequency vector @var{w}.
+## @item w
+## Vector of frequency values used.
+## @end table
+##
+## @seealso{nichols, nyquist, svd}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/dcgain.m
===================================================================
--- trunk/octave-forge/main/control/inst/dcgain.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/dcgain.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -18,6 +18,21 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {@var{k} =} dcgain (@var{sys})
 ## DC gain of LTI model.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item k
+## DC gain matrice. For a system with m inputs and p outputs, the array @var{k}
+## has dimensions [p, m].
+## @end table
+##
+## @seealso{freqresp}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/freqresp.m
===================================================================
--- trunk/octave-forge/main/control/inst/freqresp.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/freqresp.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -17,7 +17,25 @@
 
 ## -*- texinfo -*-
 ## @deftypefn{Function File} {@var{H} =} freqresp (@var{sys}, @var{w})
-## Evaluate frequency response at given frequencies. 
+## Evaluate frequency response at given frequencies.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI system.
+## @item w
+## Vector of frequency values.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item H
+## Array of frequency response. For a system with m inputs and p outputs, the array @var{H}
+## has dimensions [p, m, length (w)].
+## The frequency response at the frequency w(k) is given by H(:,:,k).
+## @end table
+##
+## @seealso{dcgain}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/nichols.m
===================================================================
--- trunk/octave-forge/main/control/inst/nichols.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/nichols.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -18,7 +18,29 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {[@var{mag}, @var{pha}, @var{w}] =} nichols (@var{sys})
 ## @deftypefnx {Function File} {[@var{mag}, @var{pha}, @var{w}] =} nichols (@var{sys}, @var{w})
-## Nichols chart of LTI model's frequency response.
+## Nichols chart of frequency response. If no output arguments are given,
+## the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI system. Must be a single-input and single-output (SISO) system.
+## @item w
+## Optional vector of frequency values. If @var{w} is not specified, it
+## is calculated by the zeros and poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item mag
+## Vector of magnitude. Has length of frequency vector @var{w}.
+## @item pha
+## Vector of phase. Has length of frequency vector @var{w}.
+## @item w
+## Vector of frequency values used.
+## @end table
+##
+## @seealso{bode, nyquist, svd}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/nyquist.m
===================================================================
--- trunk/octave-forge/main/control/inst/nyquist.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/nyquist.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -18,7 +18,29 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {[@var{re}, @var{im}, @var{w}] =} nyquist (@var{sys})
 ## @deftypefnx {Function File} {[@var{re}, @var{im}, @var{w}] =} nyquist (@var{sys}, @var{w})
-## Nyquist diagram of LTI model's frequency response.
+## Nyquist diagram of frequency response. If no output arguments are given,
+## the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI system. Must be a single-input and single-output (SISO) system.
+## @item w
+## Optional vector of frequency values. If @var{w} is not specified, it
+## is calculated by the zeros and poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item re
+## Vector of real parts. Has length of frequency vector @var{w}.
+## @item im
+## Vector of imaginary parts. Has length of frequency vector @var{w}.
+## @item w
+## Vector of frequency values used.
+## @end table
+##
+## @seealso{bode, nichols, svd}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/rlocus.m
===================================================================
--- trunk/octave-forge/main/control/inst/rlocus.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/rlocus.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -59,6 +59,10 @@
 ## Updated by Kristi McGowan July 1996 for intelligent gain selection
 ## Updated by John Ingram July 1996 for systems
 
+## Adapted-By: Lukas Reichlin <luk...@gm...>
+## Date: December 2009
+## Version: 0.1
+
 ## TODO: Improve compatibility
 
 function [rldata_r, k_break, rlpol, gvec, real_ax_pts] = rlocus (sys, increment, min_k, max_k)

Modified: trunk/octave-forge/main/control/inst/sigma.m
===================================================================
--- trunk/octave-forge/main/control/inst/sigma.m	2010-09-04 17:30:43 UTC (rev 7649)
+++ trunk/octave-forge/main/control/inst/sigma.m	2010-09-04 18:18:17 UTC (rev 7650)
@@ -21,13 +21,12 @@
 ## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys}, @var{[]}, @var{ptype})
 ## @deftypefnx{Function File} {[@var{sv}, @var{w}] =} sigma (@var{sys}, @var{w}, @var{ptype})
 ## Singular values of frequency response. If no output arguments are given,
-## the singular value plot of a MIMO system is printed on the screen;
-## otherwise, the singular values of the LTI system are computed and returned.
+## the singular value plot is printed on the screen;
 ##
 ## @strong{Inputs}
 ## @table @var
 ## @item sys
-## LTI system.
+## LTI system. Multiple inputs and/or outputs (MIMO systems) would make practical sense.
 ## @item w
 ## Optional vector of frequency values. If @var{w} is not specified, it
 ## is calculated by the zeros and poles of the system.


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