octave: scripts/general/nextpow2.m annotate

annotate scripts/general/nextpow2.m @ 33199:297fd823a953

nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) * nextpow2.m: Clarify documentation. Document return value of special input 0. Add input validation to exclude complex inputs. New algorithm for computing nextpow2 based on 2-output form of log2(). Use cast() to have output class match input class for Matlab compatibility. Add BIST tests. * NEWS.10.md: Announce changes to nextpow2 function.

author	Rik <rik@octave.org>
date	Tue, 12 Mar 2024 14:27:13 -0700
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 1995-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	7 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	14 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	19 ##
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	25
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	26 ## -- texinfo --
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	27 ## @deftypefn {} {@var{n} =} nextpow2 (@var{x})
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	28 ## Compute the exponent of the next power of two not smaller than the input.
19788 511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	29 ##
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	30 ## For each element in the input array @var{x}, return the smallest integer
19788 511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	31 ## @var{n} such that
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	32 ## @tex
9167 1231b1762a9a Simplify TeXinfo and eliminate use of @iftex in arith.txi Rik <rdrider0-list@yahoo.com> parents: 9141 diff changeset	33 ## $2^n \ge \|x\|$.
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	34 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	35 ## @ifnottex
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	36 ## @code{2^@var{n} @geq{} abs (@var{x})}.
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	37 ## @end ifnottex
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	38 ## For input elements equal to zero, return zero.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	39 ##
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	40 ## @seealso{pow2, log2}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	41 ## @end deftypefn
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	42
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	43 function n = nextpow2 (x)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	44
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 27985 diff changeset	45 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	46 print_usage ();
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	47 endif
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	48
19788 511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	49 if (! isnumeric (x))
511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	50 error ("nextpow2: X must be numeric");
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	51 elseif (! isreal (x))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	52 error ("nextpow2: X must be real");
2816 ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	53 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	54
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	55 [f, n] = log2 (abs (x));
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	56 n(f == 0.5)--;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	57
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	58 if (isfloat (x))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	59 idx_nan = isnan (x);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	60 n(idx_nan) = x(idx_nan);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	61 n(isinf (x)) = Inf;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	62 else
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	63 n = cast (n, class (x));
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	64 if (intmax (x) > flintmax ())
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	65 n((2 .^ n) < abs (x))++;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	66 endif
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	67 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	68
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	69 endfunction
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	70
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	71
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 %!assert (nextpow2 (16), 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %!assert (nextpow2 (17), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74 %!assert (nextpow2 (31), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75 %!assert (nextpow2 (-16), 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	76 %!assert (nextpow2 (-17), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 %!assert (nextpow2 (-31), 5)
19788 511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	78 %!assert (nextpow2 (1:17), [0 1 2 2 3 3 3 3 4 4 4 4 4 4 4 4 5])
31200 075443476dfb nextpow2.m: Add bug number tag to regression BIST tests (bug #62947) Rik <rik@octave.org> parents: 31198 diff changeset	79 %!assert <*62947> (nextpow2 (0.5), -1)
075443476dfb nextpow2.m: Add bug number tag to regression BIST tests (bug #62947) Rik <rik@octave.org> parents: 31198 diff changeset	80 %!assert <*62947> (nextpow2 (0.6), 0)
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	81 ## Special cases
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	82 %!assert (nextpow2 (0), 0)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	83 %!assert (nextpow2 (1), 0)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	84 %!assert (nextpow2 (Inf), Inf)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	85 %!assert (nextpow2 (-Inf), Inf)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	86 %!assert (nextpow2 (NaN), NaN)
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	87 %!assert (nextpow2 (NA), NA)
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	88 %!assert (nextpow2 ([1, Inf, 3, -Inf, 9, NaN, NA]), ...
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	89 %! [0, Inf, 2, Inf, 4, NaN, NA])
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	90
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	91 %!test
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	92 %! p = (-1074:1023).';
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	93 %! x = 2 .^ p;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	94 %! x = [x, x + eps(x)];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	95 %! x = [x, -x];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	96 %! n = nextpow2 (x);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	97 %! assert (n(:, 1), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	98 %! assert (n(:, 3), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	99 %! assert (n(:, 2), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	100 %! assert (n(:, 4), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	101
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	102 %!assert (nextpow2 (realmax ()), 1024)
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	103 %!assert (nextpow2 (-realmax ()), 1024)
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	104
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	105 %!test
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	106 %! p = single (-149:127).';
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	107 %! x = 2 .^ p;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	108 %! x = [x, x + eps(x)];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	109 %! x = [x, -x];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	110 %! n = nextpow2 (x);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	111 %! assert (n(:, 1), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	112 %! assert (n(:, 3), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	113 %! assert (n(:, 2), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	114 %! assert (n(:, 4), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	115
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	116 %!assert (nextpow2 (realmax ('single')), single (128))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	117 %!assert (nextpow2 (-realmax ('single')), single (128))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	118
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	119 %!test
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	120 %! p = int32 (0:30).';
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	121 %! x = 2 .^ p;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	122 %! x = [x, x + 1];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	123 %! x = [x, -x];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	124 %! n = nextpow2 (x);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	125 %! assert (n(:, 1), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	126 %! assert (n(:, 3), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	127 %! assert (n(:, 2), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	128 %! assert (n(:, 4), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	129
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	130 %!assert (nextpow2 (int32 (0)), int32 (0))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	131 %!assert (nextpow2 (intmin ('int32')), int32 (31))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	132 %!assert (nextpow2 (intmax ('int32')), int32 (31))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	133
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	134 %!assert (nextpow2 (uint32 (0)), uint32 (0))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	135 %!assert (nextpow2 (intmax ('uint32')), uint32 (32))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	136
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	137 %!test
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	138 %! p = int64 (0:62).';
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	139 %! x = 2 .^ p;
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	140 %! x = [x, x + 1];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	141 %! x = [x, -x];
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	142 %! n = nextpow2 (x);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	143 %! assert (n(:, 1), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	144 %! assert (n(:, 3), p);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	145 %! assert (n(:, 2), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	146 %! assert (n(:, 4), p + 1);
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	147
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	148 %!assert (nextpow2 (int64 (0)), int64 (0))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	149 %!assert (nextpow2 (intmin ('int64')), int64 (63))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	150 %!assert (nextpow2 (intmax ('int64')), int64 (63))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	151
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	152 %!assert (nextpow2 (uint64 (0)), uint64 (0))
297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	153 %!assert (nextpow2 (intmax ('uint64')), uint64 (64))
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	154
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	155 ## Test input validation
28896 90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 28891 diff changeset	156 %!error <Invalid call> nextpow2 ()
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	157 %!error <X must be numeric> nextpow2 ("t")
33199 297fd823a953 nextpow2.m: Overhaul function for improved accuracy and Matlab compatibility (bug #65441) Rik <rik@octave.org> parents: 32632 diff changeset	158 %!error <X must be real> nextpow2 (1 + 2i)

Mercurial > octave

annotate scripts/general/nextpow2.m @ 33199:297fd823a953