Mercurial > hg > octave-nkf

comparison 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
comparison
equal deleted inserted replaced
11430:6374938b3b36 11431:0d9640d755b1
17 ## You should have received a copy of the GNU General Public License 17 ## You should have received a copy of the GNU General Public License
18 ## along with Octave; see the file COPYING. If not, see 18 ## along with Octave; see the file COPYING. If not, see
19 ## <http://www.gnu.org/licenses/>. 19 ## <http://www.gnu.org/licenses/>.
20 20
21 ## -*- texinfo -*- 21 ## -*- texinfo -*-
22 ## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol}) 22 ## @deftypefn {Function File} {} ishermitian (@var{x})
23 ## Return true if @var{x} is symmetric within the tolerance specified by 23 ## @deftypefnx {Function File} {} ishermitian (@var{x}, @var{tol})
24 ## @var{tol}, 24 ## Return true if @var{x} is Hermitian within the tolerance specified by
25 ## otherwise return false. The default tolerance is zero (uses faster code). 25 ## @var{tol}.
26 ## The default tolerance is zero (uses faster code).
26 ## Matrix @var{x} is considered symmetric if 27 ## Matrix @var{x} is considered symmetric if
27 ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. 28 ## @code{norm (@var{x} - @var{x}', Inf) / norm (@var{x}, Inf) < @var{tol}}.
28 ## @seealso{size, rows, columns, length, ismatrix, isscalar, 29 ## @seealso{issymmetric, isdefinite}
29 ## issquare, isvector}
30 ## @end deftypefn 30 ## @end deftypefn
31 31
32 ## Author: A. S. Hodel <scotte@eng.auburn.edu> 32 ## Author: A. S. Hodel <scotte@eng.auburn.edu>
33 ## Created: August 1993 33 ## Created: August 1993
34 ## Adapted-By: jwe 34 ## Adapted-By: jwe