Struct BooleanSemiring 

pub struct BooleanSemiring(/* private fields */);

Boolean semiring for ordinary exact relation semantics.

BooleanSemiring is the first built-in annotation family in G4. It keeps the exact meaning already used by the published unary, binary, and n-ary relations:

• false is zero and represents absence;
• true is one and represents presence or identity;
• add uses logical OR;
• mul uses logical AND.

Examples

use relmath::annotated::{BooleanSemiring, Semiring};

let direct = BooleanSemiring::FALSE;
let first_leg = BooleanSemiring::TRUE;
let second_leg = BooleanSemiring::TRUE;

assert_eq!(direct.add(&first_leg), BooleanSemiring::TRUE);
assert_eq!(first_leg.mul(&second_leg), BooleanSemiring::TRUE);
assert!(BooleanSemiring::zero().is_zero());
assert!(BooleanSemiring::one().is_one());

Implementations

impl BooleanSemiring

pub const FALSE: Self

The additive identity and absence value for the boolean semiring.

pub const TRUE: Self

The multiplicative identity and present value for the boolean semiring.

pub const fn new(value: bool) -> Self

Creates a boolean semiring value from a raw boolean.

Examples

use relmath::annotated::BooleanSemiring;

assert_eq!(BooleanSemiring::new(false), BooleanSemiring::FALSE);
assert_eq!(BooleanSemiring::new(true), BooleanSemiring::TRUE);

pub const fn value(self) -> bool

Returns the raw boolean stored by this semiring value.

Examples

use relmath::annotated::BooleanSemiring;

assert!(!BooleanSemiring::FALSE.value());
assert!(BooleanSemiring::TRUE.value());

Trait Implementations

impl Clone for BooleanSemiring

fn clone(&self) -> BooleanSemiring

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BooleanSemiring

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

Formats the value using the given formatter.

impl Default for BooleanSemiring

fn default() -> BooleanSemiring

Returns the “default value” for a type.

impl From<BooleanSemiring> for bool

fn from(value: BooleanSemiring) -> Self

Converts to this type from the input type.

impl From<bool> for BooleanSemiring

fn from(value: bool) -> Self

Converts to this type from the input type.

impl Hash for BooleanSemiring

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BooleanSemiring

fn cmp(&self, other: &BooleanSemiring) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BooleanSemiring

fn eq(&self, other: &BooleanSemiring) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BooleanSemiring

fn partial_cmp(&self, other: &BooleanSemiring) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Semiring for BooleanSemiring

fn zero() -> Self

Returns the additive identity for the annotation domain.

fn one() -> Self

Returns the multiplicative identity for the annotation domain.

fn add(&self, rhs: &Self) -> Self

Combines two annotations with union-like or choice-like semantics.

fn mul(&self, rhs: &Self) -> Self

Combines two annotations with chaining or composition-like semantics.

fn is_zero(&self) -> bool

Returns true when this annotation is the additive identity.

fn is_one(&self) -> bool

Returns true when this annotation is the multiplicative identity.

impl Copy for BooleanSemiring

impl Eq for BooleanSemiring

impl StructuralPartialEq for BooleanSemiring