Struct Polynomial 

pub struct Polynomial {
    pub constant: Duration,
    pub rate: Duration,
    pub accel: Duration,
}

Interpolation Polynomial used for example in [TimeScale] maintenance, precise monitoring or conversions.

Fields

constant: Duration

Constant offset Duration, regardless of the interpolation interval

rate: Duration

Rate or drift in seconds per second (s.s⁻¹) expressed as Duration for convenience. It is a linear scaling factor of the interpolation interval.

accel: Duration

Acceleration or drift change in s.s⁻², expressed as Duration for convenience. It is a quadratic scaling of the interpolation interval.

Implementations

impl Polynomial

pub fn correction_duration(&self, time_interval: Duration) -> Duration

Calculate the correction (as Duration once again) from Self and given the interpolation time interval :type time_interval: Duration :rtype: Duration

impl Polynomial

pub fn from_constant_offset(constant: Duration) -> Polynomial

Create a Polynomial structure that is only made of a static offset

pub fn from_constant_offset_nanoseconds(nanos: f64) -> Polynomial

Create a Polynomial structure from a static offset expressed in nanoseconds

pub fn from_offset_and_rate(constant: Duration, rate: Duration) -> Polynomial

Create a Polynomial structure from both static offset and rate of change:

pub fn from_offset_rate_nanoseconds( offset_ns: f64, drift_ns_s: f64, ) -> Polynomial

Create a Polynomial structure from a static offset and drift, in nanoseconds and nanoseconds.s⁻¹

impl Polynomial

pub fn py_from_constant_offset( _cls: &Bound<'_, PyType>, constant: Duration, ) -> Polynomial

Create a Polynomial structure that is only made of a static offset :type constant: Duration :rtype: Polynomial

pub fn py_from_constant_offset_nanoseconds( _cls: &Bound<'_, PyType>, nanos: f64, ) -> Polynomial

Create a Polynomial structure from a static offset expressed in nanoseconds :type nanos: float :rtype: Polynomial

pub fn py_from_offset_and_rate( _cls: &Bound<'_, PyType>, constant: Duration, rate: Duration, ) -> Polynomial

Create a Polynomial structure from both static offset and rate of change: :type constant: Duration :type rate: Duration :rtype: Polynomial

pub fn py_from_offset_rate_nanoseconds( _cls: &Bound<'_, PyType>, offset_ns: f64, drift_ns_s: f64, ) -> Polynomial

Create a Polynomial structure from a static offset and drift, in nanoseconds and nanoseconds.s⁻¹ :type offset_ns: float :type drift_ns_s: float :rtype: Polynomial

Trait Implementations

impl Clone for Polynomial

fn clone(&self) -> Polynomial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Polynomial

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Polynomial

fn deserialize<__D>( __deserializer: __D, ) -> Result<Polynomial, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Polynomial

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

Formats the value using the given formatter.

impl From<(f64, f64, f64)> for Polynomial

fn from(triplet: (f64, f64, f64)) -> Polynomial

Converts (f64, f64, f64) triplet, oftentimes noted (a0, a1, a2) as (offset (s), drift (s.s⁻¹), drift change (s.s⁻²)) to Polynomial structure, that allows precise [TimeScale] translation.

impl Hash for Polynomial

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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<'py> IntoPyObject<'py> for Polynomial

type Target = Polynomial

The Python output type

type Output = Bound<'py, <Polynomial as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Polynomial as IntoPyObject<'py>>::Output, <Polynomial as IntoPyObject<'py>>::Error>

Performs the conversion.

impl Ord for Polynomial

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

Restrict a value to a certain interval.

impl PartialEq for Polynomial

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

fn partial_cmp(&self, other: &Polynomial) -> 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 PyClass for Polynomial

const NAME: &'static str = "Polynomial"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for Polynomial

const NAME: &'static str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for Polynomial

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Polynomial

impl DerefToPyAny for Polynomial

impl Eq for Polynomial

impl StructuralPartialEq for Polynomial