FilterRange.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// FilterRange.h 
// Header file for class FilterRange
// Author: S.Binet<binet@cern.ch>
#ifndef ANALYSISUTILS_FILTERRANGE_H 
#define ANALYSISUTILS_FILTERRANGE_H 
 
// STL includes
#include <cfloat>
#include <iostream>
#include <optional>
 
// Boost includes
#include <boost/numeric/interval/interval.hpp>
#include <boost/numeric/interval/checking.hpp>
#include <boost/numeric/interval/policies.hpp>
#include <boost/numeric/interval/compare/certain.hpp>
 
//>Wait for SEAL 1.4.0 and const-correctness
//#include "FML/RangeSet.h" 
 
class FilterRange 
{ 
 
  // Public methods: 
 public: 
 
  FilterRange();
  
  FilterRange( const FilterRange& range );
 
  FilterRange( const double min, const double max );
 
  virtual ~FilterRange(); 
 
  FilterRange &operator=(const FilterRange &obj); 
 
  // Const methods: 
 
  double precision() const;
 
  double lower() const;
 
  double upper() const;
 
  double getMin() const;
 
  double getMax() const;
 
  double PLUS_INF() const;
  
  double MINUS_INF() const; 
 
  bool isInRange( const double point ) const;
 
  bool isActive() const;
 
  // Non-const methods: 
  void setPrecision( const double delta );
  void setRange( const double lower, const double upper );
  void setMin( const double minValue );
  void setMax( const double maxValue );
 
  void include( const double xMin, const double xMax);
  
  void includeAll();
  
  // Protected method: 
 protected: 
 
  void addRange(double xMin, double xMax);
 
  // clean ranges present between xmin and xmax 
  //void cleanRanges(double xMin, double xMax);
 
  // Protected data: 
 protected: 
  
  typedef boost::numeric::interval<double> interval_t;
 
  std::optional<interval_t> m_range;
 
  double m_precision;
}; 
 
// Operators
bool operator==( const FilterRange& r1, const FilterRange& r2 );
bool operator!=( const FilterRange& r1, const FilterRange& r2 );
bool operator <( const FilterRange& r1, const FilterRange& r2 );
bool operator >( const FilterRange& r1, const FilterRange& r2 );
bool operator<=( const FilterRange& r1, const FilterRange& r2 );
bool operator>=( const FilterRange& r1, const FilterRange& r2 );
 
 
inline FilterRange::FilterRange() :
  m_range(std::nullopt),
  m_precision(1e-6)   
{}
 
inline FilterRange::FilterRange( const double min, const double max ) :
  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
  }
}
 
// Destructor
inline FilterRange::~FilterRange() {}
 
// Const methods: 
inline double FilterRange::precision() const
{
  return m_precision;
}
 
inline double FilterRange::lower() const 
{
  if ( m_range ) {
    return m_range->lower();
  }
 
  return MINUS_INF();
}
 
inline double FilterRange::upper() const 
{
  if ( m_range ) {
    return m_range->upper();
  }
 
  return PLUS_INF();
}
 
inline double FilterRange::getMin() const 
{
  return lower();
}
 
inline double FilterRange::getMax() const 
{
  return upper();
}
 
inline double FilterRange::PLUS_INF() const
{
  return FLT_MAX;
}
 
inline double FilterRange::MINUS_INF() const
{
  return -FLT_MAX;
}
 
inline bool FilterRange::isActive() const
{
  if ( m_range ) return true;
  return false;
}
 
// Non-const methods: 
inline void FilterRange::setPrecision( const double delta )
{
  m_precision = delta;
}
 
inline void FilterRange::setMin( const double minValue )
{
  return setRange( minValue, getMax() );
}
 
inline void FilterRange::setMax( const double maxValue )
{
  return setRange( getMin(), maxValue );
}
 
#endif //> ANALYSISUTILS_FILTERRANGE_H