The Range class, defining an interval. More...

#include <Bpp/Numeric/Range.h>

Inheritance diagram for bpp::Range< T >:

Collaboration diagram for bpp::Range< T >:

Public Member Functions
	Range (const T &a=0, const T &b=0)
	Creates a new interval. More...

	Range (const Range< T > &range)

Range< T > &	operator= (const Range< T > &range)

Range< T > *	clone () const
	Create a copy of this object and send a pointer to it. More...

virtual	~Range ()

bool	operator== (const Range< T > &r) const

bool	operator!= (const Range< T > &r) const

bool	operator< (const Range< T > &r) const

virtual Range &	operator+= (const T &val)

virtual Range	operator+ (const T &val)

virtual Range &	operator-= (const T &val)

virtual Range	operator- (const T &val)

T	begin () const

T	end () const

T	length () const

bool	overlap (const Range &r) const

bool	isContiguous (const Range &r) const

bool	contains (const Range &r) const

void	expandWith (const Range &r)
	Expand the current interval with the given one. More...

void	sliceWith (const Range &r)
	Restrict the current interval to the intersection with the given one. More...

bool	isEmpty () const

std::string	toString () const

Private Attributes
T	begin_

T	end_

Detailed Description

template<class T>
class bpp::Range< T >

The Range class, defining an interval.

Methods are provided for extending the range, get union and intersection.

Definition at line 62 of file Range.h.

Constructor & Destructor Documentation

◆ Range() [1/2]

template<class T >

bpp::Range< T >::Range	(	const T &	a = `0`,
		const T &	b = `0`
	)

inline

Creates a new interval.

If a > b, then the positions are swapped. If a == b, the interval is considered empty. Coordinates are 0-based and of type [a, b[, so that the length of the interval is computed as b - a.

Parameters

a	First position
b	Second position

Definition at line 82 of file Range.h.

◆ Range() [2/2]

template<class T >

bpp::Range< T >::Range ( const Range< T > & range )

inline

Definition at line 87 of file Range.h.

◆ ~Range()

template<class T >

virtual bpp::Range< T >::~Range ( )

inlinevirtual

Definition at line 98 of file Range.h.

Member Function Documentation

◆ begin()

template<class T >

T bpp::Range< T >::begin ( ) const

inline

Definition at line 134 of file Range.h.

References bpp::Range< T >::begin_.

◆ clone()

template<class T >

Range<T>* bpp::Range< T >::clone ( ) const

inlinevirtual

Create a copy of this object and send a pointer to it.

Returns: A pointer toward the copy object.

Implements bpp::Clonable.

Definition at line 96 of file Range.h.

Referenced by bpp::RangeSet< T >::addRange(), and bpp::MultiRange< T >::addRange().

◆ contains()

template<class T >

bool bpp::Range< T >::contains ( const Range< T > & r ) const

inline

Parameters

r	Range to compare with.

Returns: True if the given interval is included in the instanciated one.

Definition at line 163 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

Referenced by bpp::RangeSet< T >::filterWithin(), and bpp::MultiRange< T >::filterWithin().

◆ end()

template<class T >

T bpp::Range< T >::end ( ) const

inline

Definition at line 136 of file Range.h.

References bpp::Range< T >::end_.

◆ expandWith()

template<class T >

void bpp::Range< T >::expandWith ( const Range< T > & r )

inline

Expand the current interval with the given one.

If the two intervals do not overlap, then the interval is not modified.

Parameters

r	input interval.

Definition at line 174 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ isContiguous()

template<class T >

bool bpp::Range< T >::isContiguous ( const Range< T > & r ) const

inline

Parameters

r	Range to compare with.

Returns: True if the two intervals are contiguous (i.e. the two intervals are adjacent and share one bound).

Definition at line 154 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ isEmpty()

template<class T >

bool bpp::Range< T >::isEmpty ( ) const

inline

Returns: True if then begining position equals the ending one.

Definition at line 207 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

Referenced by bpp::RangeSet< T >::addRange().

◆ length()

template<class T >

T bpp::Range< T >::length ( ) const

inline

Definition at line 138 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator!=()

template<class T >

bool bpp::Range< T >::operator!= ( const Range< T > & r ) const

inline

Definition at line 105 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator+()

template<class T >

virtual Range bpp::Range< T >::operator+ ( const T & val )

inlinevirtual

Definition at line 119 of file Range.h.

◆ operator+=()

template<class T >

virtual Range& bpp::Range< T >::operator+= ( const T & val )

inlinevirtual

Definition at line 113 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator-()

template<class T >

virtual Range bpp::Range< T >::operator- ( const T & val )

inlinevirtual

Definition at line 129 of file Range.h.

◆ operator-=()

template<class T >

virtual Range& bpp::Range< T >::operator-= ( const T & val )

inlinevirtual

Definition at line 123 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator<()

template<class T >

bool bpp::Range< T >::operator< ( const Range< T > & r ) const

inline

Definition at line 109 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator=()

template<class T >

Range<T>& bpp::Range< T >::operator= ( const Range< T > & range )

inline

Definition at line 89 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ operator==()

template<class T >

bool bpp::Range< T >::operator== ( const Range< T > & r ) const

inline

Definition at line 101 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

◆ overlap()

template<class T >

bool bpp::Range< T >::overlap ( const Range< T > & r ) const

inline

Parameters

r	Range to compare with.

Returns: True if the two intervals overlap.

Definition at line 144 of file Range.h.

References bpp::Range< T >::begin_, and bpp::Range< T >::end_.

Referenced by bpp::Range< T >::sliceWith().

◆ sliceWith()

template<class T >

void bpp::Range< T >::sliceWith ( const Range< T > & r )

inline

Restrict the current interval to the intersection with the given one.

If the two intervals do not overlap, then the interval is set to empty.

Parameters

r	input interval.

Definition at line 188 of file Range.h.

References bpp::Range< T >::begin_, bpp::Range< T >::end_, and bpp::Range< T >::overlap().

◆ toString()

template<class T >

std::string bpp::Range< T >::toString ( ) const

inline

Returns: A string describing the range.

Definition at line 212 of file Range.h.

References bpp::Range< T >::begin_, bpp::Range< T >::end_, and bpp::TextTools::toString().

Member Data Documentation

◆ begin_

template<class T >

T bpp::Range< T >::begin_

private

Definition at line 66 of file Range.h.

Referenced by bpp::Range< T >::begin(), bpp::Range< T >::contains(), bpp::Range< T >::expandWith(), bpp::Range< T >::isContiguous(), bpp::Range< T >::isEmpty(), bpp::Range< T >::length(), bpp::Range< T >::operator!=(), bpp::Range< T >::operator+=(), bpp::Range< T >::operator-=(), bpp::Range< T >::operator<(), bpp::Range< T >::operator=(), bpp::Range< T >::operator==(), bpp::Range< T >::overlap(), bpp::Range< T >::sliceWith(), and bpp::Range< T >::toString().

◆ end_

template<class T >

T bpp::Range< T >::end_

private

Definition at line 67 of file Range.h.

Referenced by bpp::Range< T >::contains(), bpp::Range< T >::end(), bpp::Range< T >::expandWith(), bpp::Range< T >::isContiguous(), bpp::Range< T >::isEmpty(), bpp::Range< T >::length(), bpp::Range< T >::operator!=(), bpp::Range< T >::operator+=(), bpp::Range< T >::operator-=(), bpp::Range< T >::operator<(), bpp::Range< T >::operator=(), bpp::Range< T >::operator==(), bpp::Range< T >::overlap(), bpp::Range< T >::sliceWith(), and bpp::Range< T >::toString().

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

Bpp/Numeric/Range.h

Public Member Functions

Private Attributes

Detailed Description

template<class T> class bpp::Range< T >

Constructor & Destructor Documentation

◆ Range() [1/2]

◆ Range() [2/2]

◆ ~Range()

Member Function Documentation

◆ begin()

◆ clone()

◆ contains()

◆ end()

◆ expandWith()

◆ isContiguous()

◆ isEmpty()

◆ length()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ overlap()

◆ sliceWith()

◆ toString()

Member Data Documentation

◆ begin_

◆ end_

template<class T>
class bpp::Range< T >