Mercurial > octave
view scripts/general/is_symmetric.m @ 3426:f8dde1807dee
[project @ 2000-01-13 08:40:00 by jwe]
author | jwe |
---|---|
date | Thu, 13 Jan 2000 08:40:53 +0000 |
parents | ae7adbb591e8 |
children |
line wrap: on
line source
## Copyright (C) 1996, 1997 John W. Eaton ## ## 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 2, 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, write to the Free ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. ## -*- texinfo -*- ## @deftypefn {Function File} {} is_symmetric (@var{x}, @var{tol}) ## If @var{x} is symmetric within the tolerance specified by @var{tol}, ## then return the dimension of @var{x}. Otherwise, return 0. If ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## @end deftypefn ## @seealso{size, rows, columns, length, is_matrix, is_scalar, ## is_square, and is_vector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993 ## Adapted-By: jwe function retval = is_symmetric (x,tol) if (nargin == 1 || nargin == 2) retval = is_square (x); if (retval != 0) if (nargin == 1) tol = eps; endif if (norm (x - x') / norm(x) > tol) retval = 0; endif endif else usage ("is_symmetric (x {,tol})"); endif endfunction