1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- import { deepMap } from '../../utils/collection.js';
- import { factory } from '../../utils/factory.js';
- var name = 'factorial';
- var dependencies = ['typed', 'gamma'];
- export var createFactorial = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- typed,
- gamma
- } = _ref;
- /**
- * Compute the factorial of a value
- *
- * Factorial only supports an integer value as argument.
- * For matrices, the function is evaluated element wise.
- *
- * Syntax:
- *
- * math.factorial(n)
- *
- * Examples:
- *
- * math.factorial(5) // returns 120
- * math.factorial(3) // returns 6
- *
- * See also:
- *
- * combinations, combinationsWithRep, gamma, permutations
- *
- * @param {number | BigNumber | Array | Matrix} n An integer number
- * @return {number | BigNumber | Array | Matrix} The factorial of `n`
- */
- return typed(name, {
- number: function number(n) {
- if (n < 0) {
- throw new Error('Value must be non-negative');
- }
- return gamma(n + 1);
- },
- BigNumber: function BigNumber(n) {
- if (n.isNegative()) {
- throw new Error('Value must be non-negative');
- }
- return gamma(n.plus(1));
- },
- 'Array | Matrix': typed.referToSelf(self => n => deepMap(n, self))
- });
- });
|