home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts.fat / general / is_symm.m < prev    next >
Text File  |  1999-12-24  |  2KB  |  51 lines
  1. ## Copyright (C) 1996, 1997 John W. Eaton
  2. ##
  3. ## This file is part of Octave.
  4. ##
  5. ## Octave is free software; you can redistribute it and/or modify it
  6. ## under the terms of the GNU General Public License as published by
  7. ## the Free Software Foundation; either version 2, or (at your option)
  8. ## any later version.
  9. ##
  10. ## Octave is distributed in the hope that it will be useful, but
  11. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13. ## General Public License for more details.
  14. ##
  15. ## You should have received a copy of the GNU General Public License
  16. ## along with Octave; see the file COPYING.  If not, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} is_symm (@var{x}, @var{tol})
  22. ## If @var{x} is symmetric within the tolerance specified by @var{tol}, 
  23. ## then return the dimension of @var{x}.  Otherwise, return 0.  If
  24. ## @var{tol} is omitted, use a tolerance equal to the machine precision.
  25. ## @end deftypefn
  26.  
  27. ## See also: size, rows, columns, length, is_mat, is_scal,
  28. ## is_sqr, is_vec
  29.  
  30. ## Author: A. S. Hodel <scotte@eng.auburn.edu>
  31. ## Created: August 1993
  32. ## Adapted-By: jwe
  33.  
  34. function retval = is_symm (x,tol)
  35.  
  36.   if (nargin == 1 || nargin == 2)
  37.     retval = is_sqr (x);
  38.     if (retval != 0)
  39.       if (nargin == 1)
  40.     tol = eps;
  41.       endif
  42.       if (norm (x - x') / norm(x) > tol)
  43.         retval = 0;
  44.       endif
  45.     endif
  46.   else
  47.     usage ("is_symm (x {,tol})");
  48.   endif
  49.  
  50. endfunction
  51.