octave_packages/m/specfun/pow2.m

   1 ## Copyright (C) 1995-2012 Kurt Hornik
   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 3 of the License, or (at
   8 ## your option) 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, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Mapping Function} {} pow2 (@var{x})
  21 ## @deftypefnx {Mapping Function} {} pow2 (@var{f}, @var{e})
  22 ## With one argument, computes
  23 ## @tex
  24 ## $2^x$
  25 ## @end tex
  26 ## @ifnottex
  27 ## 2 .^ x
  28 ## @end ifnottex
  29 ## for each element of @var{x}.
  30 ##
  31 ## With two arguments, returns
  32 ## @tex
  33 ## $f \cdot 2^e$.
  34 ## @end tex
  35 ## @ifnottex
  36 ## f .* (2 .^ e).
  37 ## @end ifnottex
  38 ## @seealso{log2, nextpow2}
  39 ## @end deftypefn
  40
  41 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
  42 ## Created: 17 October 1994
  43 ## Adapted-By: jwe
  44
  45 function y = pow2 (f, e)
  46
  47   if (nargin == 1)
  48     y = 2 .^ f;
  49   elseif (nargin == 2)
  50     y = f .* (2 .^ e);
  51   else
  52     print_usage ();
  53   endif
  54
  55 endfunction
  56
  57 %!test
  58 %! x = [3, 0, -3];
  59 %! v = [8, 1, .125];
  60 %! assert(all (abs (pow2 (x) - v) < sqrt (eps)));
  61
  62 %!test
  63 %! x = [3, 0, -3, 4, 0, -4, 5, 0, -5];
  64 %! y = [-2, -2, -2, 1, 1, 1, 3, 3, 3];
  65 %! z = x .* (2 .^ y);
  66 %! assert(all (abs (pow2 (x,y) - z) < sqrt (eps)));
  67
  68 %!error pow2();
  69