simple-squiggle

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

re.js (1563B)

      1 "use strict";
      2 
      3 Object.defineProperty(exports, "__esModule", {
      4   value: true
      5 });
      6 exports.createRe = void 0;
      7 
      8 var _factory = require("../../utils/factory.js");
      9 
     10 var _collection = require("../../utils/collection.js");
     11 
     12 var name = 're';
     13 var dependencies = ['typed'];
     14 var createRe = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
     15   var typed = _ref.typed;
     16 
     17   /**
     18    * Get the real part of a complex number.
     19    * For a complex number `a + bi`, the function returns `a`.
     20    *
     21    * For matrices, the function is evaluated element wise.
     22    *
     23    * Syntax:
     24    *
     25    *    math.re(x)
     26    *
     27    * Examples:
     28    *
     29    *    const a = math.complex(2, 3)
     30    *    math.re(a)                     // returns number 2
     31    *    math.im(a)                     // returns number 3
     32    *
     33    *    math.re(math.complex('-5.2i')) // returns number 0
     34    *    math.re(math.complex(2.4))     // returns number 2.4
     35    *
     36    * See also:
     37    *
     38    *    im, conj, abs, arg
     39    *
     40    * @param {number | BigNumber | Complex | Array | Matrix} x
     41    *            A complex number or array with complex numbers
     42    * @return {number | BigNumber | Array | Matrix} The real part of x
     43    */
     44   return typed(name, {
     45     number: function number(x) {
     46       return x;
     47     },
     48     BigNumber: function BigNumber(x) {
     49       return x;
     50     },
     51     Fraction: function Fraction(x) {
     52       return x;
     53     },
     54     Complex: function Complex(x) {
     55       return x.re;
     56     },
     57     'Array | Matrix': function ArrayMatrix(x) {
     58       return (0, _collection.deepMap)(x, this);
     59     }
     60   });
     61 });
     62 exports.createRe = createRe;