Mercurial > octave-nkf
view scripts/specfun/realsqrt.m @ 20584:eb9e2d187ed2
maint: Use Octave coding conventions in scripts/ode/private dir.
* AbsRel_Norm.m, fuzzy_compare.m, hermite_quartic_interpolation.m,
integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, kahan.m,
ode_struct_value_check.m, odepkg_event_handle.m, odepkg_structure_check.m,
runge_kutta_45_dorpri.m, starting_stepsize.m:
Wrap long lines to < 80 chars.
Use double quotes rather than single quotes where possible.
Use ';' at end of keywords "return;" and "break;"
Use '##" for stand-alone comments and '#' for end-of-line comments.
Use two spaces after period before starting new sentence.
Use '!' instead of '~' for logical negation.
Use specific form of end (endif, endfor, etc.).
Don't use line continuation marker '...' unless necessary.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 04 Oct 2015 22:18:54 -0700 |
| parents | 2645f9ef8c88 |
| children |
line wrap: on
line source
## Copyright (C) 2008-2015 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-valued square root of each element of @var{x}. ## ## If any element results in a complex return value @code{realsqrt} aborts and ## issues an error. ## @seealso{sqrt, realpow, reallog} ## @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 (realsqrt (1:5), sqrt (1:5)) %!test %! x = rand (10, 10); %! assert (realsqrt (x), sqrt (x)); %!error realsqrt () %!error realsqrt (1,2) %!error <produced complex result> realsqrt (-1)