Mercurial > octave-libgccjit
view scripts/linear-algebra/ishermitian.m @ 18921:d0d0858cfab1
doc: Match docstring variable names to function variable names for linear-algebra m-files.
* isbanded.m, isdefinite.m, isdiag.m, ishermitian.m, issymmetric.m, istril.m,
istriu.m: Use 'A' for input matrix in linear algebra routines. Change docstrings
from 'x' to 'A'.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 14 Jul 2014 08:54:45 -0700 |
parents | d63878346099 |
children |
line wrap: on
line source
## Copyright (C) 1996-2013 John W. Eaton ## Copyright (C) 2009 VZLU Prague ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} ishermitian (@var{A}) ## @deftypefnx {Function File} {} ishermitian (@var{A}, @var{tol}) ## Return true if @var{A} is Hermitian within the tolerance specified by ## @var{tol}. ## ## The default tolerance is zero (uses faster code). ## Matrix @var{A} is considered symmetric if ## @code{norm (@var{A} - @var{A}', Inf) / norm (@var{A}, Inf) < @var{tol}}. ## @seealso{issymmetric, isdefinite} ## @end deftypefn ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993 ## Adapted-By: jwe function retval = ishermitian (A, tol = 0) if (nargin < 1 || nargin > 2) print_usage (); endif retval = isnumeric (A) && issquare (A); if (retval) if (tol == 0) retval = all ((A == A')(:)); else norm_x = norm (A, inf); retval = norm_x == 0 || norm (A - A', inf) / norm_x <= tol; endif endif endfunction %!assert (ishermitian (1)) %!assert (! ishermitian ([1, 2])) %!assert (ishermitian ([])) %!assert (ishermitian ([1, 2; 2, 1])) %!assert (! ishermitian ("test")) %!assert (ishermitian ([1, 2.1; 2, 1.1], 0.2)) %!assert (ishermitian ([1, -2i; 2i, 1])) %!assert (! ishermitian ("t")) %!assert (! ishermitian (["te"; "et"])) %!test %! s.a = 1; %! assert (! ishermitian (s)); %!error ishermitian ([1, 2; 2, 1], 0, 0) %!error ishermitian ()