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
51 lines (33 loc) • 1.33 kB
Markdown
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function smallerEq
Test whether value x is smaller or equal to y.
The function returns true when x is smaller 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.
Strings are compared by their numerical value.
## Syntax
```js
math.smallerEq(x, y)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | First value to compare
`y` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | Second value to compare
### Returns
Type | Description
---- | -----------
boolean | Array | Matrix | Returns true when the x is smaller than y, else returns false
## Examples
```js
math.smaller(1 + 2, 3) // returns false
math.smallerEq(1 + 2, 3) // returns true
```
## See also
[equal](equal.md),
[unequal](unequal.md),
[smaller](smaller.md),
[larger](larger.md),
[largerEq](largerEq.md),
[compare](compare.md)