Mercurial > octave-nkf
view scripts/general/rem.m @ 8828:8463d1a2e544
Doc fixes.
* 2]$$. => 2].$$
* @var{extrapval} => @var{extrapval}.
* call helloworld.oct => called @file{helloworld.oct}
* @itemize => @table @code
* shows. => shows:
* save => @code{save}
* @ref{Breakpoints} => @pxref{Breakpoints}
* add @noindent following example
* which is computed => and compute it
* clarify wording
* remove comma
* good => well
* set => number
* by writing => with the command
* has the option of directly calling => can call
* [-like-] {+of the right size,+}
* solvers => routines
* handle => test for
* add introductory section
* add following
* {+the+} [0..bitmax] => [0,bitmax]
* of the => with
* number => value
* add usual
* Besides when doing comparisons, logical => Logical {+also+}
* array comparison => array, comparisons
* param => parameter
* works very similar => is similar
* strings, => strings
* most simple => simplest
* easier => more easily
* like => as
* called => called,
* clarify wording
* you should simply type => use
* clarify wording
* means => way
* equally => also
* [-way much-] {+way+}
* add with mean value parameter given by the first argument, @var{l}
* add Functions described as @dfn{mapping functions} apply the given
operation to each element when given a matrix argument.
* in this brief introduction => here
* It is worth noticing => Note
* add following
* means => ways
author | Brian Gough <bjg@network-theory.co.uk> |
---|---|
date | Fri, 20 Feb 2009 11:17:01 -0500 |
parents | bd2bd04e68ca |
children | eb63fbe60fab |
line wrap: on
line source
## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2002, 2004, ## 2005, 2006, 2007 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Mapping Function} {} rem (@var{x}, @var{y}) ## Return the remainder of @code{@var{x} / @var{y}}, computed using the ## expression ## ## @example ## x - y .* fix (x ./ y) ## @end example ## ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. ## @seealso{mod, round} ## @end deftypefn ## Author: jwe function r = rem (x, y) if (nargin != 2) print_usage (); endif if (! size_equal (x, y) && ! (isscalar (x) || isscalar (y))) error ("rem: argument sizes must agree"); endif if (isreal (x) && isreal (y)) if (isinteger(x) || isinteger(y)) if (isinteger (x)) typ = class (x); else typ = class (y); endif r = x - y .* cast (fix (double (x) ./ double (y)), typ); else r = x - y .* fix (x ./ y); endif else error ("rem: complex arguments are not allowed"); endif endfunction %!assert(rem ([1, 2, 3; -1, -2, -3], 2), [1, 0, 1; -1, 0, -1]); %!assert(rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3)),[1, 0, 1; -1, 0, -1]); %!error rem (); %!error rem (1, 2, 3); %!error rem ([1, 2], [3, 4, 5]); %!error rem (i, 1); %!assert(rem (uint8([1, 2, 3; -1, -2, -3]), uint8 (2)), uint8([1, 0, 1; -1, 0, -1])); %!assert(uint8(rem ([1, 2, 3; -1, -2, -3], 2 * ones (2, 3))),uint8([1, 0, 1; -1, 0, -1])); %!error rem (uint(8),int8(5)); %!error rem (uint8([1, 2]), uint8([3, 4, 5]));