bpp::MultiRange< T > Class Template Reference

This class implements a data structure describing a set of non-overlapping intervales. More...

#include <Bpp/Numeric/Range.h>

Inheritance diagram for bpp::MultiRange< T >:

Collaboration diagram for bpp::MultiRange< T >:

Public Member Functions
	MultiRange ()
	MultiRange (const MultiRange< T > &mr)
MultiRange &	operator= (const MultiRange< T > &mr)
virtual	~MultiRange ()
void	addRange (const Range< T > &r)
	Add a new range to the collection. More...
void	restrictTo (const Range< T > &r)
	Get the intersection with a given range. More...
void	filterWithin (const Range< T > &r)
	Only keep the ranges that fall within the given range. More...
std::string	toString () const
std::vector< T >	getBounds () const
bool	isEmpty () const
size_t	size () const
const Range< T > &	getRange (size_t i) const
void	clear ()
	Clear the collection. More...

Private Member Functions
void	clean_ ()
void	clear_ ()

Private Attributes
std::vector< Range< T > * >	ranges_

Detailed Description

template<class T>
class bpp::MultiRange< T >

This class implements a data structure describing a set of non-overlapping intervales.

Definition at line 382 of file Range.h.

Constructor & Destructor Documentation

MultiRange() [1/2]

template<class T>

bpp::MultiRange< T >::MultiRange ( )

inline

Definition at line 389 of file Range.h.

MultiRange() [2/2]

template<class T>

bpp::MultiRange< T >::MultiRange ( const MultiRange< T > &  mr )

inline

Definition at line 391 of file Range.h.

References bpp::MultiRange< T >::ranges_.

~MultiRange()

template<class T>

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

inlinevirtual

Definition at line 405 of file Range.h.

References bpp::MultiRange< T >::clear_().

Member Function Documentation

addRange()

template<class T>

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

inlinevirtual

Add a new range to the collection.

Parameters

r	The range to add to the collection.

Implements bpp::RangeCollection< T >.

Definition at line 411 of file Range.h.

References bpp::MultiRange< T >::clean_(), bpp::Range< T >::clone(), and bpp::MultiRange< T >::ranges_.

clean_()

template<class T>

void bpp::MultiRange< T >::clean_ ( )

inlineprivate

Definition at line 492 of file Range.h.

References comp(), and bpp::MultiRange< T >::ranges_.

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

clear()

template<class T>

void bpp::MultiRange< T >::clear ( )

inlinevirtual

Clear the collection.

Implements bpp::RangeCollection< T >.

Definition at line 487 of file Range.h.

References bpp::MultiRange< T >::clear_().

clear_()

template<class T>

void bpp::MultiRange< T >::clear_ ( )

inlineprivate

Definition at line 508 of file Range.h.

References bpp::MultiRange< T >::ranges_.

Referenced by bpp::MultiRange< T >::clear(), bpp::MultiRange< T >::operator=(), and bpp::MultiRange< T >::~MultiRange().

filterWithin()

template<class T>

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

inlinevirtual

Only keep the ranges that fall within the given range.

Parameters

r	Restriction range.

Implements bpp::RangeCollection< T >.

Definition at line 443 of file Range.h.

References bpp::Range< T >::contains(), and bpp::MultiRange< T >::ranges_.

getBounds()

template<class T>

std::vector<T> bpp::MultiRange< T >::getBounds ( ) const

inline

Returns

A vector with all interval bounds.

Definition at line 469 of file Range.h.

References bpp::MultiRange< T >::ranges_.

getRange()

template<class T>

const Range<T>& bpp::MultiRange< T >::getRange ( size_t  i ) const

inlinevirtual

Returns

The ith range in the collection.

Implements bpp::RangeCollection< T >.

Definition at line 485 of file Range.h.

References bpp::MultiRange< T >::ranges_.

isEmpty()

template<class T>

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

inlinevirtual

Returns

True if the set does not contain any range.

Implements bpp::RangeCollection< T >.

Definition at line 481 of file Range.h.

References bpp::MultiRange< T >::ranges_.

operator=()

template<class T>

MultiRange& bpp::MultiRange< T >::operator= ( const MultiRange< T > &  mr )

inline

Definition at line 397 of file Range.h.

References bpp::MultiRange< T >::clear_(), and bpp::MultiRange< T >::ranges_.

restrictTo()

template<class T>

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

inlinevirtual

Get the intersection with a given range.

The new multirange is the union of all ranges intersections with the given range.

Parameters

r	Restriction range.

Implements bpp::RangeCollection< T >.

Definition at line 437 of file Range.h.

References bpp::MultiRange< T >::clean_(), and bpp::MultiRange< T >::ranges_.

size()

template<class T>

size_t bpp::MultiRange< T >::size ( ) const

inlinevirtual

Returns

The number of ranges in the collection.

Implements bpp::RangeCollection< T >.

Definition at line 483 of file Range.h.

References bpp::MultiRange< T >::ranges_.

toString()

template<class T>

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

inlinevirtual

Returns

A string representation of the set of intervals.

Implements bpp::RangeCollection< T >.

Definition at line 458 of file Range.h.

References bpp::MultiRange< T >::ranges_.

Member Data Documentation

ranges_

template<class T>

std::vector<Range<T>*> bpp::MultiRange< T >::ranges_

private

Definition at line 386 of file Range.h.

Referenced by bpp::MultiRange< T >::addRange(), bpp::MultiRange< T >::clean_(), bpp::MultiRange< T >::clear_(), bpp::MultiRange< T >::filterWithin(), bpp::MultiRange< T >::getBounds(), bpp::MultiRange< T >::getRange(), bpp::MultiRange< T >::isEmpty(), bpp::MultiRange< T >::MultiRange(), bpp::MultiRange< T >::operator=(), bpp::MultiRange< T >::restrictTo(), bpp::MultiRange< T >::size(), and bpp::MultiRange< T >::toString().

---

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

• Bpp/Numeric/Range.h