Mercurial > octave-antonio
view scripts/general/idivide.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2008-2015 David Bateman ## ## 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 {Function File} {} idivide (@var{x}, @var{y}, @var{op}) ## Integer division with different rounding rules. ## ## The standard behavior of integer division such as @code{@var{a} ./ @var{b}} ## is to round the result to the nearest integer. This is not always the ## desired behavior and @code{idivide} permits integer element-by-element ## division to be performed with different treatment for the fractional ## part of the division as determined by the @var{op} flag. @var{op} is ## a string with one of the values: ## ## @table @asis ## @item @qcode{"fix"} ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards zero. ## ## @item @qcode{"round"} ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards the nearest integer. ## ## @item @qcode{"floor"} ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards negative infinity. ## ## @item @qcode{"ceil"} ## Calculate @code{@var{a} ./ @var{b}} with the fractional part rounded ## towards positive infinity. ## @end table ## ## @noindent ## If @var{op} is not given it defaults to @qcode{"fix"}. ## An example demonstrating these rounding rules is ## ## @example ## @group ## idivide (int8 ([-3, 3]), int8 (4), "fix") ## @result{} int8 ([0, 0]) ## idivide (int8 ([-3, 3]), int8 (4), "round") ## @result{} int8 ([-1, 1]) ## idivide (int8 ([-3, 3]), int8 (4), "floor") ## @result{} int8 ([-1, 0]) ## idivide (int8 ([-3, 3]), int8 (4), "ceil") ## @result{} int8 ([0, 1]) ## @end group ## @end example ## ## @seealso{ldivide, rdivide} ## @end deftypefn function z = idivide (x, y, op) if (nargin < 2 || nargin > 3) print_usage (); elseif (nargin == 2) op = "fix"; else op = tolower (op); endif if (strcmp (op, "round")) z = x ./ y; else if (isfloat (x)) typ = class (y); elseif (isfloat (y)) typ = class (x); else typ = class (x); if (! strcmp (class (x), class (y))) error ("idivide: incompatible types"); endif endif if (strcmp (op, "fix")) z = cast (fix (double (x) ./ double (y)), typ); elseif (strcmp (op, "floor")) z = cast (floor (double (x) ./ double (y)), typ); elseif (strcmp (op, "ceil")) z = cast (ceil (double (x) ./ double (y)), typ); else error ("idivide: unrecognized rounding type"); endif endif endfunction %!shared a, af, b, bf %! a = int8 (3); %! af = 3; %! b = int8 ([-4, 4]); %! bf = [-4, 4]; %!assert (idivide (a, b), int8 ([0, 0])) %!assert (idivide (a, b, "floor"), int8 ([-1, 0])) %!assert (idivide (a, b, "ceil"), int8 ([0, 1])) %!assert (idivide (a, b, "round"), int8 ([-1, 1])) %!assert (idivide (af, b), int8 ([0, 0])) %!assert (idivide (af, b, "floor"), int8 ([-1, 0])) %!assert (idivide (af, b, "ceil"), int8 ([0, 1])) %!assert (idivide (af, b, "round"), int8 ([-1, 1])) %!assert (idivide (a, bf), int8 ([0, 0])) %!assert (idivide (a, bf, "floor"), int8 ([-1, 0])) %!assert (idivide (a, bf, "ceil"), int8 ([0, 1])) %!assert (idivide (a, bf, "round"), int8 ([-1, 1])) %!error (idivide (uint8 (1), int8 (1)))