Struct Symbol 

pub struct Symbol {
    pub name: Arc<str>,
    /* private fields */
}

Mathematical symbol/variable with efficient string sharing

Fields

name: Arc<str>

Implementations

impl Symbol

pub fn new<S>(name: S) -> Symbol

where S: AsRef<str>,

Create a new scalar symbol (default behavior, backward compatible)

Note: Prefer using symbol!(x) macro in application code. This method is kept for backward compatibility and internal use.

Examples

use mathhook_core::symbol;

let x = symbol!(x);
let alpha = symbol!(alpha);

pub fn scalar<S>(name: S) -> Symbol

where S: AsRef<str>,

Create a scalar symbol (commutative)

Examples

use mathhook_core::core::symbol::Symbol;
use mathhook_core::core::commutativity::Commutativity;

let x = Symbol::scalar("x");
assert_eq!(x.commutativity(), Commutativity::Commutative);

pub fn matrix<S>(name: S) -> Symbol

where S: AsRef<str>,

Create a matrix symbol (noncommutative)

Examples

use mathhook_core::core::symbol::Symbol;
use mathhook_core::core::commutativity::Commutativity;

let A = Symbol::matrix("A");
assert_eq!(A.commutativity(), Commutativity::Noncommutative);

pub fn operator<S>(name: S) -> Symbol

where S: AsRef<str>,

Create an operator symbol (noncommutative)

Examples

use mathhook_core::core::symbol::Symbol;
use mathhook_core::core::commutativity::Commutativity;

let p = Symbol::operator("p");
assert_eq!(p.commutativity(), Commutativity::Noncommutative);

pub fn quaternion<S>(name: S) -> Symbol

where S: AsRef<str>,

Create a quaternion symbol (noncommutative)

Examples

use mathhook_core::core::symbol::Symbol;
use mathhook_core::core::commutativity::Commutativity;

let i = Symbol::quaternion("i");
assert_eq!(i.commutativity(), Commutativity::Noncommutative);

pub fn name(&self) -> &str

Get the symbol name

Examples

use mathhook_core::symbol;

let x = symbol!(x);
assert_eq!(x.name(), "x");

pub fn symbol_type(&self) -> SymbolType

Get the type of this symbol

Examples

use mathhook_core::core::symbol::{Symbol, SymbolType};

let x = Symbol::scalar("x");
assert_eq!(x.symbol_type(), SymbolType::Scalar);

let A = Symbol::matrix("A");
assert_eq!(A.symbol_type(), SymbolType::Matrix);

pub fn commutativity(&self) -> Commutativity

Get commutativity of this symbol

Examples

use mathhook_core::core::symbol::Symbol;
use mathhook_core::core::commutativity::Commutativity;

let x = Symbol::scalar("x");
assert_eq!(x.commutativity(), Commutativity::Commutative);

let A = Symbol::matrix("A");
assert_eq!(A.commutativity(), Commutativity::Noncommutative);

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Symbol

fn deserialize<D>( deserializer: D, ) -> Result<Symbol, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Symbol

fn from(name: &str) -> Symbol

Converts to this type from the input type.

impl From<String> for Symbol

fn from(name: String) -> Symbol

Converts to this type from the input type.

impl From<Symbol> for Expression

fn from(symbol: Symbol) -> Expression

Converts to this type from the input type.

impl Hash for Symbol

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

where __H: Hasher,

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 PartialEq for Symbol

fn eq(&self, other: &Symbol) -> 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 Serialize for Symbol

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Symbol

impl StructuralPartialEq for Symbol