Limits.h

Go to the documentation of this file.

/*
 *  CepGen: a central exclusive processes event generator
 *  Copyright (C) 2018-2024  Laurent Forthomme
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef CepGen_Utils_Limits_h
#define CepGen_Utils_Limits_h
 
#include <iosfwd>
#include <utility>
#include <vector>
 
namespace cepgen {
  class Limits : private std::pair<double, double> {
  public:
    Limits(double min = INVALID, double max = INVALID);  
    Limits(const Limits&);                               
 
    static Limits constant(double);  
 
    bool operator<(const Limits&) const;         
    Limits operator-() const;                    
    Limits& operator=(const Limits&) = default;  
    inline bool operator==(const Limits& oth) const { return *this == (std::pair<double, double>)oth; }
    inline bool operator!=(const Limits& oth) const { return !operator==(oth); }  
    Limits& operator+=(double);                                                   
    Limits& operator-=(double);                                                   
    Limits& operator*=(double);                                                   
    friend Limits operator+(Limits, double);                                      
    friend Limits operator-(Limits, double);                                      
    friend Limits operator*(Limits, double);                                      
 
    Limits& validate();  
 
    bool hasMin() const;                          
    bool hasMax() const;                          
    inline double min() const { return first; }   
    inline double& min() { return first; }        
    inline double max() const { return second; }  
    inline double& max() { return second; }       
 
    double x(double v) const;        
    void in(double low, double up);  
    double range() const;            
 
    Limits truncate(const Limits&) const;                              
    double trim(double) const;                                         
    bool contains(double val, bool exclude_boundaries = false) const;  
    Limits& apply(double (*)(double));                                 
 
    Limits compute(double (*)(double)) const;  
    template <typename F>
    inline Limits compute(const F& op) const {
      return Limits{hasMin() ? op(min()) : INVALID, hasMax() ? op(max()) : INVALID};
    }
    bool valid() const;                                                    
    inline const std::pair<double, double>& raw() const { return *this; }  
 
    std::vector<double> generate(size_t num_bins, bool log_scale = false) const;
    std::vector<Limits> split(size_t num_bins, bool log_scale = false) const;
 
    friend std::ostream& operator<<(std::ostream&, const Limits&);  
 
    static constexpr double INVALID = -999.999;  
  };
}  // namespace cepgen
 
#endif