Mercurial > octave-nkf

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
19152
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
18
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Mapping Function} {} fmod (@var{x}, @var{y})
9c5a17d5fc19 Deprecate fmod function.
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{fmod} is deprecated and will be removed in Octave version 4.4.
19152
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
23 ## Please use @code{rem} in all new code.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
24 ##
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
25 ## Return the remainder of the division @code{@var{x} / @var{y}}, computed
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
26 ## using the expression
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19152
diff changeset
27 ##
19152
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
28 ## @example
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
29 ## x - y .* fix (x ./ y)
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
30 ## @end example
19631
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19152
diff changeset
31 ##
19152
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
32 ## An error message is printed if the dimensions of the arguments do not
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
33 ## agree, or if either of the arguments is complex.
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
34 ## @seealso{rem, mod}
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
35 ## @end deftypefn
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
36
19679
ebd27d8c63fd update default branch to release as 4.0
John W. Eaton <jwe@octave.org>
parents: 19631
diff changeset
37 ## Deprecated in version 4.0
19152
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
38
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
39 function retval = fmod (varargin)
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
40
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
41 persistent warned = false;
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
42 if (! warned)
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
43 warned = true;
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
44 warning ("Octave:deprecated-function",
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
45 "fmod is obsolete and will be removed from a future version of Octave, please use rem instead");
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
46 endif
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
47
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
48 retval = rem (varargin{:});
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
49
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
50 endfunction
9c5a17d5fc19 Deprecate fmod function.
Rik <rik@octave.org>
parents:
diff changeset
51