53 lines
1.4 KiB
JavaScript
53 lines
1.4 KiB
JavaScript
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.createFactorial = void 0;
|
|
var _collection = require("../../utils/collection.js");
|
|
var _factory = require("../../utils/factory.js");
|
|
const name = 'factorial';
|
|
const dependencies = ['typed', 'gamma'];
|
|
const createFactorial = exports.createFactorial = /* #__PURE__ */(0, _factory.factory)(name, dependencies, _ref => {
|
|
let {
|
|
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 (n) {
|
|
if (n < 0) {
|
|
throw new Error('Value must be non-negative');
|
|
}
|
|
return gamma(n + 1);
|
|
},
|
|
BigNumber: function (n) {
|
|
if (n.isNegative()) {
|
|
throw new Error('Value must be non-negative');
|
|
}
|
|
return gamma(n.plus(1));
|
|
},
|
|
'Array | Matrix': typed.referToSelf(self => n => (0, _collection.deepMap)(n, self))
|
|
});
|
|
}); |