permutations.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. import { isInteger } from '../../utils/number.js';
  2. import { product } from '../../utils/product.js';
  3. import { factory } from '../../utils/factory.js';
  4. var name = 'permutations';
  5. var dependencies = ['typed', 'factorial'];
  6. export var createPermutations = /* #__PURE__ */factory(name, dependencies, _ref => {
  7. var {
  8. typed,
  9. factorial
  10. } = _ref;
  11. /**
  12. * Compute the number of ways of obtaining an ordered subset of `k` elements
  13. * from a set of `n` elements.
  14. *
  15. * Permutations only takes integer arguments.
  16. * The following condition must be enforced: k <= n.
  17. *
  18. * Syntax:
  19. *
  20. * math.permutations(n)
  21. * math.permutations(n, k)
  22. *
  23. * Examples:
  24. *
  25. * math.permutations(5) // 120
  26. * math.permutations(5, 3) // 60
  27. *
  28. * See also:
  29. *
  30. * combinations, combinationsWithRep, factorial
  31. *
  32. * @param {number | BigNumber} n The number of objects in total
  33. * @param {number | BigNumber} [k] The number of objects in the subset
  34. * @return {number | BigNumber} The number of permutations
  35. */
  36. return typed(name, {
  37. 'number | BigNumber': factorial,
  38. 'number, number': function numberNumber(n, k) {
  39. if (!isInteger(n) || n < 0) {
  40. throw new TypeError('Positive integer value expected in function permutations');
  41. }
  42. if (!isInteger(k) || k < 0) {
  43. throw new TypeError('Positive integer value expected in function permutations');
  44. }
  45. if (k > n) {
  46. throw new TypeError('second argument k must be less than or equal to first argument n');
  47. }
  48. // Permute n objects, k at a time
  49. return product(n - k + 1, n);
  50. },
  51. 'BigNumber, BigNumber': function BigNumberBigNumber(n, k) {
  52. var result, i;
  53. if (!isPositiveInteger(n) || !isPositiveInteger(k)) {
  54. throw new TypeError('Positive integer value expected in function permutations');
  55. }
  56. if (k.gt(n)) {
  57. throw new TypeError('second argument k must be less than or equal to first argument n');
  58. }
  59. var one = n.mul(0).add(1);
  60. result = one;
  61. for (i = n.minus(k).plus(1); i.lte(n); i = i.plus(1)) {
  62. result = result.times(i);
  63. }
  64. return result;
  65. }
  66. // TODO: implement support for collection in permutations
  67. });
  68. });
  69. /**
  70. * Test whether BigNumber n is a positive integer
  71. * @param {BigNumber} n
  72. * @returns {boolean} isPositiveInteger
  73. */
  74. function isPositiveInteger(n) {
  75. return n.isInteger() && n.gte(0);
  76. }