home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / general / rem.m < prev    next >
Encoding:
Text File  |  1999-10-26  |  1.7 KB  |  61 lines
  1. ## Copyright (C) 1996, 1997 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 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.
  19.  
  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
  24. ## 
  25. ## @example
  26. ## x - y .* fix (x ./ y)
  27. ## @end example
  28. ## 
  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
  32.  
  33. ## See also: round
  34.  
  35. ## Author: jwe
  36.  
  37. function retval = rem (x, y)
  38.  
  39.   if (nargin != 2)
  40.     usage ("rem (x, y)");
  41.   endif
  42.  
  43.   if (any (size (x) != size (y)) && ! (is_scalar (x) || is_scalar (y)))
  44.     error ("rem: argument sizes must agree");
  45.   endif
  46.  
  47.   ## Matlab allows complex arguments, but as far as I can tell, that's a
  48.   ## bunch of hooey.
  49.  
  50.   if (any (any (imag (x))) || any (any (imag (y))))
  51.     error ("rem: complex arguments are not allowed");
  52.   endif
  53.  
  54.   if (nargin == 2)
  55.     retval = x - y .* fix (x ./ y);
  56.   else
  57.     error ("usage: rem (x, y)");
  58.   endif
  59.  
  60. endfunction
  61.