combinations.js 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createCombinations = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _combinations = require("../../plain/number/combinations.js");
  8. var name = 'combinations';
  9. var dependencies = ['typed'];
  10. var createCombinations = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  11. var typed = _ref.typed;
  12. /**
  13. * Compute the number of ways of picking `k` unordered outcomes from `n`
  14. * possibilities.
  15. *
  16. * Combinations only takes integer arguments.
  17. * The following condition must be enforced: k <= n.
  18. *
  19. * Syntax:
  20. *
  21. * math.combinations(n, k)
  22. *
  23. * Examples:
  24. *
  25. * math.combinations(7, 5) // returns 21
  26. *
  27. * See also:
  28. *
  29. * combinationsWithRep, permutations, factorial
  30. *
  31. * @param {number | BigNumber} n Total number of objects in the set
  32. * @param {number | BigNumber} k Number of objects in the subset
  33. * @return {number | BigNumber} Number of possible combinations.
  34. */
  35. return typed(name, {
  36. 'number, number': _combinations.combinationsNumber,
  37. 'BigNumber, BigNumber': function BigNumberBigNumber(n, k) {
  38. var BigNumber = n.constructor;
  39. var result, i;
  40. var nMinusk = n.minus(k);
  41. var one = new BigNumber(1);
  42. if (!isPositiveInteger(n) || !isPositiveInteger(k)) {
  43. throw new TypeError('Positive integer value expected in function combinations');
  44. }
  45. if (k.gt(n)) {
  46. throw new TypeError('k must be less than n in function combinations');
  47. }
  48. result = one;
  49. if (k.lt(nMinusk)) {
  50. for (i = one; i.lte(nMinusk); i = i.plus(one)) {
  51. result = result.times(k.plus(i)).dividedBy(i);
  52. }
  53. } else {
  54. for (i = one; i.lte(k); i = i.plus(one)) {
  55. result = result.times(nMinusk.plus(i)).dividedBy(i);
  56. }
  57. }
  58. return result;
  59. }
  60. // TODO: implement support for collection in combinations
  61. });
  62. });
  63. /**
  64. * Test whether BigNumber n is a positive integer
  65. * @param {BigNumber} n
  66. * @returns {boolean} isPositiveInteger
  67. */
  68. exports.createCombinations = createCombinations;
  69. function isPositiveInteger(n) {
  70. return n.isInteger() && n.gte(0);
  71. }