Struct intervals_rs::Interval

pub struct Interval<T: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> { /* fields omitted */ }

Implementations

impl<T: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> Interval<T>

pub fn and_more(lower: LimitValue<T>) -> Self

pub fn closed(lower: LimitValue<T>, upper: LimitValue<T>) -> Self

pub fn more_than(lower: LimitValue<T>) -> Self

pub fn open(lower: LimitValue<T>, upper: LimitValue<T>) -> Self

pub fn over(
    lower: LimitValue<T>,
    lower_included: bool,
    upper: LimitValue<T>,
    upper_included: bool
) -> Self

pub fn single_element(element: LimitValue<T>) -> Self

pub fn under(upper: LimitValue<T>) -> Self

pub fn up_to(upper: LimitValue<T>) -> Self

pub fn complement_relative_to(&self, other: &Interval<T>) -> Vec<Interval<T>>

pub fn covers(&self, other: &Interval<T>) -> bool

Verify that this interval completely encloses the specified interval other.

• params
  • other: an Interval
• return: true for full comprehension, false otherwise

pub fn gap(&self, other: &Interval<T>) -> Interval<T>

Get the interval that lies between this interval and the given interval other.

For example, the gap between [3, 5) and [10, 20) is [5, 19). If the two intervals have a common part, return an empty interval.

• params
  • other: an interval to be compared
• return: gap interval

pub fn is_single_element(&self) -> bool

Verify whether this interval is a single-element interval or not.

A single-element interval has both upper and lower limits, and also indicates that these limits are equal and not an open interval. For example, 3 <= x < 3, 3 <= x <= 3, and 3 <= x <= 3.

• return: true if it’s a single element interval, false otherwise

pub fn empty_of_same_type(&self) -> Interval<T>

pub fn new_of_same_type(
    &self,
    lower: LimitValue<T>,
    lower_closed: bool,
    upper: LimitValue<T>,
    upper_closed: bool
) -> Interval<T>

pub fn includes(&self, value: &LimitValue<T>) -> bool

Verify whether or not the specified value value is included in this interval.

• params
  • value: an interval value
• return: true if included, false otherwise

pub fn is_below(&self, value: &LimitValue<T>) -> bool

Verify that the specified value value does not exceed the upper limit of this interval.

• params
  • value: an interval value
• return: true if not exceeded, false otherwise

pub fn is_above(&self, value: &LimitValue<T>) -> bool

Verify that the specified value value does not exceed the lower limit of this interval.

• params
  • value: an interval value
• return: true if not exceeded, false otherwise

pub fn is_open(&self) -> bool

Verify whether this interval is an open interval or not.

• return: true if it’s an open interval, false otherwise (including half-open interval)

pub fn is_closed(&self) -> bool

Verify whether this interval is a closed interval or not.

• return: true if it’s a closed interval, false otherwise (including half-open interval)

pub fn is_empty(&self) -> bool

Verify whether this interval is empty or not.

The interval is empty means that the upper and lower limits are the same value and the interval is open. For example, a state like 3 < x < 3.

• return: true if it’s empty, false otherwise.

pub fn new(lower: IntervalLimit<T>, upper: IntervalLimit<T>) -> Interval<T>

pub fn new_with(
    lower: LimitValue<T>,
    is_lower_closed: bool,
    upper: LimitValue<T>,
    is_upper_closed: bool
) -> Interval<T>

pub fn intersect(&self, other: &Interval<T>) -> Interval<T>

Return the product set (common part) of this interval and the given interval other.

If the common part does not exist, it returns an empty interval.

• params
  • other: an interval to be compared

pub fn intersects(&self, other: &Interval<T>) -> bool

Verify if there is a common part between this interval and the given interval other.

• params
  • other: a target interval
• return: true if the common part exists, false otherwise

pub fn as_upper_limit(&self) -> &LimitValue<T>

pub fn as_lower_limit(&self) -> &LimitValue<T>

pub fn has_upper_limit(&self) -> bool

Get whether there is an upper limit or not.

Warning: This method is generally used for the purpose of displaying this value and for interaction with classes that are highly coupled to this class. Careless use of this method will unnecessarily increase the coupling between this class and the client-side class.

If you want to use this value for calculations,

• find another appropriate method or add a new method to this class.

• find another suitable method or consider adding a new method to this class.

• return: true if upper limit is present, false otherwise

pub fn has_lower_limit(&self) -> bool

Get whether there is an lower limit or not.

Warning: This method is generally used for the purpose of displaying this value and for interaction with classes that are highly coupled to this class. Careless use of this method will unnecessarily increase the coupling between this class and the client-side class.

If you want to use this value for calculations,

• find another appropriate method or add a new method to this class.

• find another suitable method or consider adding a new method to this class.

• return: true if lower limit is present, false otherwise

pub fn includes_upper_limit(&self) -> bool

Get whether the upper limit is closed or not.

Warning: This method is generally used for the purpose of displaying this value and for interaction with classes that are highly coupled to this class. Careless use of this method will unnecessarily increase the coupling between this class and the client-side class.

If you want to use this value for calculations,

• find another appropriate method or add a new method to this class.

• find another suitable method or consider adding a new method to this class.

• return: trueif the upper limit is closed,false` otherwise

pub fn includes_lower_limit(&self) -> bool

pub fn greater_of_lower_limits<'a>(
    &'a self,
    other: &'a Interval<T>
) -> &'a LimitValue<T>

pub fn lesser_of_upper_limits<'a>(
    &'a self,
    other: &'a Interval<T>
) -> &'a LimitValue<T>

pub fn greater_of_lower_included_in_intersection(
    &self,
    other: &Interval<T>
) -> bool

pub fn greater_of_lower_included_in_union(&self, other: &Interval<T>) -> bool

pub fn lesser_of_upper_included_in_intersection(
    &self,
    other: &Interval<T>
) -> bool

pub fn lesser_of_upper_included_in_union(&self, other: &Interval<T>) -> bool

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

この区間の下側補区間と与えた区間 other の共通部分を返す。

other 比較対象の区間 return この区間の下側の補区間と、与えた区間の共通部分。存在しない場合は None

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

Trait Implementations

impl<T: Clone + Debug + Display + Hash + Eq + Ord + PartialEq + PartialOrd> Clone for Interval<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> Debug for Interval<T>

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

Formats the value using the given formatter.

impl<T: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> Display for Interval<T>

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

Formats the value using the given formatter.

impl<T: Hash + Debug + Display + Clone + Eq + Ord + PartialEq + PartialOrd> Hash for Interval<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: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> PartialEq<Interval<T>> for Interval<T>

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

Verify the identity of this interval and the given interval other.

It returns true if both intervals are empty, and false if only one of them is empty. If both are single-element intervals, the limits that are single elements are compared with each other, and true is returned if they match. If only one of them is a single-element interval, false is returned.

• param
  • other: an interval to be compared
• return: true if they are identical, false if they are not

#[must_use]

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

This method tests for !=.

impl<T: Eq + Debug + Display + Clone + Hash + Ord + PartialEq + PartialOrd> Eq for Interval<T>

impl<T: Debug + Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> StructuralEq for Interval<T>