Struct sss_rs::geometry::polynomial::Polynomial

pub struct Polynomial { /* fields omitted */ }

A polynomial function that is made up of a Vec of @Term. It supports common operations done on polynomials including finding the 'y' value with a given 'x' value.

Methods

impl Polynomial

pub fn new() -> Self

Creates an empty polynomial with no terms

pub fn from_points(points: &Vec<Point>, degree: usize) -> Result<Self, Error>

From a given list of points, attempts to use Lagrange interpolation to generate the polynomial that runs through those points. Will return an error if there's not enough pointes to satisfy the @degree requested. If the degree is not to be known, it can be set to @points.len() - 1

pub fn builder() -> PolynomialBuilder

Returns a PolynomialBuilder struct that provides a builder design pattern.

pub fn get_degree(&self) -> i32

Gets the degree of the polynomial

pub fn add_to_term(&mut self, term: Term)

Adds a term to the polynomial

pub fn sub_to_term(&mut self, term: Term)

Subs aterm from the polynomial

pub fn set_term(&mut self, term: Term)

Sets the term with degree @term.get_degree() to @term

pub fn set_terms(&mut self, poly: Polynomial)

Iterates through @poly's terms and sets each of @self's terms to those from @poly

pub fn get_term(&self, degree: i32) -> Term

Returns a copy of the term with the given degree, or creates a new zero coefficient term and returns it. This term is not added into the polynomial

pub fn add_polynomial(self, rhs: Self) -> Self

Adds together two polynomials, consuming both and returning the sum

pub fn sub_polynomial(self, rhs: Self) -> Self

Subtracts one polynomial from the other, consuming both and returning the difference

pub fn mul_polynomial(self, rhs: Self) -> Self

Multiplies together two polynomials, consuming both and returning the product

pub fn scale<T: Into<Fraction>>(self, scalar: T) -> Self

Scales the polynomial with the given @scalar. Each term gets multiplied by @scalar with no impact on the terms' degree

pub fn negate(self) -> Self

Negates the entire polynomial, meaning each term has its sign flipped

pub fn get_y_value(&self, x_val: Fraction) -> Fraction

Get the corresponding 'y' value to the given 'x' value

Trait Implementations

impl From<Term> for Polynomial

fn from(term: Term) -> Self

Performs the conversion.

impl IntoIterator for Polynomial

Creates an iterator that iterates through the terms of the polynomial

type Item = Term

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Clone for Polynomial

fn clone(&self) -> Polynomial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Polynomial

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Polynomial

impl PartialEq<Polynomial> for Polynomial

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Display for Polynomial

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

Formats the value using the given formatter.

impl Debug for Polynomial

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

Formats the value using the given formatter.

impl Sub<Polynomial> for Polynomial

type Output = Polynomial

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Polynomial

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Polynomial

The resulting type after applying the - operator.

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

Performs the - operation.

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

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<'_, '_> 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<Polynomial> for Polynomial

type Output = Polynomial

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Polynomial

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Polynomial

The resulting type after applying the + operator.

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

Performs the + operation.

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

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<'_, '_> 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<Polynomial> for Polynomial

type Output = Polynomial

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Polynomial

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Polynomial

The resulting type after applying the * operator.

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

Performs the * operation.

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

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<'_, '_> 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 Polynomial

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'_> Neg for &'_ Polynomial

type Output = Polynomial

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.