view scripts/specfun/realsqrt.m @ 7994:8ccd9b0bf6bc

plot/axis.m (__get_tight_lims__): don't fail if data is not a vector
author John W. Eaton <jwe@octave.org>
date Tue, 29 Jul 2008 15:34:13 -0400
parents 4682dda22527
children 1bf0ce0930be
line wrap: on
line source

## Copyright (C) 2008  David Bateman
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} realsqrt (@var{x})
## Return the real sqrt of @var{x}. If any element results in the
## return value being complex @code{realsqrt} produces an error.
## @seealso{sqrt, reallog, realpow}
## @end deftypefn

function y = realsqrt (x)
  if (nargin != 1)
    print_usage ();
  elseif (iscomplex (x) || any (x(:) < 0))
    error ("realsqrt: produced complex result");
  else    
    y = sqrt (x);
  endif
endfunction

%!assert (sqrt(1:5),realsqrt(1:5))
%!test
%! x = rand (10,10);
%! assert (sqrt(x),realsqrt(x))
%!error (realsqrt(-1))