octave: scripts/specfun/beta.m annotate

annotate scripts/specfun/beta.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 1994-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	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	7 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ## 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	11 ## 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	12 ## (at your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ## 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	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	18 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	19 ## 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	20 ## 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	21 ## <https://www.gnu.org/licenses/>.
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	22
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3321 diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## @deftypefn {} {} beta (@var{a}, @var{b})
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19102 diff changeset	25 ## Compute the Beta function for real inputs @var{a} and @var{b}.
19102 bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	26 ##
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	27 ## The Beta function definition is
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	28 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	29 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	30 ## 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	31 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	32 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7601 diff changeset	33 ## @ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3381 diff changeset	34 ##
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	35 ## @example
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	36 ## 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	37 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9211 diff changeset	38 ##
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7601 diff changeset	39 ## @end ifnottex
19102 bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	40 ##
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	41 ## The Beta function can grow quite large and it is often more useful to work
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	42 ## with the logarithm of the output rather than the function directly.
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	43 ## @xref{XREFbetaln,,betaln}, for computing the logarithm of the Beta function
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	44 ## in an efficient manner.
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	45 ## @seealso{betaln, betainc, betaincinv}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2847 diff changeset	46 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	47
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	48 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	49 ## Created: 13 June 1993
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	50 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	51
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	52 function retval = beta (a, b)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2313 diff changeset	53
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	54 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	55 print_usage ();
1026 9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	56 endif
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe] jwe parents: 904 diff changeset	57
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	58 if (! isreal (a) \|\| ! isreal (b))
19102 bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	59 error ("beta: A and B must be real");
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	60 elseif (! size_equal (a, b) && numel (a) != 1 && numel (b) != 1)
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	61 error ("beta: A and B must have consistent sizes");
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	62 endif
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	63
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	64 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	65
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe] jwe parents: diff changeset	66 endfunction
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	67
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	69 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %! a = [1, 1.5, 2, 3];
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %! b = [4, 3, 2, 1];
19102 bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	72 %! v1 = beta (a, b);
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	73 %! v2 = beta (b, a);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74 %! v3 = gamma (a).*gamma (b) ./ gamma (a+b);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75 %! assert (v1, v2, sqrt (eps));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	76 %! assert (v2, v3, sqrt (eps));
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	77
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %!assert (beta (1, 1), 1)
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	79
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	80 %!test
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	81 %! a = 2:10;
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	82 %! tol = 10 * max (a) * eps;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	83 %! assert (-a, beta (-1./a, 1), tol);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %! assert (-a, beta (1, -1./a), tol);
7601 8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	85
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	86 %!test
8a939b217863 Treat negative values to lgamma and beta correctly David Bateman <dbateman@free.fr> parents: 7385 diff changeset	87 %! 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	88 %! tol = 10 * max (a) * eps;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	89 %! assert (zeros (size (a)), beta (a, -a), tol);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %! assert (zeros (size (a)), beta (-a, a), tol);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	92 %!error beta ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93 %!error beta (1)
19102 bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	94 %!error beta (1,2,3)
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	95 %!error <A and B must be real> beta (1i, 2)
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	96 %!error <A and B must be real> beta (2, 1i)
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	97 %!error <A and B must have consistent sizes> beta ([1 2], [1 2 3])
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	98 %!error <A and B must have consistent sizes> beta ([1 2 3], [1 2])
bb20384acf7b doc: Overhaul documentation for some functions in specfun/ dir. Rik <rik@octave.org> parents: 17744 diff changeset	99 %!error <A and B must have consistent sizes> beta ([1 2 3], [1 2 3]')

Mercurial > octave

annotate scripts/specfun/beta.m @ 27919:1891570abac8