octave-nkf: scripts/specfun/beta.m annotate

annotate scripts/specfun/beta.m @ 9211:f0c3d3fc4903

Simplify Texinfo documentation in .m scripts by removing redundant @iftex calls

author	Rik <rdrider0-list@yahoo.com>
date	Sun, 17 May 2009 14:39:39 -0700
parents	eb63fbe60fab
children	693e22af08ae

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2002, 2005, 2006,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8664 diff changeset	2 ## 2007, 2008, 2009 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 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.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 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/>.
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	19
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3321 diff changeset	20 ## -- texinfo --
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	21 ## @deftypefn {Mapping Function} {} beta (@var{a}, @var{b})
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	22 ## For real inputs, return the Beta function,
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	23 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	24 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	25 ## B (a, b) = {\Gamma (a) \Gamma (b) \over \Gamma (a + b)}.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	26 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	27 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7601 diff changeset	28 ## @ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	29 ##
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	30 ## @example
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	31 ## beta (a, b) = gamma (a) * gamma (b) / gamma (a + b).
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	32 ## @end example
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7601 diff changeset	33 ## @end ifnottex
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	34 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	35
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	36 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	37 ## Created: 13 June 1993
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	38 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	39
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	40 function retval = beta (a, b)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2313 diff changeset	41
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	42 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	43 print_usage ();
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	44 endif
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	45
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	46 if (any (size (a) != size (b)) && numel (a) != 1 && numel (b) != 1)
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8517 diff changeset	47 error ("beta: inputs have inconsistent sizes");
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	48 endif
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	49
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	50 if (! isreal (a) \|\| ! isreal (b))
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8517 diff changeset	51 error ("beta: inputs must be real");
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	52 endif
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	53
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	54 retval = real (exp (gammaln (a) + gammaln (b) - gammaln (a+b)));
715 6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe] jwe parents: diff changeset	55
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe] jwe parents: diff changeset	56 endfunction
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	57
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	58 %!test
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	59 %! a=[1, 1.5, 2, 3];
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	60 %! b=[4, 3, 2, 1];
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	61 %! v1=beta(a,b);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	62 %! v2=beta(b,a);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	63 %! v3=gamma(a).*gamma(b)./gamma(a+b);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	64 %! assert(all(abs(v1-v2)<sqrt(eps)) && all(abs(v2-v3)<sqrt(eps)));
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	65
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	66 %!error beta();
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	67
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	68 %!error beta(1);
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	69
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	70 %!assert (1, beta (1, 1))
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	71
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	72 %!test
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	73 %! a = 2:10;
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	74 %! tol = 10 * max (a) * eps;
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	75 %! assert (-a, beta (-1./a, 1), tol)
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	76 %! assert (-a, beta (1, -1./a), tol)
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	77
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	78 %!test
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	79 %! a = 0.25 + (0:5) * 0.5;
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	80 %! tol = 10 * max (a) * eps;
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	81 %! assert (zeros (size (a)), beta (a, -a), tol)
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	82 %! assert (zeros (size (a)), beta (-a, a), tol)

Mercurial > hg > octave-nkf

annotate scripts/specfun/beta.m @ 9211:f0c3d3fc4903