simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

sinh.js (1560B)

      1 "use strict";
      2 
      3 Object.defineProperty(exports, "__esModule", {
      4   value: true
      5 });
      6 exports.createSinh = void 0;
      7 
      8 var _factory = require("../../utils/factory.js");
      9 
     10 var _collection = require("../../utils/collection.js");
     11 
     12 var _index = require("../../plain/number/index.js");
     13 
     14 var name = 'sinh';
     15 var dependencies = ['typed'];
     16 var createSinh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
     17   var typed = _ref.typed;
     18 
     19   /**
     20    * Calculate the hyperbolic sine of a value,
     21    * defined as `sinh(x) = 1/2 * (exp(x) - exp(-x))`.
     22    *
     23    * For matrices, the function is evaluated element wise.
     24    *
     25    * Syntax:
     26    *
     27    *    math.sinh(x)
     28    *
     29    * Examples:
     30    *
     31    *    math.sinh(0.5)       // returns number 0.5210953054937474
     32    *
     33    * See also:
     34    *
     35    *    cosh, tanh
     36    *
     37    * @param {number | BigNumber | Complex | Unit | Array | Matrix} x  Function input
     38    * @return {number | BigNumber | Complex | Array | Matrix} Hyperbolic sine of x
     39    */
     40   return typed(name, {
     41     number: _index.sinhNumber,
     42     Complex: function Complex(x) {
     43       return x.sinh();
     44     },
     45     BigNumber: function BigNumber(x) {
     46       return x.sinh();
     47     },
     48     Unit: function Unit(x) {
     49       if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
     50         throw new TypeError('Unit in function sinh is no angle');
     51       }
     52 
     53       return this(x.value);
     54     },
     55     'Array | Matrix': function ArrayMatrix(x) {
     56       // deep map collection, skip zeros since sinh(0) = 0
     57       return (0, _collection.deepMap)(x, this, true);
     58     }
     59   });
     60 });
     61 exports.createSinh = createSinh;