expect_tensor_equal: Does code return the expected value?

In ricci: Ricci Calculus

Does code return the expected value?

Description

Adds an expectation function that can be used with the testthat package. Compares two tensors and determines whether they are equal or not.

Usage

expect_tensor_equal(object, expected, ...)

Arguments

object, expected

Computation and value to compare it to. Both arguments supports limited unquoting to make it easier to generate readable failures within a function or for loop. See quasi_label for more details.

...

Arguments passed on to waldo::compare tolerance If non-NULL, used as threshold for ignoring small floating point difference when comparing numeric vectors. Using any non-NULL value will cause integer and double vectors to be compared based on their values, not their types, and will ignore the difference between NaN and NA_real_. It uses the same algorithm as all.equal(), i.e., first we generate x_diff and y_diff by subsetting x and y to look only locations with differences. Then we check that mean(abs(x_diff - y_diff)) / mean(abs(y_diff)) (or just mean(abs(x_diff - y_diff)) if y_diff is small) is less than tolerance. max_diffs Control the maximum number of differences shown. The default shows 10 differences when run interactively and all differences when run in CI. Set max_diffs = Inf to see all differences. ignore_srcref Ignore differences in function srcrefs? TRUE by default since the srcref does not change the behaviour of a function, only its printed representation. ignore_encoding Ignore string encoding? TRUE by default, because this is R's default behaviour. Use FALSE when specifically concerned with the encoding, not just the value of the string.

Value

The actual value invisibly.

ricci documentation built on Sept. 9, 2025, 5:56 p.m.