Struct arithmetic_eval::fns::AssertClose

pub struct AssertClose<T> { /* private fields */ }

Assertion that two values are close to each other.

Unlike AssertEq, the arguments must be primitive. The function is parameterized by the tolerance threshold.

Type

(using arithmetic-typing notation)

(Num, Num) -> ()

Examples

let program = "
    assert_close(sqrt(9), 3); // this assertion is fine
    assert_close(sqrt(10), 3); // this one should fail
";
let module = Untyped::<F32Grammar>::parse_statements(program)?;
let module = ExecutableModule::new("test_assert", &module)?;

let mut env = Environment::new();
env.insert_native_fn("assert_close", fns::AssertClose::new(1e-4))
    .insert_wrapped_fn("sqrt", f32::sqrt);

let err = module.with_env(&env)?.run().unwrap_err();
assert_eq!(
    err.source().location().in_module().span(program),
    "assert_close(sqrt(10), 3)"
);

Implementations

impl<T> AssertClose<T>

pub const fn new(tolerance: T) -> Self

Creates a function with the specified tolerance threshold. No checks are performed on the threshold (e.g., that it is positive).

Trait Implementations

impl<T: Clone> Clone for AssertClose<T>

fn clone(&self) -> AssertClose<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AssertClose<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Clone + Display> NativeFn<T> for AssertClose<T>

fn evaluate( &self, args: Vec<SpannedValue<T>>, ctx: &mut CallContext<'_, T>, ) -> EvalResult<T>

Executes the function on the specified arguments.

impl<T: Copy> Copy for AssertClose<T>