octave_packages/m/specfun/realsqrt.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} {} realsqrt (@var{x})
  21 ## Return the real-valued square root of each element of @var{x}.  Report an
  22 ## error if any element results in a complex return value.
  23 ## @seealso{sqrt, realpow, reallog}
  24 ## @end deftypefn
  25
  26 function y = realsqrt (x)
  27   if (nargin != 1)
  28     print_usage ();
  29   elseif (iscomplex (x) || any (x(:) < 0))
  30     error ("realsqrt: produced complex result");
  31   else
  32     y = sqrt (x);
  33   endif
  34 endfunction
  35
  36 %!assert (sqrt(1:5),realsqrt(1:5))
  37 %!test
  38 %! x = rand (10,10);
  39 %! assert (sqrt(x),realsqrt(x))
  40 %!error (realsqrt(-1))