octave_packages/m/specfun/realpow.m

   1 ## Copyright (C) 2008-2012 David Bateman
   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 {Function File} {} realpow (@var{x}, @var{y})
  21 ## Compute the real-valued, element-by-element power operator.  This is
  22 ## equivalent to @w{@code{@var{x} .^ @var{y}}}, except that @code{realpow}
  23 ## reports an error if any return value is complex.
  24 ## @seealso{reallog, realsqrt}
  25 ## @end deftypefn
  26
  27 function z = realpow (x, y)
  28   if (nargin != 2)
  29     print_usage ();
  30   else
  31     z = x .^ y;
  32     if (iscomplex (z))
  33       error ("realpow: produced complex result");
  34     endif
  35   endif
  36 endfunction
  37
  38 %!assert (power (1:10, 0.5:0.5:5), realpow (1:10, 0.5:0.5:5))
  39 %!assert ([1:10] .^ [0.5:0.5:5], realpow (1:10, 0.5:0.5:5))
  40 %!test
  41 %! x = rand (10,10);
  42 %! y = randn (10,10);
  43 %! assert (x.^y,realpow(x,y))
  44 %!assert (realpow(1i,2),-1)
  45 %!error (realpow(-1, 1/2))