Struct s2::s1::interval::Interval

pub struct Interval {
    pub lo: f64,
    pub hi: f64,
}

Interval represents a closed interval on a unit circle. Zero-length intervals (where Lo == Hi) represent single points. If Lo > Hi then the interval is “inverted”. The point at (-1, 0) on the unit circle has two valid representations, [π,π] and [-π,-π]. We normalize the latter to the former in Interval::new. There are two special intervals that take advantage of that:

• the full interval, [-π,π], and
• the empty interval, [π,-π]. Treat the exported fields as read-only.

Fields

lo: f64

hi: f64

Implementations

impl Interval

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

from_endpoint constructs a new interval from endpoints. Both arguments must be in the range [-π,π]. This function allows inverted intervals to be created.

pub fn from_point_pair(a: f64, b: f64) -> Self

from_point_pair returns the minimal interval containing the two given points. Both arguments must be in [-π,π].

pub fn is_valid(&self) -> bool

is_valid reports whether the interval is valid.

pub fn is_full(&self) -> bool

is_full reports whether the interval is full.

pub fn is_empty(&self) -> bool

is_empty reports whether the interval is empty.

pub fn is_inverted(&self) -> bool

is_inverted reports whether the interval is inverted; that is, whether Lo > Hi.

pub fn invert(&self) -> Interval

invert returns the interval with endpoints swapped.

pub fn center(&self) -> f64

center returns the midpoint of the interval. It is undefined for full and empty intervals.

pub fn len(&self) -> f64

len returns the length of the interval. The length of an empty interval is negative.

pub fn fast_contains(&self, p: f64) -> bool

fast_contains returns true iff the interval contains p. Assumes p ∈ (-π,π].

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

contains returns true iff the interval contains p. Assumes p ∈ [-π,π].

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

contains_interval returns true iff the interval contains oi.

pub fn interior_contains(&self, p: f64) -> bool

interior_contains returns true iff the interior of the interval contains p. Assumes p ∈ [-π,π].

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

interior_contains_interval returns true iff the interior of the interval contains oi.

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

intersects returns true iff the interval contains any points in common with oi.

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

interior_intersects returns true iff the interior of the interval contains any points in common with other, including the latter’s boundary.

pub fn union(&self, other: &Self) -> Self

union returns the smallest interval that contains both the interval and oi.

pub fn intersection(&self, other: &Self) -> Self

intersection returns the smallest interval that contains the intersection of the interval and oi.

pub fn expanded(&self, margin: f64) -> Self

Expanded returns an interval that has been expanded on each side by margin. If margin is negative, then the function shrinks the interval on each side by margin instead. The resulting interval may be empty or full. Any expansion (positive or negative) of a full interval remains full, and any expansion of an empty interval remains empty.

pub fn complement(&self) -> Interval

pub fn complement_center(&self) -> f64

pub fn directed_hausdorff_distance(&self, y: &Self) -> Angle

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

Trait Implementations

impl<'a> Add<f64> for &'a Interval

fn add(self, p: f64) -> Self::Output

add returns the interval expanded by the minimum amount necessary such that it contains the given point “p” (an angle in the range [-Pi, Pi]).

type Output = Interval

The resulting type after applying the + operator.

impl Add<f64> for Interval

type Output = Interval

The resulting type after applying the + operator.

fn add(self, p: f64) -> Self::Output

Performs the + operation.

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interval

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

Formats the value using the given formatter.

impl Default for Interval

fn default() -> Interval

Returns the “default value” for a type.

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 From<Interval> for Interval

fn from(i: Interval) -> Self

Converts to this type from the input type.

impl From<Interval> for Interval

fn from(i: Interval) -> Self

Converts to this type from the input type.

impl PartialEq<Interval> for Interval

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Copy for Interval

impl StructuralPartialEq for Interval