Struct nyx_space::polyfit::Polynomial

pub struct Polynomial<const SIZE: usize> {
    pub coefficients: [f64; SIZE],
}

Polynomial is a statically allocated polynomial.

Fields

coefficients: [f64; SIZE]

Coefficients are orders by their power, e.g. index 0 is to the power 0, 1 is linear, 2 is quadratic, etc.

Implementations

impl<const SIZE: usize> Polynomial<SIZE>

pub fn from_most_significant(coeffs: [f64; SIZE]) -> Self

pub const fn order(&self) -> usize

Get the order of the polynomial

pub fn eval(&self, x: f64) -> f64

Evaluate the polynomial at the provided position

pub fn deriv(&self, x: f64) -> f64

Evaluate the derivative at the provided position

pub fn eval_n_deriv(&self, x: f64) -> (f64, f64)

Evaluate the polynomial and its derivative at the provided position

pub fn zeros() -> Self

Initializes a Polynomial with only zeros

pub fn zero_power(&mut self, i: usize)

Set the i-th power of this polynomial to zero (e.g. if i=0, set the x^0 coefficient to zero, i.e. the constant part goes to zero)

pub fn zero_below_tolerance(&mut self, tol: f64)

Set all of the coefficients below this tolerance to zero

pub fn is_nan(&self) -> bool

Returns true if any of the coefficients are NaN

Trait Implementations

impl<const S1: usize, const S2: usize> Add<Polynomial<S1>> for Polynomial<S2>

fn add(self, other: Polynomial<S1>) -> Self::Output

Add Self and Other, IF S2 >= S1 (else panic!)

type Output = Polynomial<S1>

The resulting type after applying the + operator.

impl<const SIZE: usize> AddAssign<f64> for Polynomial<SIZE>

fn add_assign(&mut self, rhs: f64)

Performs the += operation.

impl<const SIZE: usize> Clone for Polynomial<SIZE>

fn clone(&self) -> Polynomial<SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for Polynomial<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> Display for Polynomial<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> LowerHex for Polynomial<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> Mul<Polynomial<SIZE>> for f64

In-place multiplication of a polynomial with an f64

type Output = Polynomial<SIZE>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const SIZE: usize> Mul<f64> for &Polynomial<SIZE>

Clone current polynomial and then multiply it with an f64

type Output = Polynomial<SIZE>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const SIZE: usize> Mul<f64> for Polynomial<SIZE>

In-place multiplication of a polynomial with an f64

type Output = Polynomial<SIZE>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const SIZE: usize> PartialEq for Polynomial<SIZE>

fn eq(&self, other: &Polynomial<SIZE>) -> 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<const S1: usize, const S2: usize> Sub<Polynomial<S2>> for Polynomial<S1>

type Output = Polynomial<S1>

The resulting type after applying the - operator.

fn sub(self, other: Polynomial<S2>) -> Self::Output

Performs the - operation.

impl<const SIZE: usize> Copy for Polynomial<SIZE>

impl<const SIZE: usize> StructuralPartialEq for Polynomial<SIZE>