Enum arithmetic_eval::fns::Compare

source ·
#[non_exhaustive]
pub enum Compare { Raw, Min, Max, }
Expand description

Comparator functions on two primitive arguments. All functions use Arithmetic to determine ordering between the args.

§Type

fn(Num, Num) -> Ordering // for `Compare::Raw`
fn(Num, Num) -> Num // for `Compare::Min` and `Compare::Max`

§Examples

Using min function:

let program = "
    // Finds a minimum number in an array.
    extended_min = |...xs| fold(xs, INFINITY, min);
    extended_min(2, -3, 7, 1, 3) == -3
";
let program = Untyped::<F32Grammar>::parse_statements(program)?;
let module = ExecutableModule::new("test_min", &program)?;

let mut env = Environment::new();
env.insert("INFINITY", Value::Prim(f32::INFINITY))
    .insert_native_fn("fold", fns::Fold)
    .insert_native_fn("min", fns::Compare::Min);
assert_eq!(module.with_env(&env)?.run()?, Value::Bool(true));

Using cmp function with Comparisons.

let program = "
    map((1, -7, 0, 2), |x| cmp(x, 0)) == (GREATER, LESS, EQUAL, GREATER)
";
let program = Untyped::<F32Grammar>::parse_statements(program)?;
let module = ExecutableModule::new("test_cmp", &program)?;

let mut env = Environment::new();
env.extend(Comparisons::iter());
env.insert_native_fn("map", fns::Map);
assert_eq!(module.with_env(&env)?.run()?, Value::Bool(true));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Raw

Returns an Ordering wrapped into an OpaqueRef, or Value::void() if the provided values are not comparable.

§

Min

Returns the minimum of the two values. If the values are equal / not comparable, returns the first one.

§

Max

Returns the maximum of the two values. If the values are equal / not comparable, returns the first one.

Trait Implementations§

source§

impl Clone for Compare

source§

fn clone(&self) -> Compare

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Compare

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> NativeFn<T> for Compare

source§

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

Executes the function on the specified arguments.
source§

impl Copy for Compare

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.