Mercurial > octave
view scripts/general/bincoeff.m @ 27985:9f9ac219896d
maint: Remove remaining "Author:" instances from code base.
* __ftp__.cc, load-save.cc, urlwrite.cc, xnorm.cc, xnorm.h, cconv2.f,
cdotc3.f, cmatm3.f, csconv2.f, dconv2.f, ddot3.f, dmatm3.f, sconv2.f, sdot3.f,
smatm3.f, zconv2.f, zdconv2.f, zdotc3.f, zmatm3.f, crsf2csf.f, zrsf2csf.f,
oct-norm.cc, oct-norm.h, lin2mu.m, mu2lin.m, bincoeff.m, blkdiag.m, deal.m,
gradient.m, interpft.m, nextpow2.m, postpad.m, prepad.m, repmat.m, shift.m,
xor.m, griddata.m, rotx.m, roty.m, rotz.m, voronoin.m, getappdata.m,
isappdata.m, rmappdata.m, setappdata.m, colormap.m, gray.m, gray2ind.m,
im2double.m, image.m, imagesc.m, imread.m, imshow.m, ind2gray.m, ind2rgb.m,
ocean.m, __imread__.m, rgb2ind.m, javachk.m, ClassHelper.java, usejava.m,
findstr.m, commutation_matrix.m, cross.m, gls.m, housh.m, isdefinite.m,
ishermitian.m, issymmetric.m, logm.m, null.m, ols.m, orth.m, qzhess.m, rref.m,
dos.m, nargoutchk.m, orderfields.m, parseparams.m, __w2mpth__.m, unix.m,
untar.m, unzip.m, expand_rel_paths.m, make_rel_paths.m, daspect.m, orient.m,
pbaspect.m, rticks.m, thetaticks.m, xticklabels.m, xticks.m, yticklabels.m,
yticks.m, zticklabels.m, zticks.m, comet.m, contourf.m, plot3.m, cla.m,
copyobj.m, findfigs.m, hdl2struct.m, linkaxes.m, __ghostscript__.m,
__gnuplot_get_var__.m, __gnuplot_has_feature__.m, __gnuplot_has_terminal__.m,
__gnuplot_open_stream__.m, __gnuplot_print__.m, struct2hdl.m, subplot.m,
compan.m, conv.m, deconv.m, mpoles.m, poly.m, polyder.m, polyfit.m, polyint.m,
polyout.m, polyreduce.m, polyval.m, polyvalm.m, residue.m, roots.m, ismember.m,
__parse_movargs__.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, filter2.m,
movfun.m, movslice.m, ichol.m, pcg.m, beta.m, ellipke.m, lcm.m, nchoosek.m,
pow2.m, primes.m, pascal.m, rosser.m, wilkinson.m, corr.m, kurtosis.m,
skewness.m, base2dec.m, bin2dec.m, blanks.m, deblank.m, dec2base.m, dec2bin.m,
dec2hex.m, hex2dec.m, index.m, rindex.m, strjoin.m, substr.m, untabify.m,
calendar.m, datestr.m, eomday.m, now.m, weekday.m:
Remove remaining "Author:" instances from code base.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 21 Jan 2020 14:35:03 -0800 |
parents | 7f1cec12c240 |
children | d8318c12d903 0a5b15007766 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1995-2020 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 {} {} bincoeff (@var{n}, @var{k}) ## Return the binomial coefficient of @var{n} and @var{k}. ## ## The binomial coefficient is defined as ## @tex ## $$ ## {n \choose k} = {n (n-1) (n-2) \cdots (n-k+1) \over k!} ## $$ ## @end tex ## @ifnottex ## ## @example ## @group ## / \ ## | n | n (n-1) (n-2) @dots{} (n-k+1) ## | | = ------------------------- ## | k | k! ## \ / ## @end group ## @end example ## ## @end ifnottex ## For example: ## ## @example ## @group ## bincoeff (5, 2) ## @result{} 10 ## @end group ## @end example ## ## In most cases, the @code{nchoosek} function is faster for small ## scalar integer arguments. It also warns about loss of precision for ## big arguments. ## ## @seealso{nchoosek} ## @end deftypefn function b = bincoeff (n, k) if (nargin != 2) print_usage (); endif [retval, n, k] = common_size (n, k); if (retval > 0) error ("bincoeff: N and K must be of common size or scalars"); endif if (iscomplex (n) || iscomplex (k)) error ("bincoeff: N and K must not be complex"); endif b = zeros (size (n)); ok = (k >= 0) & (k == fix (k)) & (! isnan (n)); b(! ok) = NaN; n_int = (n == fix (n)); idx = n_int & (n < 0) & ok; b(idx) = (-1) .^ k(idx) .* exp (gammaln (abs (n(idx)) + k(idx)) - gammaln (k(idx) + 1) - gammaln (abs (n(idx)))); idx = (n >= k) & ok; b(idx) = exp (gammaln (n(idx) + 1) - gammaln (k(idx) + 1) - gammaln (n(idx) - k(idx) + 1)); idx = (! n_int) & (n < k) & ok; b(idx) = (1/pi) * exp (gammaln (n(idx) + 1) - gammaln (k(idx) + 1) + gammaln (k(idx) - n(idx)) + log (sin (pi * (n(idx) - k(idx) + 1)))); ## Clean up rounding errors. b(n_int) = round (b(n_int)); idx = ! n_int; b(idx) = real (b(idx)); endfunction %!assert (bincoeff (4, 2), 6) %!assert (bincoeff (2, 4), 0) %!assert (bincoeff (-4, 2), 10) %!assert (bincoeff (5, 2), 10) %!assert (bincoeff (50, 6), 15890700) %!assert (bincoeff (0.4, 2), -.12, 8*eps) %!assert (bincoeff ([4 NaN 4], [-1, 2, 2.5]), NaN (1, 3)) ## Test input validation %!error bincoeff () %!error bincoeff (1, 2, 3) %!error bincoeff (ones (3),ones (2)) %!error bincoeff (ones (2),ones (3))