Function smaller

Test whether value x is smaller than y.

The function returns true when x is smaller than y and 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

math.smaller(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

Throws

Type	Description

Examples

math.smaller(2, 3)            // returns true
math.smaller(5, 2 * 2)        // returns false

const a = math.unit('5 cm')
const b = math.unit('2 inch')
math.smaller(a, b)            // returns true

1.5 KiB Raw Blame History