[Octave-cvsupdate] SF.net SVN: octave:[10131] trunk/octave-forge/extra/control-devel/inst/@ iddata

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

Revision: 10131
          http://octave.svn.sourceforge.net/octave/?rev=10131&view=rev
Author:   paramaniac
Date:     2012-04-02 15:17:42 +0000 (Mon, 02 Apr 2012)
Log Message:
-----------
control-devel: texinfo help for iddata

Modified Paths:
--------------
    trunk/octave-forge/extra/control-devel/inst/@iddata/cat.m
    trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m
    trunk/octave-forge/extra/control-devel/inst/@iddata/set.m

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/cat.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/cat.m	2012-04-02 11:36:12 UTC (rev 10130)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/cat.m	2012-04-02 15:17:42 UTC (rev 10131)
@@ -58,7 +58,7 @@
 ## @strong{Outputs}
 ## @table @var
 ## @item dat
-## iddata set.
+## Concatenated iddata set.
 ## @end table
 ##
 ## @seealso{horzcat, merge, vertcat}

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m	2012-04-02 11:36:12 UTC (rev 10130)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m	2012-04-02 15:17:42 UTC (rev 10131)
@@ -16,40 +16,42 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn{Function File} {@var{dat} =} iddata (@var{y}, @var{u})
-## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{tsam})
-## Fit frequency response data with a state-space system.
-## If requested, the returned system is stable and minimum-phase.
+## @deftypefn{Function File} {@var{dat} =} iddata (@var{y})
+## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u})
+## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{tsam}, @dots{})
+## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{[]}, @dots{})
+## Create identification dataset of output and input signals.
 ##
 ## @strong{Inputs}
 ## @table @var
-## @item dat
-## LTI model containing frequency response data of a SISO system.
-## @item n
-## The desired order of the system to be fitted.  @code{n <= length(dat.w)}.
-## @item flag
-## The flag controls whether the returned system is stable and minimum-phase.
-## @table @var
-## @item 0
-## The system zeros and poles are not constrained.  Default value.
-## @item 1
-## The system zeros and poles will have negative real parts in the
-## continuous-time case, or moduli less than 1 in the discrete-time case.
+## @item y
+## Real matrix containing the output signal in time-domain.
+## For a system with @var{p} outputs and @var{n} samples,
+## @var{y} is a n-by-p matrix.
+## For data from multiple experiments, @var{y} becomes a
+## e-by-1 or 1-by-e cell vector of n(i)-by-p matrices,
+## where @var{e} denotes the number of experiments
+## and n(i) the individual number of samples for each experiment.
+## @item u
+## Real matrix containing the input signal in time-domain.
+## For a system with @var{m} inputs and @var{n} samples,
+## @var{u} is a n-by-m matrix.
+## For data from multiple experiments, @var{u} becomes a
+## e-by-1 or 1-by-e cell vector of n(i)-by-m matrices,
+## where @var{e} denotes the number of experiments
+## and n(i) the individual number of samples for each experiment.
+## @item tsam
+## Sampling time.
+## @item @dots{}
+## Optional pairs of properties and values.
 ## @end table
-## @end table
 ##
 ## @strong{Outputs}
 ## @table @var
-## @item sys
-## State-space model of order @var{n}, fitted to frequency response data @var{dat}.
-## @item n
-## The order of the obtained system.  The value of @var{n}
-## could only be modified if inputs @code{n > 0} and @code{flag = 1}.
+## @item dat
+## iddata identification dataset.
 ## @end table
 ##
-## @strong{Algorithm}@*
-## Uses SLICOT SB10YD by courtesy of
-## @uref{http://www.slicot.org, NICONET e.V.}
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/set.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/set.m	2012-04-02 11:36:12 UTC (rev 10130)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/set.m	2012-04-02 15:17:42 UTC (rev 10131)
@@ -85,19 +85,21 @@
         case {"inunit", "inputunit"}
           dat.inunit = __adjust_labels__ (val, m);
         case {"timeunit"}
-          dat.timeunit
+          if (ischar (val))
+            dat.timeunit = val;
+          else
+            error ("iddata: set: property 'timeunit' requires a string");
+          endif
         case {"expname", "experimentname"}
           dat.expname = __adjust_labels__ (val, e);
         case {"tsam", "ts"}
           dat.tsam = __adjust_iddata_tsam__ (val, e);
-
         case "name"
           if (ischar (val))
             sys.name = val;
           else
-            error ("lti: set: property 'name' requires a string");
+            error ("iddata: set: property 'name' requires a string");
           endif
-
         case "notes"
           if (iscellstr (val))
             sys.notes = val;
@@ -106,10 +108,8 @@
           else
             error ("lti: set: property 'notes' requires string or cell of strings");
           endif
-
         case "userdata"
           sys.userdata = val;
-
         otherwise
           error ("iddata: set: invalid property name '%s'", varargin{k});
       endswitch

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