mathjs/src/function/trigonometry/asec.js

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif

'use strict'

const deepMap = require('../../utils/collection/deepMap')

function factory (type, config, load, typed) {
  /**
   * Calculate the inverse secant of a value. Defined as `asec(x) = acos(1/x)`.
   *
   * For matrices, the function is evaluated element wise.
   *
   * Syntax:
   *
   *    math.asec(x)
   *
   * Examples:
   *
   *    math.asec(0.5)           // returns 1.0471975511965979
   *    math.asec(math.sec(1.5)) // returns 1.5
   *
   *    math.asec(2)             // returns 0 + 1.3169578969248166 i
   *
   * See also:
   *
   *    acos, acot, acsc
   *
   * @param {number | Complex | Array | Matrix} x  Function input
   * @return {number | Complex | Array | Matrix} The arc secant of x
   */
  const asec = typed('asec', {
    'number': function (x) {
      if (x <= -1 || x >= 1 || config.predictable) {
        return Math.acos(1 / x)
      }
      return new type.Complex(x, 0).asec()
    },

    'Complex': function (x) {
      return x.asec()
    },

    'BigNumber': function (x) {
      return new type.BigNumber(1).div(x).acos()
    },

    'Array | Matrix': function (x) {
      return deepMap(x, asec)
    }
  })

  asec.toTex = { 1: `\\sec^{-1}\\left(\${args[0]}\\right)` }

  return asec
}

exports.name = 'asec'
exports.factory = factory