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

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

Revision: 9762
          http://octave.svn.sourceforge.net/octave/?rev=9762&view=rev
Author:   paramaniac
Date:     2012-03-07 12:34:04 +0000 (Wed, 07 Mar 2012)
Log Message:
-----------
control-devel: texinfo help strings for concatenation methods

Modified Paths:
--------------
    trunk/octave-forge/extra/control-devel/inst/@iddata/horzcat.m
    trunk/octave-forge/extra/control-devel/inst/@iddata/merge.m
    trunk/octave-forge/extra/control-devel/inst/@iddata/vertcat.m

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/horzcat.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/horzcat.m	2012-03-07 10:14:59 UTC (rev 9761)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/horzcat.m	2012-03-07 12:34:04 UTC (rev 9762)
@@ -16,8 +16,13 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{dat} =} cat (@var{dim}, @var{dat1}, @var{dat2}, @dots{})
-## Concatenation of iddata objects along dimension @var{dim}.
+## @deftypefn {Function File} {@var{dat} =} horzcat (@var{dat1}, @var{dat2}, @dots{})
+## Horizontal concatenation of iddata datasets.
+## The outputs and inputs are concatenated in the following way:
+## @code{dat.y@{e@} = [dat1.y@{e@}, dat2.y@{e@}, @dots{}]}
+## @code{dat.u@{e@} = [dat1.u@{e@}, dat2.u@{e@}, @dots{}]}
+## where @var{e} denotes the experiment.
+## The number of experiments and samples must be equal for all datasets.
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/merge.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/merge.m	2012-03-07 10:14:59 UTC (rev 9761)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/merge.m	2012-03-07 12:34:04 UTC (rev 9762)
@@ -16,8 +16,12 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{dat} =} cat (@var{dim}, @var{dat1}, @var{dat2}, @dots{})
-## Concatenation of iddata objects along dimension @var{dim}.
+## @deftypefn {Function File} {@var{dat} =} vertcat (@var{dat1}, @var{dat2}, @dots{})
+## Concatenate experiments of iddata datasets.
+## The experiments are concatenated in the following way:
+## @code{dat.y = [dat1.y; dat2.y; @dots{}]}
+## @code{dat.u = [dat1.u; dat2.u; @dots{}]}
+## The number of outputs and inputs must be equal for all datasets.
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/vertcat.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/vertcat.m	2012-03-07 10:14:59 UTC (rev 9761)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/vertcat.m	2012-03-07 12:34:04 UTC (rev 9762)
@@ -16,8 +16,13 @@
 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{dat} =} cat (@var{dim}, @var{dat1}, @var{dat2}, @dots{})
-## Concatenation of iddata objects along dimension @var{dim}.
+## @deftypefn {Function File} {@var{dat} =} vertcat (@var{dat1}, @var{dat2}, @dots{})
+## Vertical concatenation of iddata datasets.
+## The samples are concatenated in the following way:
+## @code{dat.y@{e@} = [dat1.y@{e@}; dat2.y@{e@}; @dots{}]}
+## @code{dat.u@{e@} = [dat1.u@{e@}; dat2.u@{e@}; @dots{}]}
+## where @var{e} denotes the experiment.
+## The number of experiments, outputs and inputs must be equal for all datasets.
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

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