'use strict'; module.exports = function (math) { var util = require('../../util/index'), BigNumber = math.type.BigNumber, collection = math.collection, isNumber = util.number.isNumber, isInteger = util.number.isInteger; /** * 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. * * Syntax: * * math.combinations(n, k) * * Examples: * * math.combinations(7, 5); // returns 21 * * See also: * * permutations, factorial * * @param {Number | BigNumber} n Total number of objects in the set * @param {Number | BigNumber} k Number of objects in the subset * @return {Number | BigNumber} Number of possible combinations. */ math.combinations = function combinations (n, k) { var max, result, i,ii; var arity = arguments.length; if (arity != 2) { throw new math.error.ArgumentsError('combinations', arguments.length, 2); } if (isNumber(n)) { if (!isInteger(n) || n < 0) { throw new TypeError('Positive integer value enpected in function combinations'); } if (k > n) { throw new TypeError('k must be less than or equal to n'); } max = Math.max(k, n - k); result = 1; for (i = 1; i <= n - max; i++) { result = result * (max + i) / i; } return result; } if (n instanceof BigNumber) { // make sure k is a BigNumber as well // not all numbers can be converted to BigNumber k = BigNumber.convert(k); if (!(k instanceof BigNumber) || !isPositiveInteger(n) || !isPositiveInteger(k)) { throw new TypeError('Positive integer value expected in function combinations'); } if (k.gt(n)) { throw new TypeError('k must be less than n in function combinations'); } max = n.minus(k); if (k.lt(max)) max = k; result = new BigNumber(1); for (i = new BigNumber(1), ii = n.minus(max); i.lte(ii); i = i.plus(1)) { result = result.times(max.plus(i)).dividedBy(i); } return result; } throw new math.error.UnsupportedTypeError('combinations', math['typeof'](n)); }; /** * Test whether BigNumber n is a positive integer * @param {BigNumber} n * @returns {boolean} isPositiveInteger */ var isPositiveInteger = function(n) { return n.isInteger() && n.gte(0); }; };