Enum calcu_rs::atom::Atom

pub enum Atom {
    Undef,
    Rational(Rational),
    Irrational(Irrational),
    Var(Var),
    Sum(Sum),
    Prod(Prod),
    Pow(Pow),
    Func(Func),
}

Variants

Undef

Rational(Rational)

Irrational(Irrational)

Var(Var)

Sum(Sum)

Prod(Prod)

Pow(Pow)

Func(Func)

Implementations

impl Atom

pub const fn is_undef(&self) -> bool

Returns true if this value is of type Undef. Returns false otherwise

pub const fn is_rational(&self) -> bool

Returns true if this value is of type Rational. Returns false otherwise

pub const fn is_irrational(&self) -> bool

Returns true if this value is of type Irrational. Returns false otherwise

pub const fn is_var(&self) -> bool

Returns true if this value is of type Var. Returns false otherwise

pub const fn is_sum(&self) -> bool

Returns true if this value is of type Sum. Returns false otherwise

pub const fn is_prod(&self) -> bool

Returns true if this value is of type Prod. Returns false otherwise

pub const fn is_pow(&self) -> bool

Returns true if this value is of type Pow. Returns false otherwise

pub const fn is_func(&self) -> bool

Returns true if this value is of type Func. Returns false otherwise

impl Atom

pub fn unwrap_undef(self)

Unwraps this value to the Atom::Undef variant. Panics if this value is of any other type.

pub fn unwrap_undef_ref(&self)

Unwraps this reference to the Atom::Undef variant. Panics if this value is of any other type.

pub fn unwrap_rational(self) -> Rational

Unwraps this value to the Atom::Rational variant. Panics if this value is of any other type.

pub fn unwrap_rational_ref(&self) -> &Rational

Unwraps this reference to the Atom::Rational variant. Panics if this value is of any other type.

pub fn unwrap_irrational(self) -> Irrational

Unwraps this value to the Atom::Irrational variant. Panics if this value is of any other type.

pub fn unwrap_irrational_ref(&self) -> &Irrational

Unwraps this reference to the Atom::Irrational variant. Panics if this value is of any other type.

pub fn unwrap_var(self) -> Var

Unwraps this value to the Atom::Var variant. Panics if this value is of any other type.

pub fn unwrap_var_ref(&self) -> &Var

Unwraps this reference to the Atom::Var variant. Panics if this value is of any other type.

pub fn unwrap_sum(self) -> Sum

Unwraps this value to the Atom::Sum variant. Panics if this value is of any other type.

pub fn unwrap_sum_ref(&self) -> &Sum

Unwraps this reference to the Atom::Sum variant. Panics if this value is of any other type.

pub fn unwrap_prod(self) -> Prod

Unwraps this value to the Atom::Prod variant. Panics if this value is of any other type.

pub fn unwrap_prod_ref(&self) -> &Prod

Unwraps this reference to the Atom::Prod variant. Panics if this value is of any other type.

pub fn unwrap_pow(self) -> Pow

Unwraps this value to the Atom::Pow variant. Panics if this value is of any other type.

pub fn unwrap_pow_ref(&self) -> &Pow

Unwraps this reference to the Atom::Pow variant. Panics if this value is of any other type.

pub fn unwrap_func(self) -> Func

Unwraps this value to the Atom::Func variant. Panics if this value is of any other type.

pub fn unwrap_func_ref(&self) -> &Func

Unwraps this reference to the Atom::Func variant. Panics if this value is of any other type.

impl Atom

pub fn try_unwrap_undef(self) -> Result<(), TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Undef variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_undef_ref(&self) -> Result<(), TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Undef variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_rational(self) -> Result<Rational, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Rational variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_rational_ref( &self, ) -> Result<&Rational, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Rational variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_irrational(self) -> Result<Irrational, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Irrational variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_irrational_ref( &self, ) -> Result<&Irrational, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Irrational variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_var(self) -> Result<Var, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Var variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_var_ref(&self) -> Result<&Var, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Var variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_sum(self) -> Result<Sum, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Sum variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_sum_ref(&self) -> Result<&Sum, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Sum variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_prod(self) -> Result<Prod, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Prod variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_prod_ref(&self) -> Result<&Prod, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Prod variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_pow(self) -> Result<Pow, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Pow variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_pow_ref(&self) -> Result<&Pow, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Pow variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_func(self) -> Result<Func, TryUnwrapError<Self>>

Attempts to unwrap this value to the Atom::Func variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_func_ref(&self) -> Result<&Func, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Atom::Func variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

impl Atom

pub const UNDEF: Atom = Atom::Undef

pub const MINUS_TWO: Atom = _

pub const MINUS_ONE: Atom = _

pub const ZERO: Atom = _

pub const ONE: Atom = _

pub const TWO: Atom = _

pub const PI: Atom = _

pub const E: Atom = _

pub fn is_zero(&self) -> bool

pub fn is_one(&self) -> bool

pub fn is_min_one(&self) -> bool

pub fn is_pi(&self) -> bool

pub fn is_e(&self) -> bool

pub fn is_neg(&self) -> bool

pub fn is_pos(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_even(&self) -> bool

pub fn is_odd(&self) -> bool

pub fn is_number(&self) -> bool

pub fn is_real(&self) -> bool

pub fn is_irreducible(&self) -> bool

pub fn is_rational_and(&self, cond: impl Fn(&Rational) -> bool) -> bool

pub fn is_const(&self) -> bool

pub fn is_sin(&self) -> bool

pub fn is_cos(&self) -> bool

pub fn try_unwrap_int(&self) -> Option<i128>

pub fn unwrap_int(&self) -> i128

pub fn try_as_real(&self) -> Option<Real>

pub fn for_each_arg<'a>(&'a self, func: impl FnMut(&'a Expr))

pub fn fmt_ast(&self) -> FmtAtom

Trait Implementations

impl Clone for Atom

fn clone(&self) -> Atom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Atom

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Atom

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Atom

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

Formats the value using the given formatter.

impl From<&Atom> for FmtAtom

fn from(value: &Atom) -> Self

Converts to this type from the input type.

impl From<Func> for Atom

fn from(value: Func) -> Self

Converts to this type from the input type.

impl From<Irrational> for Atom

fn from(value: Irrational) -> Self

Converts to this type from the input type.

impl From<Pow> for Atom

fn from(value: Pow) -> Self

Converts to this type from the input type.

impl From<Prod> for Atom

fn from(value: Prod) -> Self

Converts to this type from the input type.

impl From<Rational> for Atom

fn from(value: Rational) -> Self

Converts to this type from the input type.

impl From<Real> for Atom

fn from(value: Real) -> Self

Converts to this type from the input type.

impl From<Sum> for Atom

fn from(value: Sum) -> Self

Converts to this type from the input type.

impl<__FromT0> From<__FromT0> for Atom

where Var: From<__FromT0>,

fn from(value: __FromT0) -> Self

Converts to this type from the input type.

impl From<i128> for Atom

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i32> for Atom

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Atom

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u32> for Atom

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Atom

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Atom

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 Ord for Atom

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Atom> for Real

fn eq(&self, other: &Atom) -> 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 PartialEq<Real> for Atom

fn eq(&self, other: &Real) -> 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 PartialEq for Atom

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

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 Serialize for Atom

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SymbolicExpr for Atom

fn args(&self) -> &[Expr]

fn args_mut(&mut self) -> &mut [Expr]

fn reduce(&self) -> Expr

basic simplification that can be applied regardless of context

fn is_atom(&self) -> bool

fn n_args(&self) -> usize

fn iter_args(&self) -> impl Iterator<Item = &Expr>

fn map_args(self, map_fn: impl Fn(&mut Expr)) -> Self

impl Eq for Atom

impl StructuralPartialEq for Atom