mathjs/lib/function/trigonometry/acot.js

'use strict';

var bigArcCot = require('../../util/bignumber').arctan_arccot;

var HALF_PI = 1.5707963267948966;

function factory (type, config, load, typed) {
  var collection = load(require('../../type/matrix/collection'));
  var complexAtan = load(require('./atan')).signatures['Complex'];

  /**
   * Calculate the inverse cotangent of a value.
   *
   * For matrices, the function is evaluated element wise.
   *
   * Syntax:
   *
   *    math.acot(x)
   *
   * Examples:
   *
   *    math.acot(0.5);           // returns Number 0.4636476090008061
   *    math.acot(math.cot(1.5)); // returns Number 1.5
   *
   *    math.acot(2);             // returns Complex 1.5707963267948966 -1.3169578969248166 i
   *
   * See also:
   *
   *    cot, atan
   *
   * @param {Number | Boolean | Complex | Array | Matrix | null} x   Function input
   * @return {Number | Complex | Array | Matrix} The arc cotangent of x
   */
  var acot = typed('acot', {
    'number': function (x) {
      return (x) ? Math.atan(1 / x) : HALF_PI;
    },

    'Complex': function (x) {
      if (x.im == 0) {
        return new type.Complex(x.re ? Math.atan(1 / x.re) : HALF_PI, 0);
      }

      var den = x.re*x.re + x.im*x.im;
      x = (den != 0)
          ? new type.Complex(
          x.re =  x.re / den,
          x.im = -x.im / den)
          : new type.Complex(
          (x.re != 0) ?  (x.re / 0) : 0,
          (x.im != 0) ? -(x.im / 0) : 0);

      return complexAtan(x);
    },

    'BigNumber': function (x) {
      return bigArcCot(x, type.BigNumber, true);
    },

    'Array | Matrix': function (x) {
      return collection.deepMap(x, acot);
    }
  });

  return acot;
}

exports.name = 'acot';
exports.factory = factory;