Struct algae_rs::mapping::AbelianOperation

pub struct AbelianOperation<'a, T> { /* private fields */ }

A function wrapper enforcing commutativity.

Examples

let mut add = AbelianOperation::new(&|a, b| {
    a + b
});

let sum = add.with(1, 2);
assert!(sum.is_ok());
assert!(sum.unwrap() == 3);

let mut sub = AbelianOperation::new(&|a, b| {
    a - b
});

let pos_difference = sub.with(4, 3);
assert!(pos_difference.is_err());

let neg_difference = sub.with(1, 2);
assert!(neg_difference.is_err());

Implementations

impl<'a, T> AbelianOperation<'a, T>

pub fn new(op: &'a dyn Fn(T, T) -> T) -> Self

Trait Implementations

impl<'a, T: Copy + PartialEq> BinaryOperation<T> for AbelianOperation<'a, T>

fn operation(&self) -> &dyn Fn(T, T) -> T

Returns a reference to the function underlying the operation

fn properties(&self) -> Vec<PropertyType<T>>

Vec of all enforced properties

fn input_history(&self) -> &Vec<T>

Returns a reference to a Vec of all previous inputs to the operation

fn cache(&mut self, input: T)

Caches the given input to the operation’s input history

fn is(&self, property: PropertyType<T>) -> bool

Returns whether or not property is enforced by the given operation

fn with(&mut self, left: T, right: T) -> Result<T, PropertyError>

Returns the result of performing the given operation.