mathjs/docs/reference/functions/largereq.md

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

math.largereq(x, y)

Parameters

Parameter	Type	Description
x	Number | BigNumber | Boolean | Unit | String | Array | Matrix	First value to compare
y	Number | BigNumber | Boolean | Unit | String | Array | Matrix	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

var math = mathjs();

math.larger(2, 1 + 1);         // returns false
math.largereq(2, 1 + 1);       // returns true

See also

equal, unequal, smaller, smallereq, larger, compare