mathjs
Version:
Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser and offers an integrated solution to work with numbers, big numbers, complex numbers, units, and matrices.
51 lines (32 loc) • 1.29 kB
Markdown
# Function largerEq
Test whether value x is larger or equal to y.
The function returns true when x is larger than y or the relative
difference between x and y is smaller than the configured epsilon. The
function cannot be used to compare values smaller than approximately 2.22e-16.
For matrices, the function is evaluated element wise.
## Syntax
```js
math.largerEq(x, y)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | Number | BigNumber | Boolean | Unit | String | Array | Matrix | null | First value to compare
`y` | Number | BigNumber | Boolean | Unit | String | Array | Matrix | null | Second value to compare
### Returns
Type | Description
---- | -----------
Boolean | Array | Matrix | Returns true when the x is larger or equal to y, else returns false
## Examples
```js
math.larger(2, 1 + 1); // returns false
math.largerEq(2, 1 + 1); // returns true
```
## See also
[equal](equal.md),
[unequal](unequal.md),
[smaller](smaller.md),
[smallerEq](smallerEq.md),
[larger](larger.md),
[compare](compare.md)
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->