Struct DecomposedSymbol

pub struct DecomposedSymbol<S>
where
    S: LinearSpaceSymbol + PartialOrd,
{ /* private fields */ }

Structure to handle symbols consisting of multiple sub-symbols.

Implementations

impl<S> DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

pub fn new(symstr: &str) -> Result<Self, DecomposedSymbolBuilderError>

Parses a string representing a decomposed symbol. See Self::from_str for more information.

Arguments

• symstr - A string to be parsed to give a decomposed symbol.

Errors

Errors when the string cannot be parsed as a decomposed symbol.

Trait Implementations

impl<S> Clone for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + Clone,

fn clone(&self) -> DecomposedSymbol<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + Debug,

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> Display for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

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

Formats the value using the given formatter.

impl<S> FromStr for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + FromStr,

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

Parses a string representing a decomposed symbol. A valid string representing a decomposed symbol is one consisting of one or more valid symbol strings, separated by a + character.

Arguments

• symstr - A string to be parsed to give a decomposed symbol.

Returns

A Result wrapping the constructed decomposed symbol.

Panics

Panics when unable to construct a decomposed symbol from the specified string.

Errors

Errors when the string cannot be parsed.

type Err = DecomposedSymbolBuilderError

The associated error which can be returned from parsing.

impl<S> Hash for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

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<S> PartialEq for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

fn eq(&self, other: &Self) -> 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<S> PartialOrd for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

fn partial_cmp(&self, other: &Self) -> 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<S> ReducibleLinearSpaceSymbol for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd,

type Subspace = S

The type of the subspace symbols.

fn from_subspaces(irreps: &[(Self::Subspace, usize)]) -> Self

Constructs Self from constituting subspace symbols and their multiplicities.

fn subspaces(&self) -> Vec<(&Self::Subspace, &usize)>

Returns the constituting subspace symbols and their multiplicities.

fn sorted_subspaces(&self) -> Vec<(&Self::Subspace, &usize)>

Returns an iterator containing sorted references to the constituting symbols.

impl<S> Serialize for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> Eq for DecomposedSymbol<S>

where S: LinearSpaceSymbol + PartialOrd + Eq,