octave: scripts/general/nextpow2.m annotate

annotate scripts/general/nextpow2.m @ 11472:1740012184f9

Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.

author	Rik <octave@nomad.inbox5.com>
date	Sun, 09 Jan 2011 21:33:04 -0800
parents	be55736a0783
children	fd0a3ac60b0e

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1995, 1996, 1997, 1999, 2000, 2002, 2004, 2005, 2006,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8517 diff changeset	2 ## 2007, 2009 Kurt Hornik
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	3 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	9 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	10 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	11 ## 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	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	15 ##
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	16 ## 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	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	18 ## <http://www.gnu.org/licenses/>.
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	19
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	20 ## -- texinfo --
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	21 ## @deftypefn {Function File} {} nextpow2 (@var{x})
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	22 ## If @var{x} is a scalar, return the first integer @var{n} such that
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	23 ## @tex
9167 1231b1762a9a Simplify TeXinfo and eliminate use of @iftex in arith.txi Rik <rdrider0-list@yahoo.com> parents: 9141 diff changeset	24 ## $2^n \ge \|x\|$.
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	25 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	26 ## @ifnottex
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9167 diff changeset	27 ## 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	28 ## @end ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	29 ##
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	30 ## If @var{x} is a vector, return @code{nextpow2 (length (@var{x}))}.
9141 c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	31 ## @seealso{pow2, log2}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2816 diff changeset	32 ## @end deftypefn
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	33
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	35 ## Created: 7 October 1994
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	36 ## Adapted-By: jwe
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	37
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	38 function n = nextpow2 (x)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	39
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	40 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	41 print_usage ();
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	42 endif
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	43
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3922 diff changeset	44 if (! (isscalar (x) \|\| isvector (x)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	45 error ("nextpow2: X must be a scalar or a vector");
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	46 endif
2816 ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	47
ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	48 t = length (x);
ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	49 if (t > 1)
ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	50 x = t;
ad4bf2a82b4f [project @ 1997-03-15 21:08:25 by jwe] jwe parents: 2539 diff changeset	51 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	52
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	53 [f, n] = log2 (abs (x));
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	54 if (f == 0.5)
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	55 n = n - 1;
1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	56 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	57
2539 1dca28c213f0 [project @ 1996-11-19 23:54:48 by jwe] jwe parents: diff changeset	58 endfunction

Mercurial > octave

annotate scripts/general/nextpow2.m @ 11472:1740012184f9