|
19310
|
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} {} fmod (@var{x}, @var{y}) |
|
|
21 ## |
|
|
22 ## @code{fmod} is deprecated and will be removed in Octave version 4.6. |
|
|
23 ## Please use @code{rem} in all new code. |
|
|
24 ## |
|
|
25 ## Return the remainder of the division @code{@var{x} / @var{y}}, computed |
|
|
26 ## using the expression |
|
|
27 ## |
|
|
28 ## @example |
|
|
29 ## x - y .* fix (x ./ y) |
|
|
30 ## @end example |
|
|
31 ## |
|
|
32 ## An error message is printed if the dimensions of the arguments do not |
|
|
33 ## agree, or if either of the arguments is complex. |
|
|
34 ## @seealso{rem, mod} |
|
|
35 ## @end deftypefn |
|
|
36 |
|
|
37 ## Deprecated in version 4.2 |
|
|
38 |
|
|
39 function retval = fmod (varargin) |
|
|
40 |
|
|
41 persistent warned = false; |
|
|
42 if (! warned) |
|
|
43 warned = true; |
|
|
44 warning ("Octave:deprecated-function", |
|
|
45 "fmod is obsolete and will be removed from a future version of Octave, please use rem instead"); |
|
|
46 endif |
|
|
47 |
|
|
48 retval = rem (varargin{:}); |
|
|
49 |
|
|
50 endfunction |
|
|
51 |
