home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / linear-algebra / rank.m < prev    next >
Text File  |  1999-11-23  |  2KB  |  52 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} {} rank (@var{a}, @var{tol})
  22. ## Compute the rank of @var{a}, using the singular value decomposition.
  23. ## The rank is taken to be the number  of singular values of @var{a} that
  24. ## are greater than the specified tolerance @var{tol}.  If the second
  25. ## argument is omitted, it is taken to be
  26. ## 
  27. ## @example
  28. ## tol = max (size (@var{a})) * sigma (1) * eps;
  29. ## @end example
  30. ## 
  31. ## @noindent
  32. ## where @code{eps} is machine precision and @code{sigma} is the largest
  33. ## singular value of @var{a}.
  34. ## @end deftypefn
  35.  
  36. ## Author: jwe
  37.  
  38. function retval = rank (A, tol)
  39.  
  40.   if (nargin == 1)
  41.     sigma = svd (A);
  42.     tolerance = max (size (A)) * sigma (1) * eps;
  43.   elseif (nargin == 2)
  44.     sigma = svd (A);
  45.     tolerance = tol;
  46.   else
  47.     usage ("rank (A)");
  48.   endif
  49.   retval = sum (sigma > tolerance);
  50.  
  51. endfunction
  52.