Struct gf::support::iv::Iv

pub struct Iv<T: Clone + Integer = u128> { /* fields omitted */ }

Non-empty half-closed interval between two integer points: [ai; bx).

Total order

Intervals have total order: first the leftmost bounds are compared, and ties are solved by comparing rightmost bounds.

Implementations

impl<T: Clone + Integer> Iv<T>

pub fn new(ai: T, bx: T) -> Option<Self>

Create a half-closed interval [ai; bx), returning None if the interval would have been empty.

pub fn new_closed(ai: T, bi: T) -> Option<Self>

Create a closed interval [ai; bi], returning None if the interval would have been empty.

pub fn ai(&self) -> &T

Return the leftmost point of the interval.

pub fn bx(&self) -> &T

Return the leftmost point after the interval.

pub fn len(&self) -> T

Return interval length.

pub fn contains(&self, x: &T) -> bool

Return whether x belongs to the interval.

pub fn contains_iv(&self, iv: &Self) -> bool

Return whether iv lies completely within the interval.

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

Return whether this interval and other have a non-empty intersection.

pub fn checked_add(self, offset: T) -> Option<Self> where
    T: CheckedAdd, 

Add offset to both ends of the interval, checking for overflow.

pub fn checked_sub(self, offset: T) -> Option<Self> where
    T: CheckedSub, 

Subtract offset from both ends of the interval, checking for overflow.

Trait Implementations

impl<T: Clone + Integer> Add<T> for Iv<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self

Performs the + operation.

impl<T: Clone + Integer> Clone for Iv<T>

fn clone(&self) -> Iv<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone + Integer + Debug> Debug for Iv<T>

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

Formats the value using the given formatter.

impl<T: Clone + Integer + Display> Display for Iv<T>

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

Formats the value using the given formatter.

impl<T: Eq + Clone + Integer> Eq for Iv<T>

impl<T: Clone + Integer> From<Iv<T>> for Range<T>

fn from(src: Iv<T>) -> Self

Performs the conversion.

impl<T: Hash + Clone + Integer> Hash for Iv<T>

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Clone + Integer> Ord for Iv<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq + Clone + Integer> PartialEq<Iv<T>> for Iv<T>

fn eq(&self, other: &Iv<T>) -> bool

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

fn ne(&self, other: &Iv<T>) -> bool

This method tests for !=.

impl<T: Clone + Integer> PartialOrd<Iv<T>> for Iv<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Clone + Integer> StructuralEq for Iv<T>

impl<T: Clone + Integer> StructuralPartialEq for Iv<T>

impl<T: Clone + Integer> Sub<T> for Iv<T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self

Performs the - operation.