FilterRange Class Reference

FilterRange implements the range (ie: [min, max]) the filters will use to take their filtering decisions. More...

#include <FilterRange.h>

Inheritance diagram for FilterRange:

Collaboration diagram for FilterRange:

Classes
class	interval_t

Public Member Functions
	FilterRange ()
	Default constructor: it sets the minimum value to -infinity and the maximum value to +infinity.
	FilterRange (const FilterRange &range)
	Copy constructor:
	FilterRange (const double min, const double max)
	Constructor with parameters:
virtual	~FilterRange ()
	Destructor:
FilterRange &	operator= (const FilterRange &obj)
	Assignment operator:
double	precision () const
	Return the double precision for the comparaison of doubles.
double	lower () const
	Return the minimum value of the range.
double	upper () const
	Return the maximum value of the range.
double	getMin () const
	Return the minimum value of the range.
double	getMax () const
	Return the maximum value of the range.
double	PLUS_INF () const
	Define +infinity according to specific implementation.
double	MINUS_INF () const
	Define -infinity according to specific implementation.
bool	isInRange (const double point) const
	return Return true if the point is in range : min <= point <= max
bool	isActive () const
	return Return true if the range is active (optimize parsing of multiple ranges and returning the final decision)
void	setPrecision (const double delta)
void	setRange (const double lower, const double upper)
	Non-const methods:
void	setMin (const double minValue)
void	setMax (const double maxValue)
void	include (const double xMin, const double xMax)
	Add [xMin, xMax] interval to existing set of valid ranges.
void	includeAll ()
	Set full range (from MINUS_INF to PLUS_INF ).

Protected Member Functions
void	addRange (double xMin, double xMax)
	add a new range [xmin,xmax] deleting previous ranges full contained

Protected Attributes
std::optional< interval_t >	m_range
	The interval wrapped by a std::optional.
double	m_precision
	Setup the wanted double precision.

Detailed Description

FilterRange implements the range (ie: [min, max]) the filters will use to take their filtering decisions.

Internally it stores just the lower and upper bounds.

Definition at line 22 of file FilterRange.h.

Constructor & Destructor Documentation

FilterRange() [1/3]

FilterRange::FilterRange ( )

inline

Default constructor: it sets the minimum value to -infinity and the maximum value to +infinity.

Inline methods:

Constructors

Definition at line 166 of file FilterRange.h.

                                :
  m_range(std::nullopt),
  m_precision(1e-6)   
{}

FilterRange() [2/3]

FilterRange::FilterRange

(

const FilterRange &

range

)

Copy constructor:

Public methods:

Copy constructor

Definition at line 23 of file FilterRange.cxx.

                                                   :
  m_range( range.m_range ),
  m_precision( range.m_precision )
{}

FilterRange() [3/3]

FilterRange::FilterRange ( const double min, const double max )

inline

Constructor with parameters:

Parameters

min	: the minimum value of the range
max	: the maximum value of the range

Definition at line 171 of file FilterRange.h.

                                                                    :
  m_range( interval_t(min, max) ),
  m_precision(1e-6)   
{
  if ( min == MINUS_INF() && max == PLUS_INF() ) {
    //std::cout << ">>> You are giving a NO-OP interval : ]"
    //      << min << "; "
    //      << max << "["
    //      << std::endl
    //      << ">>> De-activating this range for optimization purpose."
    //      << std::endl;
    m_range = std::nullopt;
    if ( isActive() ) {
      std::string error = "ERROR : FilterRange is ACTIVE (Should NOT BE !!)";
      std::cerr << error << std::endl;
      throw error;
    }
  } else {
    // Do nothing : everything is allright
  }
}

~FilterRange()

FilterRange::~FilterRange ( )

inlinevirtual

Destructor:

Definition at line 195 of file FilterRange.h.

{}

Member Function Documentation

addRange()

void FilterRange::addRange ( double xMin, double xMax )

protected

add a new range [xmin,xmax] deleting previous ranges full contained

Special case where one adds a no-op interval

Definition at line 81 of file FilterRange.cxx.

{ 
  if ( xMin == MINUS_INF() && xMax == PLUS_INF() ) {
    m_range = std::nullopt;
    return;
  }
 
  m_range = interval_t( xMin, xMax );
}

getMax()

double FilterRange::getMax ( ) const

inline

Return the maximum value of the range.

Definition at line 228 of file FilterRange.h.

{
  return upper();
}

getMin()

double FilterRange::getMin ( ) const

inline

Return the minimum value of the range.

Definition at line 223 of file FilterRange.h.

{
  return lower();
}

include()

void FilterRange::include	(	const double	xMin,
		const double	xMax )

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

Reset the whole range : this is temporary, just to mimic FML::RangeSet API

Definition at line 65 of file FilterRange.cxx.

{ 
  addRange(xMin,xMax); 
}

includeAll()

void FilterRange::includeAll

(

)

Set full range (from MINUS_INF to PLUS_INF ).

Definition at line 72 of file FilterRange.cxx.

{ 
  m_range = std::nullopt;
  return;
}

isActive()

bool FilterRange::isActive ( ) const

inline

return Return true if the range is active (optimize parsing of multiple ranges and returning the final decision)

Definition at line 243 of file FilterRange.h.

{
  if ( m_range ) return true;
  return false;
}

isInRange()

bool FilterRange::isInRange

(

const double

point

)

const

return Return true if the point is in range : min <= point <= max

Const methods:

Definition at line 42 of file FilterRange.cxx.

{ 
  // check if point is in range
  if ( ( ( lower() - point ) <= +m_precision ) &&
       ( ( upper() - point ) >= -m_precision ) ) return true;
  return false; 
}

lower()

double FilterRange::lower ( ) const

inline

Return the minimum value of the range.

Definition at line 205 of file FilterRange.h.

{
  if ( m_range ) {
    return m_range->lower();
  }
 
  return MINUS_INF();
}

MINUS_INF()

double FilterRange::MINUS_INF ( ) const

inline

Define -infinity according to specific implementation.

Definition at line 238 of file FilterRange.h.

{
  return -FLT_MAX;
}

operator=()

FilterRange & FilterRange::operator=

(

const FilterRange &

obj

)

Assignment operator:

Assignment operator.

Definition at line 29 of file FilterRange.cxx.

{
  if ( this != &range ) {
    m_range = interval_t( range.lower(), range.upper() );
    m_precision = range.m_precision;
  }
 
  return *this;
}

PLUS_INF()

double FilterRange::PLUS_INF ( ) const

inline

Define +infinity according to specific implementation.

Definition at line 233 of file FilterRange.h.

{
  return FLT_MAX;
}

precision()

double FilterRange::precision ( ) const

inline

Return the double precision for the comparaison of doubles.

Definition at line 200 of file FilterRange.h.

{
  return m_precision;
}

setMax()

void FilterRange::setMax ( const double maxValue )

inline

Definition at line 262 of file FilterRange.h.

{
  return setRange( getMin(), maxValue );
}

setMin()

void FilterRange::setMin ( const double minValue )

inline

Definition at line 257 of file FilterRange.h.

{
  return setRange( minValue, getMax() );
}

setPrecision()

void FilterRange::setPrecision ( const double delta )

inline

Definition at line 252 of file FilterRange.h.

{
  m_precision = delta;
}

setRange()

void FilterRange::setRange	(	const double	lower,
		const double	upper )

Non-const methods:

Special case where one adds a no-op interval

Now handle the normal cases

Definition at line 53 of file FilterRange.cxx.

{
  if ( lower == MINUS_INF() && upper == PLUS_INF() ) {
    m_range = std::nullopt;
    return;
  }

  m_range = interval_t( lower, upper );
}

upper()

double FilterRange::upper ( ) const

inline

Return the maximum value of the range.

Definition at line 214 of file FilterRange.h.

{
  if ( m_range ) {
    return m_range->upper();
  }
 
  return PLUS_INF();
}

Member Data Documentation

m_precision

double FilterRange::m_precision

protected

Setup the wanted double precision.

Default = 1e-6

Definition at line 147 of file FilterRange.h.

m_range

std::optional<interval_t> FilterRange::m_range

protected

The interval wrapped by a std::optional.

This is to allow the instantiation of uninitialised ranges

Definition at line 143 of file FilterRange.h.

---

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

• FilterRange.h
• FilterRange.cxx