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

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

Revision: 8368
          http://octave.svn.sourceforge.net/octave/?rev=8368&view=rev
Author:   paramaniac
Date:     2011-06-29 21:42:44 +0000 (Wed, 29 Jun 2011)

Log Message:
-----------
control: add texinfo strings

Modified Paths:
--------------
    trunk/octave-forge/main/control/inst/@lti/prescale.m
    trunk/octave-forge/main/control/inst/@ss/__prescale__.m
    trunk/octave-forge/main/control/inst/@ss/__property_names__.m

Modified: trunk/octave-forge/main/control/inst/@lti/prescale.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/prescale.m	2011-06-29 18:47:23 UTC (rev 8367)
+++ trunk/octave-forge/main/control/inst/@lti/prescale.m	2011-06-29 21:42:44 UTC (rev 8368)
@@ -17,7 +17,40 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {[@var{scaledsys}, @var{info}] =} prescale (@var{sys})
-## Prescale
+## Prescale state-space model.
+## Uses SLICOT TB01ID and TG01AD by courtesy of
+## @uref{NICONET e.V., http://www.slicot.org}
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item scaledsys
+## Scaled state-space model.
+## @item info
+## Structure containig additional information.
+## @item info.SL
+## Left scaling factors.  @code{Tl = diag (info.SL)}.
+## @item info.SR
+## Right scaling factors.  @code{Tr = diag (info.SR)}.
+## @end table
+##
+## @strong{Equations}
+## @example
+## @group
+## Es = Tl E Tr
+## As = Tl A Tr
+## Bs = Tl B
+## Cs =    C Tr
+## Ds =    D
+##
+## For proper state-space models, Tl and Tr are inverse of each other.
+## @end group
+## @end example
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

Modified: trunk/octave-forge/main/control/inst/@ss/__prescale__.m
===================================================================
--- trunk/octave-forge/main/control/inst/@ss/__prescale__.m	2011-06-29 18:47:23 UTC (rev 8367)
+++ trunk/octave-forge/main/control/inst/@ss/__prescale__.m	2011-06-29 21:42:44 UTC (rev 8368)
@@ -1,3 +1,27 @@
+## Copyright (C) 2011   Lukas F. Reichlin
+##
+## This file is part of LTI Syncope.
+##
+## LTI Syncope is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## LTI Syncope is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## Prescaling
+
+## Author: Lukas Reichlin <luk...@gm...>
+## Created: June 2011
+## Version: 0.1
+
 function [retsys, lscale, rscale] = __prescale__ (sys, optarg = 0.0)
 
   if (isempty (sys.e))

Modified: trunk/octave-forge/main/control/inst/@ss/__property_names__.m
===================================================================
--- trunk/octave-forge/main/control/inst/@ss/__property_names__.m	2011-06-29 18:47:23 UTC (rev 8367)
+++ trunk/octave-forge/main/control/inst/@ss/__property_names__.m	2011-06-29 21:42:44 UTC (rev 8368)
@@ -43,7 +43,7 @@
           "p-by-m matrix";
           "n-by-n matrix";
           "n-by-1 cell vector of strings";
-          "1-by-1 logical value"};
+          "scalar logical value"};
 
   if (nargin == 1)
     [ltiprops, ltivals] = __property_names__ (sys.lti);


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