UNPKG

mathjs

Version:

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

49 lines (30 loc) 1.16 kB
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. --> # Function subtract Subtract two values, `x - y`. For matrices, the function is evaluated element wise. ## Syntax ```js math.subtract(x, y) ``` ### Parameters Parameter | Type | Description --------- | ---- | ----------- `x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Initial value `y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Value to subtract from `x` ### Returns Type | Description ---- | ----------- number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Subtraction of `x` and `y` ## Examples ```js math.subtract(5.3, 2) // returns number 3.3 const a = math.complex(2, 3) const b = math.complex(4, 1) math.subtract(a, b) // returns Complex -2 + 2i math.subtract([5, 7, 4], 4) // returns Array [1, 3, 0] const c = math.unit('2.1 km') const d = math.unit('500m') math.subtract(c, d) // returns Unit 1.6 km ``` ## See also [add](add.md)