mathjs/docs/reference/functions/combinations.md
2022-03-01 13:04:09 +01:00

54 lines
1.4 KiB
Markdown

---
layout: default
---
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
<h1 id="function-combinations">Function combinations <a href="#function-combinations" title="Permalink">#</a></h1>
Compute the number of ways of picking `k` unordered outcomes from `n`
possibilities.
Combinations only takes integer arguments.
The following condition must be enforced: k <= n.
<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>
```js
math.combinations(n, k)
```
<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>
Parameter | Type | Description
--------- | ---- | -----------
`n` | number &#124; BigNumber | Total number of objects in the set
`k` | number &#124; BigNumber | Number of objects in the subset
<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>
Type | Description
---- | -----------
number &#124; BigNumber | Number of possible combinations.
<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>
Type | Description
---- | -----------
<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>
```js
math.combinations(7, 5) // returns 21
```
<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>
[combinationsWithRep](combinationsWithRep.html),
[permutations](permutations.html),
[factorial](factorial.html)