UNPKG

1.44 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function smaller
4
5Test whether value x is smaller than y.
6
7The function returns true when x is smaller than y and the relative
8difference between x and y is smaller than the configured epsilon. The
9function cannot be used to compare values smaller than approximately 2.22e-16.
10
11For matrices, the function is evaluated element wise.
12Strings are compared by their numerical value.
13
14
15## Syntax
16
17```js
18math.smaller(x, y)
19```
20
21### Parameters
22
23Parameter | Type | Description
24--------- | ---- | -----------
25`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare
26`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare
27
28### Returns
29
30Type | Description
31---- | -----------
32boolean &#124; Array &#124; Matrix | Returns true when the x is smaller than y, else returns false
33
34
35## Examples
36
37```js
38math.smaller(2, 3) // returns true
39math.smaller(5, 2 * 2) // returns false
40
41const a = math.unit('5 cm')
42const b = math.unit('2 inch')
43math.smaller(a, b) // returns true
44```
45
46
47## See also
48
49[equal](equal.md),
50[unequal](unequal.md),
51[smallerEq](smallerEq.md),
52[smaller](smaller.md),
53[smallerEq](smallerEq.md),
54[compare](compare.md)