simple-squiggle/node_modules/mathjs/lib/esm/function/trigonometry/sech.js

54 lines
1.4 KiB
JavaScript

import { factory } from '../../utils/factory.js';
import { deepMap } from '../../utils/collection.js';
import { sechNumber } from '../../plain/number/index.js';
var name = 'sech';
var dependencies = ['typed', 'BigNumber'];
export var createSech = /* #__PURE__ */factory(name, dependencies, _ref => {
var {
typed,
BigNumber: _BigNumber
} = _ref;
/**
* Calculate the hyperbolic secant of a value,
* defined as `sech(x) = 1 / cosh(x)`.
*
* For matrices, the function is evaluated element wise.
*
* Syntax:
*
* math.sech(x)
*
* Examples:
*
* // sech(x) = 1/ cosh(x)
* math.sech(0.5) // returns 0.886818883970074
* 1 / math.cosh(0.5) // returns 0.886818883970074
*
* See also:
*
* cosh, csch, coth
*
* @param {number | Complex | Unit | Array | Matrix} x Function input
* @return {number | Complex | Array | Matrix} Hyperbolic secant of x
*/
return typed(name, {
number: sechNumber,
Complex: function Complex(x) {
return x.sech();
},
BigNumber: function BigNumber(x) {
return new _BigNumber(1).div(x.cosh());
},
Unit: function Unit(x) {
if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
throw new TypeError('Unit in function sech is no angle');
}
return this(x.value);
},
'Array | Matrix': function ArrayMatrix(x) {
return deepMap(x, this);
}
});
});