Mercurial > hg > octave-nkf

comparison scripts/deprecated/finite.m @ 19309:a4c226a963c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate finite in favor of isfinite. * NEWS: Announce change. * mappers.cc: Remove DEFALIAS of finite to isfinite. Replace finite with isfinite in %!tests. * scripts/deprecated/finite.m: New m-file script to replace C++ DEFALIAS. * scripts/deprecated/module.mk: Add finite.m to build system. * cosd.m, sind.m, tand.m, nthroot.m: Replace occurrences of finite with isfinite in core m-files.
author Rik <rik@octave.org>
date Sat, 20 Sep 2014 20:20:41 -0700
parents
children db92e7e28e1f
comparison
equal deleted inserted replaced
19308:d657ed3f5f25 19309:a4c226a963c5
1 ## Copyright (C) 2014 John W. Eaton
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} {} finite (@var{x})
21 ##
22 ## @code{finite} is deprecated and will be removed in Octave version 4.6.
23 ## Please use @code{isfinite} in all new code.
24 ##
25 ## Return a logical array which is true where the elements of @var{x} are
26 ## finite values and false where they are not.
27 ## For example:
28 ##
29 ## @example
30 ## @group
31 ## finite ([13, Inf, NA, NaN])
32 ## @result{} [ 1, 0, 0, 0 ]
33 ## @end group
34 ## @end example
35 ## @seealso{isfinite, isinf, isnan, isna}
36 ## @end deftypefn
37
38 ## Deprecated in version 4.2
39
40 function retval = finite (varargin)
41
42 persistent warned = false;
43 if (! warned)
44 warned = true;
45 warning ("Octave:deprecated-function",
46 "finite is obsolete and will be removed from a future version of Octave, please use isfinite instead");
47 endif
48
49 retval = isfinite (varargin{:});
50
51 endfunction
52