Struct algae_rs::magma::Monoid

source ·
pub struct Monoid<'a, T> { /* private fields */ }
Expand description

A set equipped with an associative binary operation with identity.

Monoid is a representation of the abstract algebraic monoid. Associativity and identity are required of its binary operation. Its construction involves a set (specifically an AlgaeSet and a BinaryOperation with the aforementioned properties.

Examples

use algae_rs::algaeset::AlgaeSet;
use algae_rs::mapping::{BinaryOperation, MonoidOperation};
use algae_rs::magma::{Magmoid, Monoid};

let mut add = MonoidOperation::new(&|a, b| a + b, 0);
let mut monoid = Monoid::new(
    AlgaeSet::<i32>::all(),
    &mut add,
    0
);

let monoid_sum = monoid.with(1, 2);
assert!(monoid_sum.is_ok());
assert!(monoid_sum.unwrap() == 3);

let mut bad_add = MonoidOperation::new(&|a, b| a + b, 1);
let mut bad_monoid = Monoid::new(
    AlgaeSet::<i32>::all(),
    &mut bad_add,
    1
);

let bad_monoid_sum = bad_monoid.with(1, 2);
assert!(bad_monoid_sum.is_err());

Implementations§

source§

impl<'a, T: Copy + PartialEq> Monoid<'a, T>

source

pub fn new(
aset: AlgaeSet<T>,
binop: &'a mut dyn BinaryOperation<T>,
identity: T
) -> Self

Trait Implementations§

source§

impl<'a, T: Copy + PartialEq> Magmoid<T> for Monoid<'a, T>

source§

fn binop(&mut self) -> &mut dyn BinaryOperation<T>

source§

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

Auto Trait Implementations§

§

impl<'a, T> !RefUnwindSafe for Monoid<'a, T>

§

impl<'a, T> !Send for Monoid<'a, T>

§

impl<'a, T> !Sync for Monoid<'a, T>

§

impl<'a, T> Unpin for Monoid<'a, T>where
T: Unpin,

§

impl<'a, T> !UnwindSafe for Monoid<'a, T>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.