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

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

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

Log Message:
-----------
control: improve texinfo strings

Modified Paths:
--------------
    trunk/octave-forge/main/control/src/is_real_matrix.cc
    trunk/octave-forge/main/control/src/is_real_scalar.cc
    trunk/octave-forge/main/control/src/is_real_square_matrix.cc
    trunk/octave-forge/main/control/src/is_real_vector.cc

Removed Paths:
-------------
    trunk/octave-forge/main/control/src/is_ss_mat.cc

Modified: trunk/octave-forge/main/control/src/is_real_matrix.cc
===================================================================
--- trunk/octave-forge/main/control/src/is_real_matrix.cc	2010-09-17 12:10:17 UTC (rev 7742)
+++ trunk/octave-forge/main/control/src/is_real_matrix.cc	2010-09-17 12:18:32 UTC (rev 7743)
@@ -3,8 +3,9 @@
 DEFUN_DLD (is_real_matrix, args, nargout,
    "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} is_real_matrix (@var{a}, @dots{})\n\
-Return true if arguments look like a state-space matrix.\n\
-Avoid nasty stuff like @code{true = isreal (""a"")}\n\
+Return true if argument is a real matrix.\n\
+@var{[]} is a valid matrix.\n\
+Avoid nasty stuff like @code{true = isreal (\"a\")}\n\
 @seealso{is_real_square_matrix, is_real_vector, is_real_scalar}\n\
 @end deftypefn")
 {

Modified: trunk/octave-forge/main/control/src/is_real_scalar.cc
===================================================================
--- trunk/octave-forge/main/control/src/is_real_scalar.cc	2010-09-17 12:10:17 UTC (rev 7742)
+++ trunk/octave-forge/main/control/src/is_real_scalar.cc	2010-09-17 12:18:32 UTC (rev 7743)
@@ -4,7 +4,8 @@
    "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} is_real_scalar (@var{a}, @dots{})\n\
 Return true if argument is a real scalar.\n\
-Avoid nasty stuff like @code{true = isreal (""a"")}\n\
+@var{[]} is not a valid scalar.\n\
+Avoid nasty stuff like @code{true = isreal (\"a\")}\n\
 @seealso{is_real_matrix, is_real_vector}\n\
 @end deftypefn")
 {

Modified: trunk/octave-forge/main/control/src/is_real_square_matrix.cc
===================================================================
--- trunk/octave-forge/main/control/src/is_real_square_matrix.cc	2010-09-17 12:10:17 UTC (rev 7742)
+++ trunk/octave-forge/main/control/src/is_real_square_matrix.cc	2010-09-17 12:18:32 UTC (rev 7743)
@@ -3,8 +3,9 @@
 DEFUN_DLD (is_real_square_matrix, args, nargout,
    "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} is_real_square_matrix (@var{a}, @dots{})\n\
-Return true if arguments look like a square state-space matrix.\n\
-Avoid nasty stuff like @code{true = isreal (""a"")}\n\
+Return true if argument is a real square matrix.\n\
+@var{[]} is a valid square matrix.\n\
+Avoid nasty stuff like @code{true = isreal (\"a\")}\n\
 @seealso{is_real_matrix, is_real_vector, is_real_scalar}\n\
 @end deftypefn")
 {

Modified: trunk/octave-forge/main/control/src/is_real_vector.cc
===================================================================
--- trunk/octave-forge/main/control/src/is_real_vector.cc	2010-09-17 12:10:17 UTC (rev 7742)
+++ trunk/octave-forge/main/control/src/is_real_vector.cc	2010-09-17 12:18:32 UTC (rev 7743)
@@ -4,7 +4,8 @@
    "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} is_real_vwctor (@var{a}, @dots{})\n\
 Return true if argument is a real vector.\n\
-Avoid nasty stuff like @code{true = isreal (""a"")}\n\
+@var{[]} is not a valid vector.\n\
+Avoid nasty stuff like @code{true = isreal (\"a\")}\n\
 @seealso{is_real_square_matrix, is_real_matrix, is_real_scalar}\n\
 @end deftypefn")
 {

Deleted: trunk/octave-forge/main/control/src/is_ss_mat.cc
===================================================================
--- trunk/octave-forge/main/control/src/is_ss_mat.cc	2010-09-17 12:10:17 UTC (rev 7742)
+++ trunk/octave-forge/main/control/src/is_ss_mat.cc	2010-09-17 12:18:32 UTC (rev 7743)
@@ -1,31 +0,0 @@
-#include <octave/oct.h>
-
-DEFUN_DLD (is_ss_mat, args, nargout,
-   "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} is_ss_mat (@var{a}, @dots{})\n\
-Return true if arguents look like a state-space matrix.\n\
-@seealso{isreal, ndims}\n\
-@end deftypefn")
-{
-    octave_value retval = true;
-    int nargin = args.length ();
-
-    if (nargin == 0)
-    {
-        print_usage ();
-    }
-    else
-    {
-        for (int i = 0; i < nargin; i++)
-        {
-            if (args(i).ndims () != 2 || ! args(i).is_numeric_type ()
-                || ! args(i).is_real_type ())
-            {
-                retval = false;
-                break;
-            }
-        }
-    }
-
-    return retval;
-}


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