2847
|
1 ## Copyright (C) 1996, 1997 John W. Eaton |
2313
|
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 2, or (at your option) |
|
8 ## 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, write to the Free |
|
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA |
|
18 ## 02111-1307, USA. |
245
|
19 |
3321
|
20 ## -*- texinfo -*- |
|
21 ## @deftypefn {Mapping Function} {} rem (@var{x}, @var{y}) |
|
22 ## Return the remainder of @code{@var{x} / @var{y}}, computed using the |
|
23 ## expression |
3426
|
24 ## |
3321
|
25 ## @example |
|
26 ## x - y .* fix (x ./ y) |
|
27 ## @end example |
3426
|
28 ## |
3321
|
29 ## An error message is printed if the dimensions of the arguments do not |
|
30 ## agree, or if either of the arguments is complex. |
|
31 ## @end deftypefn |
3981
|
32 ## @seealso{mod, round} |
4
|
33 |
2314
|
34 ## Author: jwe |
|
35 |
3980
|
36 function r = rem (x, y) |
3457
|
37 |
4
|
38 if (nargin != 2) |
3980
|
39 usage ("rem (x, y)"); |
4
|
40 endif |
|
41 |
447
|
42 if (any (size (x) != size (y)) && ! (is_scalar (x) || is_scalar (y))) |
|
43 error ("rem: argument sizes must agree"); |
4
|
44 endif |
|
45 |
2303
|
46 ## Matlab allows complex arguments, but as far as I can tell, that's a |
|
47 ## bunch of hooey. |
4
|
48 |
|
49 if (any (any (imag (x))) || any (any (imag (y)))) |
|
50 error ("rem: complex arguments are not allowed"); |
|
51 endif |
|
52 |
3980
|
53 r = x - y .* fix (x ./ y); |
4
|
54 |
|
55 endfunction |