Struct l_group_formulas::free_group_term::FreeGroupTerm

pub struct FreeGroupTerm {
    pub literals: Vec<Literal>,
}

An element of the group algebra.

Examples

To use this, import

use l_group_formulas::free_group_term::*;
use l_group_formulas::literal::*;
use l_group_formulas::*;

Constructing a free group term goes like this.

let term = Literal::from('x') * Literal::from('y');

In this case, term encodes the element xy of a free group.

Terms constructed using FreeGrouPTerm::new automatically get reduced:

let term = Literal::from('x') * Literal::from('x').inverse();
assert_eq!(String::from("e"), term.to_string());

Can also be constructed from strings: FreeGroupTerm::from(&str) parses a free group term from a string.

This ignores all non-alphanumeric characters, such as *. Perhaps dangerously, this also ignores symbols like ^, and treats v as the name of a symbol. The input is parsed by

Examples

Basic usage:

use l_group_formulas::literal::Literal;
use l_group_formulas::free_group_term::FreeGroupTerm;
// this is equivalent to: 
// let string = "X31yz39";
let string = "X3 1*yz39 ";
let x = Literal::new('x', 31, true);
let y = Literal::new('y', 0, false);
let z = Literal::new('z', 39, false);
let term = FreeGroupTerm::new(vec![x, y, z]);
assert_eq!(term, FreeGroupTerm::from(string));

Fields

literals: Vec<Literal>

Implementations

impl FreeGroupTerm

pub fn new(literals: Vec<Literal>) -> FreeGroupTerm

Trait Implementations

impl Clone for FreeGroupTerm

fn clone(&self) -> FreeGroupTerm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FreeGroupTerm

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

Formats the value using the given formatter.

impl Eq for FreeGroupTerm

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

fn from(s: &str) -> FreeGroupTerm

Performs the conversion.

impl From<FreeGroupTerm> for LGroupTerm

fn from(x: FreeGroupTerm) -> LGroupTerm

Performs the conversion.

impl From<FreeGroupTerm> for ShortFreeGroupTerm

fn from(term: FreeGroupTerm) -> ShortFreeGroupTerm

ignores everything after the third symbol

impl From<Literal> for FreeGroupTerm

fn from(x: Literal) -> FreeGroupTerm

Performs the conversion.

impl From<ShortFreeGroupTerm> for FreeGroupTerm

fn from(t: ShortFreeGroupTerm) -> FreeGroupTerm

Performs the conversion.

impl From<char> for FreeGroupTerm

fn from(c: char) -> FreeGroupTerm

Performs the conversion.

impl Mul<FreeGroupTerm> for FreeGroupTerm

type Output = FreeGroupTerm

The resulting type after applying the * operator.

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

Performs the * operation.

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 MulAssign<FreeGroupTerm> for FreeGroupTerm

fn mul_assign(&mut self, rhs: FreeGroupTerm)

Performs the *= operation.

impl Ord for FreeGroupTerm

fn cmp(&self, other: &FreeGroupTerm) -> 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<FreeGroupTerm> for FreeGroupTerm

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

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

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

This method tests for !=.

impl PartialOrd<FreeGroupTerm> for FreeGroupTerm

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

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

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

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

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

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

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

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

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

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

impl Reducable for FreeGroupTerm

fn reduced(self) -> FreeGroupTerm

impl StructuralEq for FreeGroupTerm

impl StructuralPartialEq for FreeGroupTerm

impl Term for FreeGroupTerm

fn inverse(&self) -> FreeGroupTerm

impl ToString for FreeGroupTerm

fn to_string(&self) -> String

Converts the given value to a String.