Struct l_group_formulas::literal::Literal

pub struct Literal {
    pub character: char,
    pub id: usize,
    pub is_inverted: bool,
}

The smallest term (apart from the identity).

Examples

Literals can be parsed from a string. Basic usage: Symbols with ids are okay.

use l_group_formulas::literal::Literal;
let literal = Literal::new('x', 31, true);
assert_eq!(literal, Literal::from("X31"));

So are symbols without.

let literal = Literal::new('y', 0, false);
assert_eq!(literal, Literal::from("y"));

Alternatively, literals can be constructed from characters. This sets id to zero and is_inverted to false.

use l_group_formulas::literal::*;
let literal1 = Literal::from('x');
let literal2 = Literal::new('x', 0, false);
assert_eq!(literal1, literal2);

Fields

character: char

id: usize

is_inverted: bool

Implementations

impl Literal

pub fn new(character: char, id: usize, is_inverted: bool) -> Literal

Trait Implementations

impl Clone for Literal

fn clone(&self) -> Literal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Literal

impl Debug for Literal

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

Formats the value using the given formatter.

impl Eq for Literal

impl<'_> From<&'_ str> for Literal

fn from(s: &str) -> Literal

Performs the conversion.

impl From<Literal> for FreeGroupTerm

fn from(x: Literal) -> FreeGroupTerm

Performs the conversion.

impl From<Literal> for LGroupTerm

fn from(x: Literal) -> LGroupTerm

Performs the conversion.

impl From<Literal> for ShortFreeGroupTerm

fn from(x: Literal) -> ShortFreeGroupTerm

Performs the conversion.

impl From<char> for Literal

fn from(c: char) -> Literal

Performs the conversion.

impl Hash for Literal

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, 

Feeds a slice of this type into the given [Hasher].

impl Mul<Literal> for FreeGroupTerm

type Output = FreeGroupTerm

The resulting type after applying the * operator.

fn mul(self, other: Literal) -> FreeGroupTerm

Performs the * operation.

impl Mul<Literal> for Literal

type Output = FreeGroupTerm

The resulting type after applying the * operator.

fn mul(self, other: Literal) -> FreeGroupTerm

Performs the * operation.

impl Ord for Literal

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Literal> for Literal

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Literal> for Literal

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Literal

impl StructuralPartialEq for Literal

impl Term for Literal

fn inverse(&self) -> Literal

impl ToString for Literal

fn to_string(&self) -> String

Converts the given value to a String.