Struct sss_rs::geometry::term::Term

pub struct Term { /* fields omitted */ }

Represents a term in a polynomial function where the @co coefficient is multiplied by 'x' ^ @degree.

Methods

impl Term

pub fn new<T: Into<Fraction>>(co: T, degree: i32) -> Self

Creates a new Term with a given fraction and degree

pub fn get_degree(&self) -> i32

pub fn set_co(&mut self, co: Fraction)

pub fn get_co<'a>(&'a self) -> &'a Fraction

Return a reference to the coefficient of the term

pub fn term_add_same_degree(self, rhs: Term) -> Result<Term, ()>

This is a consuming operation that attempts to add two terms that have the same degree. NOTE: If the two terms do not have the same degree, only an error will be returned and the values dropped.

pub fn term_add(self, rhs: Term) -> Polynomial

Consuming add operation that adds two Terms together and returns a polynomial. Since the two terms may not have the same degree, they would have to become a polynomial.

pub fn term_sub(self, rhs: Term) -> Polynomial

Consuming sub operation that adds two Terms together and returns a polynomial. Since the two terms may not have the same degree, they would have to become a polynomial.

pub fn term_mul(self, rhs: Term) -> Term

Consuming multiplication operation, returns a Term since the multiplication of two single terms will always return a single term thus not needing to be a polynomial

pub fn term_mul_fraction<T: Into<Fraction>>(self, rhs: T) -> Self

Consuming multiplication operation which scales the term by a given fraction. This is equivalent to @term_mul with the second term having a @degree of 0

pub fn term_add_poly(self, rhs: Polynomial) -> Polynomial

Consuming add operation that adds a polynomial to a given term. These are conveience operations that allow for: Polynomai + Term and Term + Polynomial to give a communitive poperty.

pub fn term_sub_poly(self, rhs: Polynomial) -> Polynomial

See @term_add_poly

pub fn term_mul_poly(self, rhs: Polynomial) -> Polynomial

See @term_add_poly

Methods from Deref<Target = Fraction>

pub fn get_numerator(&self) -> i64

Returns a reference to the numerator of the fraction

pub fn get_denominator(&self) -> i64

Returns a reference to the denominator of the fraction

pub fn is_whole(&self) -> bool

Checks if the given fraction is a whole number, returns true if it is, false otherwise

Trait Implementations

impl AsRef<Fraction> for Term

fn as_ref(&self) -> &Fraction

Performs the conversion.

impl From<Term> for Polynomial

fn from(term: Term) -> Self

Performs the conversion.

impl Clone for Term

fn clone(&self) -> Term

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Term

fn default() -> Term

Returns the "default value" for a type.

impl Eq for Term

impl Ord for Term

fn cmp(&self, other: &Term) -> 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.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Term> for Term

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

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

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

This method tests for !=.

impl PartialOrd<Term> for Term

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

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

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

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

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

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

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

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

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

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

impl Display for Term

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

Formats the value using the given formatter.

impl Debug for Term

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

Formats the value using the given formatter.

impl Sub<Term> for Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: Term) -> Self::Output

Performs the - operation.

impl<'_> Sub<&'_ Term> for Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: &Term) -> Self::Output

Performs the - operation.

impl<'_> Sub<Term> for &'_ Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: Term) -> Self::Output

Performs the - operation.

impl<'_, '_> Sub<&'_ Term> for &'_ Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: &Term) -> Self::Output

Performs the - operation.

impl Sub<Polynomial> for Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: Polynomial) -> Self::Output

Performs the - operation.

impl<'_> Sub<&'_ Polynomial> for Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: &Polynomial) -> Self::Output

Performs the - operation.

impl<'_> Sub<Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: Polynomial) -> Self::Output

Performs the - operation.

impl<'_, '_> Sub<&'_ Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, rhs: &Polynomial) -> Self::Output

Performs the - operation.

impl Add<Term> for Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: Term) -> Self::Output

Performs the + operation.

impl<'_> Add<&'_ Term> for Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: &Term) -> Self::Output

Performs the + operation.

impl<'_> Add<Term> for &'_ Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: Term) -> Self::Output

Performs the + operation.

impl<'_, '_> Add<&'_ Term> for &'_ Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: &Term) -> Self::Output

Performs the + operation.

impl Add<Polynomial> for Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: Polynomial) -> Self::Output

Performs the + operation.

impl<'_> Add<&'_ Polynomial> for Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: &Polynomial) -> Self::Output

Performs the + operation.

impl<'_> Add<Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: Polynomial) -> Self::Output

Performs the + operation.

impl<'_, '_> Add<&'_ Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, rhs: &Polynomial) -> Self::Output

Performs the + operation.

impl Mul<Term> for Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: Term) -> Self::Output

Performs the * operation.

impl<'_> Mul<&'_ Term> for Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: &Term) -> Self::Output

Performs the * operation.

impl<'_> Mul<Term> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: Term) -> Self::Output

Performs the * operation.

impl<'_, '_> Mul<&'_ Term> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: &Term) -> Self::Output

Performs the * operation.

impl Mul<Fraction> for Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: Fraction) -> Self::Output

Performs the * operation.

impl<'_> Mul<&'_ Fraction> for Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: &Fraction) -> Self::Output

Performs the * operation.

impl<'_> Mul<Fraction> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: Fraction) -> Self::Output

Performs the * operation.

impl<'_, '_> Mul<&'_ Fraction> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

fn mul(self, rhs: &Fraction) -> Self::Output

Performs the * operation.

impl Mul<Polynomial> for Term

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: Polynomial) -> Self::Output

Performs the * operation.

impl<'_> Mul<&'_ Polynomial> for Term

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: &Polynomial) -> Self::Output

Performs the * operation.

impl<'_> Mul<Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: Polynomial) -> Self::Output

Performs the * operation.

impl<'_, '_> Mul<&'_ Polynomial> for &'_ Term

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, rhs: &Polynomial) -> Self::Output

Performs the * operation.

impl Neg for Term

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'_> Neg for &'_ Term

type Output = Term

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Deref for Term

type Target = Fraction

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.