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

toEqualIncludingScale

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

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

Most of the time you want to use toEqualNumerically which does not compare BigDecimal.scale in contrast to this function. 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.0")).toEqualIncludingScale(BigDecimal("10.0"))
expect(BigDecimal("456.0")).toEqualIncludingScale(BigDecimal("456.0"))
expect(BigDecimal("-1.456")).toEqualIncludingScale(BigDecimal("-1.456"))

expect(BigDecimal(10.0)).toEqualIncludingScale(BigDecimal(10.0))
expect(BigDecimal(456.0)).toEqualIncludingScale(BigDecimal(456.0))

fails {
    // because scale is different, use toEqualNumerically if you want to ignore the scale
    expect(BigDecimal("10")).toEqualIncludingScale(BigDecimal("10.0"))
}