Struct Interval 

pub struct Interval { /* private fields */ }

A closed interval [lo, hi] with lo ≤ hi, neither end NaN. Either end may be infinite: a line’s domain is Interval::REAL. An interval may be longer than a curve’s period — an edge range on a periodic curve may cross the period (docs/DATA-MODEL.md §Topology).

use arris_math::Interval;

let i = Interval::new(1.0, 3.0).unwrap();
assert!(i.contains(3.0));
assert_eq!(i.clamp(5.0), 3.0);
assert_eq!(i.lerp(0.5), 2.0);
assert!(i.overlaps(&Interval::new(3.0, 4.0).unwrap()));
assert!(Interval::new(3.0, 1.0).is_err());

Implementations

impl Interval

pub const REAL: Interval

The whole real line, [−∞, +∞]: the domain of a line or a plane’s parameter.

pub const UNIT: Interval

[0, 1].

pub const TURN: Interval

[0, 2π]: one turn of an angular parameter, both ends included — the closed fundamental interval of every periodic direction.

pub fn new(lo: f64, hi: f64) -> Result<Self, IntervalError>

[lo, hi]; an error when lo > hi or either is NaN.

pub const fn lo(&self) -> f64

The lower end.

pub const fn hi(&self) -> f64

The upper end.

pub fn length(&self) -> f64

hi − lo; infinite for an unbounded interval, zero for a point.

pub fn is_bounded(&self) -> bool

true when both ends are finite.

pub fn midpoint(&self) -> f64

(lo + hi) / 2; NaN for Interval::REAL, where no midpoint exists.

pub fn contains(&self, t: f64) -> bool

lo ≤ t ≤ hi. Both ends are inside; NaN is not.

pub fn clamp(&self, t: f64) -> f64

The nearest parameter inside: t itself when it is contained, the nearer end otherwise. NaN stays NaN.

pub fn lerp(&self, s: f64) -> f64

lo at s = 0, hi at s = 1, both exactly, linear between and beyond. Bounded intervals only; an infinite end yields an infinite or NaN result.

pub fn overlaps(&self, other: &Interval) -> bool

true when the two closed intervals share at least one point: touching at an end counts.

pub fn intersection(&self, other: &Interval) -> Option<Interval>

The common part, or None when they do not overlap.

pub fn hull(&self, other: &Interval) -> Interval

The smallest interval containing both.

Trait Implementations

impl Clone for Interval

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Interval

impl Debug for Interval

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

Formats the value using the given formatter.

impl PartialEq for Interval

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Interval