CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IRangeSet Class Reference

#include <IRangeSet.h>

List of all members.

Public Methods
virtual	~IRangeSet ()
	Destructor. More...
virtual const std::vector< double>&	lowerBounds ()=0
virtual const std::vector< double>&	upperBounds ()=0
virtual void	include (double xMin, double xMax)=0
virtual void	exclude (double xMin, double xMax)=0
virtual void	includeAll ()=0
virtual void	excludeAll ()=0
virtual bool	isInRange (double point)=0
virtual int	size ()=0
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/)

Definition at line 42 of file IRangeSet.h.

---

Constructor & Destructor Documentation

AIDA::IRangeSet::~IRangeSet ( ) [inline, virtual]

Definition at line 46 of file IRangeSet.h.

---

Member Function Documentation

double AIDA::IRangeSet::MINUS_INF ( ) [pure virtual]

double AIDA::IRangeSet::PLUS_INF ( ) [pure 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

void AIDA::IRangeSet::excludeAll ( ) [pure virtual]

Set empty range.

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

void AIDA::IRangeSet::includeAll ( ) [pure virtual]

Set full range (from MINUS_INF to PLUS_INF ).

bool AIDA::IRangeSet::isInRange ( double point ) [pure 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

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

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

---

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

• IRangeSet.h

---