@stdlib/math-base-special-binomcoef
v0.3.1TypeScript
Compute the binomial coefficient.
26.2K/weekUpdated 2 days agoApache-2.0Unpacked: 58.3 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-binomcoefWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
Binomial Coefficient
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [binomial coefficient][binomial-coefficient].
The [binomial coefficient][binomial-coefficient] of two nonnegative integers n and k is defined as
The [binomial coefficient][binomial-coefficient] can be generalized to negative integers n as follows:
Installation
``bash`
npm install @stdlib/math-base-special-binomcoef
Usage
`javascript`
var binomcoef = require( '@stdlib/math-base-special-binomcoef' );
#### binomcoef( n, k )
Evaluates the [binomial coefficient][binomial-coefficient] of two integers n and k.
`javascript
var v = binomcoef( 8, 2 );
// returns 28
v = binomcoef( 0, 0 );
// returns 1
v = binomcoef( -4, 2 );
// returns 10
v = binomcoef( 5, 3 );
// returns 10
v = binomcoef( NaN, 3 );
// returns NaN
v = binomcoef( 5, NaN );
// returns NaN
v = binomcoef( NaN, NaN );
// returns NaN
`
For negative k, the function returns 0.
`javascript
var v = binomcoef( 2, -1 );
// returns 0
v = binomcoef( -3, -1 );
// returns 0
`
The function returns NaN for non-integer n or k.
`javascript
var v = binomcoef( 2, 1.5 );
// returns NaN
v = binomcoef( 5.5, 2 );
// returns NaN
`
Examples
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var binomcoef = require( '@stdlib/math-base-special-binomcoef' );
var opts = {
'dtype': 'float64'
};
var n = discreteUniform( 100, -10, 30, opts );
var k = discreteUniform( 100, 0, 20, opts );
logEachMap( '%d choose %d = %d', n, k, binomcoef );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/binomcoef.h"
#### stdlib_base_binomcoef( n, k )
Evaluates the [binomial coefficient][binomial-coefficient] of two integers n and k.
`c`
double v = stdlib_base_binomcoef( 8.0, 2.0 );
// returns 28.0
The function accepts the following arguments:
- n: [in] double input value.[in] double
- k: input value.
`c`
double stdlib_base_binomcoef( const double n, const double k );
$3
`c
#include "stdlib/math/base/special/binomcoef.h"
#include
int main( void ) {
const double a[] = { 24.0, 32.0, 48.0, 116.0, 33.0 };
const double b[] = { 12.0, 6.0, 15.0, 52.0, 22.0 };
double out;
int i;
for ( i = 0; i < 5; i++ ) {
out = stdlib_base_binomcoef( a[ i ], b[ i ] );
printf( "binomcoef(%lf, %lf) = %lf\n", a[ i ], b[ i ], out );
}
}
`
*
Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-binomcoef.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-binomcoef
[test-image]: https://github.com/stdlib-js/math-base-special-binomcoef/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/math-base-special-binomcoef/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-binomcoef/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-binomcoef?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-base-special-binomcoef/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-binomcoef/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-binomcoef/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-binomcoef/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-binomcoef/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-binomcoef/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-binomcoef/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-binomcoef/main/LICENSE
[binomial-coefficient]: https://en.wikipedia.org/wiki/Binomial_coefficient