UNPKG

lml-main

Version:

This is now a mono repository published into many standalone packages.

github.com/lastmilelink/core-ui

lastmilelink/core-ui

58 lines (38 loc) • 1.51 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. --> # Function compare Compare two values. Returns 1 when x > y, -1 when x < y, and 0 when x == y. x and y are considered equal when 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.compare(x, y) ``` ### Parameters Parameter | Type | Description --------- | ---- | ----------- `x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare `y` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare ### Returns Type | Description ---- | ----------- number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Returns the result of the comparison: 1, 0 or -1. ## Examples ```js math.compare(6, 1); // returns 1 math.compare(2, 3); // returns -1 math.compare(7, 7); // returns 0 var a = math.unit('5 cm'); var b = math.unit('40 mm'); math.compare(a, b); // returns 1 math.compare(2, [1, 2, 3]); // returns [1, 0, -1] ``` ## See also [equal](equal.md), [unequal](unequal.md), [smaller](smaller.md), [smallerEq](smallerEq.md), [larger](larger.md), [largerEq](largerEq.md), [compareNatural](compareNatural.md)