Struct Sinusoid2

pub struct Sinusoid2 {
    pub mean: Scalar,
    pub cosine: Scalar,
    pub sine: Scalar,
}

The graph v = mean + cosine cos(t) + sine sin(t), parameterised by t.

The point at parameter t is (t, v(t)): the parameter IS the first coordinate. On a cylinder that coordinate is the angle, so a pcurve use states the angle span it covers directly as its interval, and a span longer than a full turn is representable (it simply wraps the surface).

The curve is defined for every finite t and repeats with period 2 pi in v; its conventional domain is one full turn.

Dirty imported data stays representable, as everywhere else in this crate: validation rejects non-finite coefficients, construction does not.

Fields

mean: Scalar

Mean height: the constant term.

cosine: Scalar

Amplitude of the cos(t) term.

sine: Scalar

Amplitude of the sin(t) term.

Implementations

impl Sinusoid2

pub fn height(&self, t: Scalar) -> Scalar

Height at parameter t.

pub fn amplitude(&self) -> Scalar

Peak deviation from the mean, sqrt(cosine^2 + sine^2).

The wave spans mean - amplitude ..= mean + amplitude over a full turn, which is what a caller needs to check a cut stays clear of another boundary.

pub fn is_finite(&self) -> bool

Whether every coefficient is finite.

Trait Implementations

impl Clone for Sinusoid2

fn clone(&self) -> Sinusoid2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sinusoid2

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

Formats the value using the given formatter.

impl PartialEq for Sinusoid2

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

impl StructuralPartialEq for Sinusoid2