home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / specfun / log2.m < prev    next >
Encoding:
Text File  |  1999-10-26  |  1.8 KB  |  60 lines
  1. ## Copyright (C) 1995, 1996  Kurt Hornik
  2. ## 
  3. ## This program is free software; you can redistribute it and/or modify
  4. ## it under the terms of the GNU General Public License as published by
  5. ## the Free Software Foundation; either version 2, or (at your option)
  6. ## any later version.
  7. ## 
  8. ## This program is distributed in the hope that it will be useful, but
  9. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11. ## General Public License for more details. 
  12. ## 
  13. ## You should have received a copy of the GNU General Public License
  14. ## along with this file.  If not, write to the Free Software Foundation,
  15. ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  16.  
  17. ## -*- texinfo -*-
  18. ## @deftypefn {Mapping Function} {@var{y} =} log2 (@var{x})
  19. ## @deftypefnx {Mapping Function} {[@var{f}, @var{e}]} log2 (@var{x})
  20. ## Compute the base-2 logarithm of @var{x}.  With two outputs, returns
  21. ## @var{f} and @var{e} such that
  22. ## @iftex
  23. ## @tex
  24. ##  $1/2 <= |f| < 1$ and $x = f \cdot 2^e$.
  25. ## @end tex
  26. ## @end iftex
  27. ## @ifinfo
  28. ##  1/2 <= abs(f) < 1 and x = f * 2^e.
  29. ## @end ifinfo
  30. ## @end deftypefn
  31.  
  32. ## See also: log, log10, logspace, exp
  33.  
  34. ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
  35. ## Created: 17 October 1994
  36. ## Adapted-By: jwe
  37.  
  38. function [f, e] = log2 (x)
  39.  
  40.   if (nargin != 1)
  41.     usage ("y = log2 (x) or [f, e] = log2 (x)");
  42.   endif
  43.  
  44.   if (nargout < 2)
  45.     f = log (x) / log (2);
  46.   elseif (nargout == 2)
  47.     ## Only deal with the real parts ...
  48.     x = real (x);
  49.     ## Since log (0) gives problems, 0 entries are replaced by 1.  
  50.     ## This is corrected later by multiplication with the sign.
  51.     f = abs (x) + (x == 0);
  52.     e = (floor (log (f) / log (2)) + 1) .* (x != 0);
  53.     f = sign (x) .* f ./ (2 .^ e);
  54.   else
  55.     error ("log2 takes at most 2 output arguments");
  56.   endif
  57.  
  58. endfunction
  59.  
  60.