Struct qsym2::chartab::chartab_symbols::GenericSymbol

pub struct GenericSymbol { /* private fields */ }

Structure to handle generic mathematical symbols.

Each generic symbol has the format

\textrm{prefactor}
\ ^{\textrm{presuper}}_{\textrm{presub}}
\ \textrm{main}
\ ^{\textrm{postsuper}}_{\textrm{postsub}}
\ \textrm{postfactor}.

Trait Implementations

impl Clone for GenericSymbol

fn clone(&self) -> GenericSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenericSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenericSymbol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GenericSymbol

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

Formats the value using the given formatter.

impl FromStr for GenericSymbol

fn from_str(symstr: &str) -> Result<Self, Self::Err>

Parses a string representing a generic symbol.

Some permissible generic symbols:

"T"
"||T|_(2g)|"
"|^(3)|T|_(2g)|"
"12||C|^(2)_(5)|"
"2||S|^(z)|(α)"

type Err = GenericSymbolParsingError

The associated error which can be returned from parsing.

impl Hash for GenericSymbol

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 MathematicalSymbol for GenericSymbol

fn main(&self) -> String

The main part of the symbol.

fn presuper(&self) -> String

The pre-superscript part of the symbol.

fn presub(&self) -> String

The pre-subscript part of the symbol.

fn postsuper(&self) -> String

The post-superscript part of the symbol.

fn postsub(&self) -> String

The post-subscript part of the symbol.

fn prefactor(&self) -> String

The prefactor part of the symbol.

fn postfactor(&self) -> String

The postfactor part of the symbol.

fn multiplicity(&self) -> Option<usize>

The multiplicity of the symbol which can have different meanings depending on the exact nature of the mathematical symbol.

impl PartialEq for GenericSymbol

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

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

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

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

impl PartialOrd for GenericSymbol

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

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

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

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

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

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

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

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

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

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

impl Serialize for GenericSymbol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GenericSymbol

impl StructuralPartialEq for GenericSymbol