Mercurial > octave
view scripts/deprecated/chop.m @ 25145:dfc6ccc2a3e8
set dev branch version to 5.0.0
New release version scheme follows that of GCC. Briefly:
* Any version X.0.0 means "this is an experimental development
version".
* Any version X.Y.1 means, "this is a pre-release version meant
for bug fixing and testing".
* Any version X.Y.0 with Y != 0 means "this is a released version".
More info here:
http://lists.gnu.org/archive/html/octave-maintainers/2018-03/msg00214.html
* configure.ac (AC_INIT): Set version to 5.0.0.
(OCTAVE_MAJOR_VERSION): Now 5.
(OCTAVE_MAJOR_VERSION, OCTAVE_PATCH_VERSION): Now 0.
(OCTAVE_RELEASE_DATE): Set to today; may update after 4.4.0 is released.
* chop.m, desktop.m, java2mat.m, tmpnam.m, toascii.m, bitmax.m:
Removal version is now 6, not 4.8.
* deprecate-props.tst: Update removal version numbers.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 07 Apr 2018 10:37:13 -0400 |
parents | 6652d3823428 |
children | 7c0dabd59d18 |
line wrap: on
line source
## Copyright (C) 2010-2018 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 ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} chop (@var{x}, @var{ndigits}, @var{base}) ## ## @code{chop} is deprecated and will be removed in Octave version 6. ## ## Truncate elements of @var{x} to a length of @var{ndigits} such that the ## resulting numbers are exactly divisible by @var{base}. ## ## If @var{base} is not specified it defaults to 10. ## ## @example ## @group ## format long ## chop (-pi, 5, 10) ## @result{} -3.14200000000000 ## chop (-pi, 5, 5) ## @result{} -3.14150000000000 ## @end group ## @end example ## @end deftypefn ## Deprecated in version 4.4 function retval = chop (x, ndigits, base = 10) persistent warned = false; if (! warned) warned = true; warning ("Octave:deprecated-function", "chop is obsolete and will be removed from a future version of Octave"); endif if (nargin == 2 || nargin == 3) tmp = abs (x); ## Avoid computing log (0). tmp(x == 0) = 1; ## Digits to the left of the decimal. tmp = floor (log10 (tmp) + 1); ## The expression ## ## round (x .* inflate) ## ## produces an integer that contains the digits we want to keep. ## Multiplying by deflate puts the decimal back where it belngs. ## ## Further scaling and rounding with the base factor produces a ## value with ndigits exactly divisible by base. We skip that step ## unless base was explicitly provided. inflate = 10 .^ (ndigits - tmp); deflate = 1 ./ inflate; if (nargin == 2) retval = deflate .* round (x .* inflate); else retval = base .* deflate .* round (round (x .* inflate) ./ base); endif else print_usage (); endif endfunction %!assert (chop (e, 3), 2.72) %!assert (chop (e, 4), 2.718) %!assert (chop (e, 4, 5), 2.72) %!assert (chop (e, 4, 7), 2.716) %!assert (chop (-e, 3), -2.72) %!assert (chop (-e, 4), -2.718) %!assert (chop (-e, 4, 5), -2.72) %!assert (chop (-e, 4, 7), -2.716) %!assert (chop (hilb (3), 3), [1,.5,.333;.5,.333,.25;.333,.25,.2]) %!assert (chop (hilb (3), 2, 7), [.7,.49,.35;.49,.35,.28;.35,.28,.21], 2*eps)