octave: scripts/general/nextpow2.m annotate

annotate scripts/general/nextpow2.m @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	bdad8ca48700

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 ##
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 ## Copyright (C) 1995-2020 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})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19788 diff changeset	28 ## Compute the exponent for the smallest power of two larger 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 ##
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19788 diff changeset	30 ## For each element in the input array @var{x}, return the first 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
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9167 diff changeset	36 ## 2^n @geq{} abs (x).
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	37 ## @end ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	38 ##
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	39 ## @seealso{pow2, log2}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	40 ## @end deftypefn
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	41
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	42 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	43 ## Created: 7 October 1994
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	44 ## Adapted-By: jwe
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	45
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	46 function n = nextpow2 (x)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	47
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	48 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	49 print_usage ();
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	50 endif
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	51
19788 511b3ae4872b nextpow2: compute for each element of input instead of its length (bug #44291) Carnë Draug <carandraug@octave.org> parents: 19697 diff changeset	52 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	53 error ("nextpow2: X must be numeric");
2816 ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	54 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	55
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	56 [f, n] = log2 (abs (x));
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	57 idx = (n == 0); # Find any failures of log2 function (n == 0)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	58 n(idx) = f(idx); # and copy over value.
25436 996d78102a71 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 25236 diff changeset	59 n(f == 0.5)--;
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	60
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	61 endfunction
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	62
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	63
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	64 %!assert (nextpow2 (16), 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	65 %!assert (nextpow2 (17), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 %!assert (nextpow2 (31), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	67 %!assert (nextpow2 (-16), 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68 %!assert (nextpow2 (-17), 5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %!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	70 %!assert (nextpow2 (1:17), [0 1 2 2 3 3 3 3 4 4 4 4 4 4 4 4 5])
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	71 ## Special cases
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	72 %!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	73 %!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	74 %!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	75 %!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	76 %!assert (nextpow2 (NaN), NaN)
69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	77 %!assert (nextpow2 ([1, Inf, 3, -Inf, 9, NaN]), [0, Inf, 2, Inf, 4, NaN])
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	79 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!error nexpow2 ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %!error nexpow2 (1, 2)
25236 69b21b8a0e9f nextpow2.m: Compute value correctly for Inf or NaN inputs (bug #53463). Rik <rik@octave.org> parents: 25054 diff changeset	82 %!error <X must be numeric> nextpow2 ("t")

Mercurial > octave

annotate scripts/general/nextpow2.m @ 27923:bd51beb6205e