File: nextpow2.m

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (158 lines) | stat: -rw-r--r-- 4,241 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
########################################################################
##
## Copyright (C) 1995-2025 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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 {} {@var{n} =} nextpow2 (@var{x})
## Compute the exponent of the next power of two not smaller than the input.
##
## For each element in the input array @var{x}, return the smallest integer
## @var{n} such that
## @tex
## $2^n \ge |x|$.
## @end tex
## @ifnottex
## @code{2^@var{n} @geq{} abs (@var{x})}.
## @end ifnottex
## For input elements equal to zero, return zero.
##
## @seealso{pow2, log2}
## @end deftypefn

function n = nextpow2 (x)

  if (nargin < 1)
    print_usage ();
  endif

  if (! isnumeric (x))
    error ("nextpow2: X must be numeric");
  elseif (! isreal (x))
    error ("nextpow2: X must be real");
  endif

  [f, n] = log2 (abs (x));
  n(f == 0.5)--;

  if (isfloat (x))
    idx_nan = isnan (x);
    n(idx_nan) = x(idx_nan);
    n(isinf (x)) = Inf;
  else
    n = cast (n, class (x));
    if (intmax (x) > flintmax ())
      n((2 .^ n) < abs (x))++;
    endif
  endif

endfunction


%!assert (nextpow2 (16), 4)
%!assert (nextpow2 (17), 5)
%!assert (nextpow2 (31), 5)
%!assert (nextpow2 (-16), 4)
%!assert (nextpow2 (-17), 5)
%!assert (nextpow2 (-31), 5)
%!assert (nextpow2 (1:17), [0 1 2 2 3 3 3 3 4 4 4 4 4 4 4 4 5])
%!assert <*62947> (nextpow2 (0.5), -1)
%!assert <*62947> (nextpow2 (0.6), 0)
## Special cases
%!assert (nextpow2 (0), 0)
%!assert (nextpow2 (1), 0)
%!assert (nextpow2 (Inf), Inf)
%!assert (nextpow2 (-Inf), Inf)
%!assert (nextpow2 (NaN), NaN)
%!assert (nextpow2 (NA), NA)
%!assert (nextpow2 ([1, Inf, 3, -Inf, 9, NaN, NA]), ...
%!                  [0, Inf, 2,  Inf, 4, NaN, NA])

%!test
%! p = (-1074:1023).';
%! x = 2 .^ p;
%! x = [x, x + eps(x)];
%! x = [x, -x];
%! n = nextpow2 (x);
%! assert (n(:, 1), p);
%! assert (n(:, 3), p);
%! assert (n(:, 2), p + 1);
%! assert (n(:, 4), p + 1);

%!assert (nextpow2 (realmax ()), 1024)
%!assert (nextpow2 (-realmax ()), 1024)

%!test
%! p = single (-149:127).';
%! x = 2 .^ p;
%! x = [x, x + eps(x)];
%! x = [x, -x];
%! n = nextpow2 (x);
%! assert (n(:, 1), p);
%! assert (n(:, 3), p);
%! assert (n(:, 2), p + 1);
%! assert (n(:, 4), p + 1);

%!assert (nextpow2 (realmax ('single')), single (128))
%!assert (nextpow2 (-realmax ('single')), single (128))

%!test
%! p = int32 (0:30).';
%! x = 2 .^ p;
%! x = [x, x + 1];
%! x = [x, -x];
%! n = nextpow2 (x);
%! assert (n(:, 1), p);
%! assert (n(:, 3), p);
%! assert (n(:, 2), p + 1);
%! assert (n(:, 4), p + 1);

%!assert (nextpow2 (int32 (0)), int32 (0))
%!assert (nextpow2 (intmin ('int32')), int32 (31))
%!assert (nextpow2 (intmax ('int32')), int32 (31))

%!assert (nextpow2 (uint32 (0)), uint32 (0))
%!assert (nextpow2 (intmax ('uint32')), uint32 (32))

%!test
%! p = int64 (0:62).';
%! x = 2 .^ p;
%! x = [x, x + 1];
%! x = [x, -x];
%! n = nextpow2 (x);
%! assert (n(:, 1), p);
%! assert (n(:, 3), p);
%! assert (n(:, 2), p + 1);
%! assert (n(:, 4), p + 1);

%!assert (nextpow2 (int64 (0)), int64 (0))
%!assert (nextpow2 (intmin ('int64')), int64 (63))
%!assert (nextpow2 (intmax ('int64')), int64 (63))

%!assert (nextpow2 (uint64 (0)), uint64 (0))
%!assert (nextpow2 (intmax ('uint64')), uint64 (64))

## Test input validation
%!error <Invalid call> nextpow2 ()
%!error <X must be numeric> nextpow2 ("t")
%!error <X must be real> nextpow2 (1 + 2i)