simple-squiggle

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

square.js (1760B)

      1 "use strict";
      2 
      3 Object.defineProperty(exports, "__esModule", {
      4   value: true
      5 });
      6 exports.createSquare = 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 = 'square';
     15 var dependencies = ['typed'];
     16 var createSquare = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
     17   var typed = _ref.typed;
     18 
     19   /**
     20    * Compute the square of a value, `x * x`.
     21    * For matrices, the function is evaluated element wise.
     22    *
     23    * Syntax:
     24    *
     25    *    math.square(x)
     26    *
     27    * Examples:
     28    *
     29    *    math.square(2)           // returns number 4
     30    *    math.square(3)           // returns number 9
     31    *    math.pow(3, 2)           // returns number 9
     32    *    math.multiply(3, 3)      // returns number 9
     33    *
     34    *    math.square([1, 2, 3, 4])  // returns Array [1, 4, 9, 16]
     35    *
     36    * See also:
     37    *
     38    *    multiply, cube, sqrt, pow
     39    *
     40    * @param  {number | BigNumber | Fraction | Complex | Array | Matrix | Unit} x
     41    *            Number for which to calculate the square
     42    * @return {number | BigNumber | Fraction | Complex | Array | Matrix | Unit}
     43    *            Squared value
     44    */
     45   return typed(name, {
     46     number: _index.squareNumber,
     47     Complex: function Complex(x) {
     48       return x.mul(x);
     49     },
     50     BigNumber: function BigNumber(x) {
     51       return x.times(x);
     52     },
     53     Fraction: function Fraction(x) {
     54       return x.mul(x);
     55     },
     56     'Array | Matrix': function ArrayMatrix(x) {
     57       // deep map collection, skip zeros since square(0) = 0
     58       return (0, _collection.deepMap)(x, this, true);
     59     },
     60     Unit: function Unit(x) {
     61       return x.pow(2);
     62     }
     63   });
     64 });
     65 exports.createSquare = createSquare;