Mercurial > octave

diff scripts/linear-algebra/ishermitian.m @ 11431:0d9640d755b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docstrings for all isXXX functions. Use 'return true' rather than 'return 1'. Improve the cross-referencing through seealso links.
author Rik <octave@nomad.inbox5.com>
date Fri, 31 Dec 2010 13:20:44 -0800
parents be55736a0783
children fd0a3ac60b0e
line wrap: on
line diff
--- a/scripts/linear-algebra/ishermitian.m	Fri Dec 31 09:56:44 2010 -0800
+++ b/scripts/linear-algebra/ishermitian.m	Fri Dec 31 13:20:44 2010 -0800
@@ -19,14 +19,14 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol})
-## Return true if @var{x} is symmetric within the tolerance specified by
-## @var{tol},
-## otherwise return false.  The default tolerance is zero (uses faster code).
+## @deftypefn  {Function File} {} ishermitian (@var{x})
+## @deftypefnx {Function File} {} ishermitian (@var{x}, @var{tol})
+## Return true if @var{x} is Hermitian within the tolerance specified by
+## @var{tol}.
+## The default tolerance is zero (uses faster code).
 ## Matrix @var{x} is considered symmetric if
-## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}.
-## @seealso{size, rows, columns, length, ismatrix, isscalar,
-## issquare, isvector}
+## @code{norm (@var{x} - @var{x}', Inf) / norm (@var{x}, Inf) < @var{tol}}.
+## @seealso{issymmetric, isdefinite}
 ## @end deftypefn
 
 ## Author: A. S. Hodel <scotte@eng.auburn.edu>