SPL::interval< T > Class Template Reference

Class that represents an interval. More...

#include <SPL/Runtime/Utility/Interval.h>

Public Member Functions
	interval ()
	Constructs an empty interval. More...
	interval (T endpoint)
	Constructs an empty interval which has a left endpoint specified by endpoint. More...
	interval (const interval &other)
	Copy constructor. More...
interval const &	operator= (interval const &other)
	Assignment operator. More...
bool	operator== (interval const &other) const
	Equality comparison. More...
	interval (T value, T size)
	Constructs an interval specified by its left endpoint and a size. More...
T const &	left () const
	Get left (low) endpoint. More...
T const &	right () const
	Get right (high) endpoint. More...
bool	empty () const
	Determines whether the interval is empty. More...
bool	touches (interval< T > other) const
	Determines whether this interval touches the other. More...
bool	overlaps (interval< T > other) const
	Determines whether this overlaps touches the other. More...
bool	includes (const SPL::timestamp &ts) const
	Determines whether this interval includes the specified timestamp. More...
void	swap (interval &other)
	Swap with another interval. More...
size_t	hashCode () const
	Calculates hash code. More...

Detailed Description

template<typename T>
class SPL::interval< T >

Class that represents an interval.

This interval is right-open, which means that it contains all the elements between (and including) its left endpoint, and (excluding) its right endpoint.

Template Parameters

T	the type of elements of the interval. The endpoint type must be totally ordered.

Constructor & Destructor Documentation

interval() [1/4]

template<typename T >

SPL::interval< T >::interval ( )

inline

Constructs an empty interval.

interval() [2/4]

template<typename T >

SPL::interval< T >::interval ( T  endpoint )

inline

Constructs an empty interval which has a left endpoint specified by endpoint.

Parameters

endpoint

the left interval endpoint

interval() [3/4]

template<typename T >

SPL::interval< T >::interval ( const interval< T > &  other )

inline

Copy constructor.

Parameters

other

other interval

interval() [4/4]

template<typename T >

SPL::interval< T >::interval ( T  value, T  size  )

inline

Constructs an interval specified by its left endpoint and a size.

The endpoint type must be Addable and Subtractable, so it must have operator + and an operator - defined.

Parameters

value	the left endpoint
size	the distance between the left and the right endpoint

Exceptions

std::invalid_argument

if the size is negative

Member Function Documentation

operator=()

template<typename T >

interval const& SPL::interval< T >::operator= ( interval< T > const &  other )

inline

Assignment operator.

Parameters

other

another interval

operator==()

template<typename T >

bool SPL::interval< T >::operator== ( interval< T > const &  other ) const

inline

Equality comparison.

Parameters

other

interval to compare with

Returns

true if the intervals are the same, otherwise false

left()

template<typename T >

T const& SPL::interval< T >::left ( ) const

inline

Get left (low) endpoint.

Returns

the left endpoint

right()

template<typename T >

T const& SPL::interval< T >::right ( ) const

inline

Get right (high) endpoint.

Returns

the right endpoint

empty()

template<typename T >

bool SPL::interval< T >::empty ( ) const

inline

Determines whether the interval is empty.

An interval is empty iff its left endpoint equals its right endpoint.

Returns

true if the interval is empty, otherwise false

touches()

template<typename T >

bool SPL::interval< T >::touches ( interval< T >  other ) const

inline

Determines whether this interval touches the other.

Interval a touches interval b iff a.left() == b.right() or a.right() == b.left().

Parameters

other

the other interval

Returns

true if this interval touches the other, otherwise false

overlaps()

template<typename T >

bool SPL::interval< T >::overlaps ( interval< T >  other ) const

inline

Determines whether this overlaps touches the other.

Interval a overlaps interval b iff a.left() < b.right() or a.right() > b.left().

Parameters

other

the other interval

Returns

true if this interval overlaps the other, otherwise false

includes()

template<typename T >

bool SPL::interval< T >::includes ( const SPL::timestamp &  ts ) const

inline

Determines whether this interval includes the specified timestamp.

This interval includes a timestamp if the timestamp is larger or equal to the left endpoint and it is smaller than the right endpoint.

Parameters

ts	a timestamp

Returns

true if this interval includes the givem timestamp, otherwise false

swap()

template<typename T >

void SPL::interval< T >::swap ( interval< T > &  other )

inline

Swap with another interval.

Parameters

other

interval to swap with

hashCode()

template<typename T >

size_t SPL::interval< T >::hashCode ( ) const

inline

Calculates hash code.

Returns

hash code

---

The documentation for this class was generated from the following file:

• SPL/Runtime/Utility/Interval.h