annotate scripts/deprecated/finite.m @ 20595:c1a6c31ac29a

eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.
author John W. Eaton <jwe@octave.org>
date Tue, 06 Oct 2015 00:20:02 -0400
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19679
diff changeset
1 ## Copyright (C) 2014-2015 John W. Eaton
19151
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
18
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Mapping Function} {} finite (@var{x})
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
21 ##
19679
ebd27d8c63fd update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents: 19631
diff changeset
22 ## @code{finite} is deprecated and will be removed in Octave version 4.4.
19151
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
23 ## Please use @code{isfinite} in all new code.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
24 ##
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
25 ## Return a logical array which is true where the elements of @var{x} are
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
26 ## finite values and false where they are not.
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
27 ## For example:
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19151
diff changeset
28 ##
19151
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
29 ## @example
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
30 ## @group
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
31 ## finite ([13, Inf, NA, NaN])
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
32 ## @result{} [ 1, 0, 0, 0 ]
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
33 ## @end group
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
34 ## @end example
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
35 ## @seealso{isfinite, isinf, isnan, isna}
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
36 ## @end deftypefn
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
37
19679
ebd27d8c63fd update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents: 19631
diff changeset
38 ## Deprecated in version 4.0
19151
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
39
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
40 function retval = finite (varargin)
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
41
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
42 persistent warned = false;
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
43 if (! warned)
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
44 warned = true;
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
45 warning ("Octave:deprecated-function",
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
46 "finite is obsolete and will be removed from a future version of Octave, please use isfinite instead");
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
47 endif
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
48
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
49 retval = isfinite (varargin{:});
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
50
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
51 endfunction
a4c226a963c5 Deprecate finite in favor of isfinite.
Rik <rik@octave.org>
parents:
diff changeset
52