Struct Interval 

pub struct Interval { /* private fields */ }

A nonempty closed interval, possibly unbounded in either direction.

In other words, the interval may stretch all the way to positive or negative infinity, but it will always have some nonempty interior.

Implementations

impl Interval

pub const UNIT: Self

An interval of length 1.0, starting at 0.0 and ending at 1.0.

pub const EVERYWHERE: Self

An interval which stretches across the entire real line from negative infinity to infinity.

pub const fn new(start: f32, end: f32) -> Result<Self, InvalidIntervalError>

Create a new Interval with the specified start and end. The interval can be unbounded but cannot be empty (so start must be less than end) and neither endpoint can be NaN; invalid parameters will result in an error.

pub const fn start(self) -> f32

Get the start of this interval.

pub const fn end(self) -> f32

Get the end of this interval.

pub fn intersect( self, other: Interval, ) -> Result<Interval, InvalidIntervalError>

Create an Interval by intersecting this interval with another. Returns an error if the intersection would be empty (hence an invalid interval).

pub const fn length(self) -> f32

Get the length of this interval. Note that the result may be infinite (f32::INFINITY).

pub const fn is_bounded(self) -> bool

Returns true if this interval is bounded — that is, if both its start and end are finite.

Equivalently, an interval is bounded if its length is finite.

pub const fn has_finite_start(self) -> bool

Returns true if this interval has a finite start.

pub const fn has_finite_end(self) -> bool

Returns true if this interval has a finite end.

pub fn contains(self, item: f32) -> bool

Returns true if item is contained in this interval.

pub const fn contains_interval(self, other: Self) -> bool

Returns true if the other interval is contained in this interval.

This is non-strict: each interval will contain itself.

pub const fn clamp(self, value: f32) -> f32

Clamp the given value to lie within this interval.

pub fn spaced_points( self, points: usize, ) -> Result<impl Iterator<Item = f32>, SpacedPointsError>

Get an iterator over equally-spaced points from this interval in increasing order. If points is 1, the start of this interval is returned. If points is 0, an empty iterator is returned. An error is returned if the interval is unbounded.

Trait Implementations

impl Clone for Interval

fn clone(&self) -> Interval

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<'de> Deserialize<'de> for Interval

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Interval

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Interval

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Interval

impl TryFrom<RangeInclusive<f32>> for Interval

type Error = InvalidIntervalError

The type returned in the event of a conversion error.

fn try_from(range: RangeInclusive<f32>) -> Result<Self, Self::Error>

Performs the conversion.