mathjs/src/function/arithmetic/cube.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) {
  /**
   * Compute the cube of a value, `x * x * x`.
   * For matrices, the function is evaluated element wise.
   *
   * Syntax:
   *
   *    math.cube(x)
   *
   * Examples:
   *
   *    math.cube(2)            // returns number 8
   *    math.pow(2, 3)          // returns number 8
   *    math.cube(4)            // returns number 64
   *    4 * 4 * 4               // returns number 64
   *
   *    math.cube([1, 2, 3, 4]) // returns Array [1, 8, 27, 64]
   *
   * See also:
   *
   *    multiply, square, pow, cbrt
   *
   * @param  {number | BigNumber | Fraction | Complex | Array | Matrix | Unit} x  Number for which to calculate the cube
   * @return {number | BigNumber | Fraction | Complex | Array | Matrix | Unit} Cube of x
   */
  const cube = typed('cube', {
    'number': function (x) {
      return x * x * x
    },

    'Complex': function (x) {
      return x.mul(x).mul(x) // Is faster than pow(x, 3)
    },

    'BigNumber': function (x) {
      return x.times(x).times(x)
    },

    'Fraction': function (x) {
      return x.pow(3) // Is faster than mul()mul()mul()
    },

    'Array | Matrix': function (x) {
      // deep map collection, skip zeros since cube(0) = 0
      return deepMap(x, cube, true)
    },

    'Unit': function (x) {
      return x.pow(3)
    }
  })

  cube.toTex = { 1: `\\left(\${args[0]}\\right)^3` }

  return cube
}

exports.name = 'cube'
exports.factory = factory