AIDA::IRangeSet Class Reference

User level interface to RangeSet. More...

#include <IRangeSet.h>

Inheritance diagram for AIDA::IRangeSet:

Public Member Functions
virtual	~IRangeSet ()
	Destructor.
virtual const std::vector < double > &	lowerBounds ()=0
	Return array of lower Bounds for the current set of ranges. More...
virtual const std::vector < double > &	upperBounds ()=0
	Return array of upper Bounds for the current set of ranges. More...
virtual void	include (double xMin, double xMax)=0
	Add [xMin, xMax] interval to existing set of valid ranges. More...
virtual void	exclude (double xMin, double xMax)=0
	Exclude [xMin, xMax] interval from the existing set of valid ranges. More...
virtual void	includeAll ()=0
	Set full range (from MINUS_INF to PLUS_INF ).
virtual void	excludeAll ()=0
	Set empty range.
virtual bool	isInRange (double point)=0
virtual int	size ()=0
	Return current number of disjoint ranges (non-overlapping intervals). More...
virtual double	PLUS_INF ()=0
virtual double	MINUS_INF ()=0

Detailed Description

User level interface to RangeSet.

Proposed rules for ranges:

• By default (no arguments) RangeSet object is created with one valid range: (-infinity, +infinity).
• size=0 means no valid ranges (isInRange(double point) will return false for any point). It also can be used to check if any range is set - RangeSet include valid interval only if size!=0.
• RangeSet can be smart, e.g merge overlapping valid ranges. So size() does not always equal to the number of times user call include method.

Author

The AIDA team (http://aida.freehep.org/)

Member Function Documentation

virtual void AIDA::IRangeSet::exclude ( double  xMin, double  xMax  )

pure virtual

Exclude [xMin, xMax] interval from the existing set of valid ranges.

Parameters

xMin	- lower bound of range to be excluded
xMax	- upper bound of range to be excluded

Implemented in AIDA::IRangeSetROOT.

virtual void AIDA::IRangeSet::include ( double  xMin, double  xMax  )

pure virtual

Add [xMin, xMax] interval to existing set of valid ranges.

Parameters

xMin	- lower bound of a new valid range
xMax	- upper bound of a new valid range

Implemented in AIDA::IRangeSetROOT.

virtual const std::vector<double>& AIDA::IRangeSet::lowerBounds ( )

pure virtual

Return array of lower Bounds for the current set of ranges.

Returns

Array of lower bounds for all valid ranges

Implemented in AIDA::IRangeSetROOT.

virtual int AIDA::IRangeSet::size ( )

pure virtual

Return current number of disjoint ranges (non-overlapping intervals).

Note: it is not always equal to the number of times user set the range

Returns

Number of disjoint ranges

Implemented in AIDA::IRangeSetROOT.

virtual const std::vector<double>& AIDA::IRangeSet::upperBounds ( )

pure virtual

Return array of upper Bounds for the current set of ranges.

Returns

Array of upper bounds for all valid ranges

Implemented in AIDA::IRangeSetROOT.

---

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

• IRangeSet.h