Struct arthroprod::types::Alpha

pub struct Alpha { /* fields omitted */ }

The base element for computation with Absolute Relativity.

An Alpha is a Component along with an associated Sign. All values and mathematical operators within the algebra are required to be paired with their correct Alpha value under the principle of Absolute Relativity.

Methods

impl Alpha

fn new(ix: &str) -> Result<Alpha>

create a new alpha from an string index containing an optional sign prefix.

NOTE: This will panic if the index is invalid in order to prevent the user from running inconsistant calculations.

fn new_override(
    ix: &str,
    sign: Sign,
    allowed: &HashSet<Component>
) -> Result<Alpha>

new_override allows the caller to explicitly specify an index, sign and allowed set of alphas when creating an alpha.

fn from_index(index: &Component, sign: &Sign) -> Alpha

Construct an Alpha explicitly from a Component and a Sign.

fn is_point(&self) -> bool

Check to see if an alpha is +/-αp

fn index(&self) -> &Component

Return a copy of this Alpha's index

fn sign(&self) -> &Sign

Return a copy of this Alpha's sign

fn as_vec(&self) -> Vec<Index>

Return a Vector of Indices representing this Alpha's Indices

Trait Implementations

impl Debug for Alpha

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

Formats the value using the given formatter.

impl Eq for Alpha

impl PartialEq for Alpha

fn eq(&self, __arg_0: &Alpha) -> bool

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

fn ne(&self, __arg_0: &Alpha) -> bool

This method tests for !=.

impl Ord for Alpha

fn cmp(&self, __arg_0: &Alpha) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for Alpha

fn partial_cmp(&self, __arg_0: &Alpha) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Alpha) -> bool

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

fn le(&self, __arg_0: &Alpha) -> bool

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

fn gt(&self, __arg_0: &Alpha) -> bool

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

fn ge(&self, __arg_0: &Alpha) -> bool

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

impl Copy for Alpha

impl Clone for Alpha

fn clone(&self) -> Alpha

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Alpha

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

Formats the value using the given formatter.