atrium-api-fluent/ch.tutteli.atrium.api.fluent.en_GB/toEqualNumerically

toEqualNumerically

fun <T : BigDecimal> Expect<T>.toEqualNumerically(expected: T): Expect<T>(source)

Expects that the subject of this expectation (a BigDecimal) is numerically equal to expected.

By numerically is meant that it will not compare BigDecimal.scale (or in other words, it uses compareTo(expected) == 0)

Most of the time you want to use this function instead of toEqualIncludingScale because toEqualIncludingScale compares BigDecimal.scale. Following the two functions compared:

expect(BigDecimal("10")).toEqualIncludingScale(BigDecimal("10.0")) does not hold.
expect(BigDecimal("10")).toEqualNumerically(BigDecimal("10.0")) holds.

Return

an Expect for the subject of this expectation.

Since

0.17.0

Samples

expect(BigDecimal("10")).toEqualNumerically(BigDecimal("10.0"))
expect(BigDecimal("1213669989183")).toEqualNumerically(BigDecimal("1213669989183"))
expect(BigDecimal("1238126387123")).toEqualNumerically(BigDecimal("1238126387123"))


expect(BigDecimal(10)).toEqualNumerically(BigDecimal(10.0))
expect(BigDecimal(1213669989183)).toEqualNumerically(BigDecimal(1213669989183))
expect(BigDecimal(1238126387123)).toEqualNumerically(BigDecimal(1238126387123))

fails {
    expect(BigDecimal(10)).toEqualNumerically(BigDecimal(10.1))
}