piecewiseFunction.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: piecewiseFunction.h,v 1.23 2005/12/23 17:01:48 amoll Exp $
//

#ifndef BALL_MATHS_PIECEWISEFUNCTION_H
#define BALL_MATHS_PIECEWISEFUNCTION_H

#ifndef BALL_COMMON_LIMITS_H
# include <BALL/COMMON/limits.h>
#endif

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

namespace BALL
{
  typedef std::vector<double> Coefficients;

  typedef std::pair<double,double> Interval;
  #ifdef INFINITY
  #undef INFINITY
  #endif
  static const double INFINITY = Limits<double>::max();

  class BALL_EXPORT PiecewiseFunction
  {
    public:

    BALL_CREATE(PiecewiseFunction)

    

    PiecewiseFunction() ;

    PiecewiseFunction(const PiecewiseFunction& function) ;

    PiecewiseFunction(const std::vector<Interval>& intervals, 
      const std::vector<Coefficients>& coeffs) ;

    virtual ~PiecewiseFunction() ;



    PiecewiseFunction& operator = (const PiecewiseFunction& function) ;

    void clear() ;



    void setIntervals(const std::vector<Interval>& intervals) ;

    const std::vector<Interval>& getIntervals() const ;

    const Interval& getInterval(double x) const
      throw(Exception::OutOfRange);

    const Interval& getInterval(Position index) const 
      throw(Exception::IndexOverflow);

    Position getIntervalIndex(double x) const 
      throw(Exception::OutOfRange);

    const Interval& getRange() const ;

    void setCoefficients(const vector<Coefficients>& coefficients) ;

    const std::vector<Coefficients>& getCoefficients() const ;

    const Coefficients& getCoefficients(double x) const 
      throw(Exception::OutOfRange);

    const Coefficients& getCoefficients(Position index) const 
      throw(Exception::IndexOverflow);
    
    virtual double operator () (double x) const ;

    void set(const std::vector<Interval>& intervals,
        const std::vector<Coefficients>& coeffs) ;



    bool isInRange(double x) const ;

    virtual bool isValid() const ;

    bool operator == (const PiecewiseFunction& function) const ;



    virtual void dump (std::ostream& s = std::cout, Size depth = 0) const ;


    protected:

    /*_ This vector contains the intervals of the representation 
    */
    std::vector<Interval> intervals_;

    /*_ This vector stores the coefficients for each interval 
    */
    std::vector<Coefficients> coefficients_;

    bool valid_;


    private:

    /*_ The range of the defnition, needed for isInRange() and getRange() 
    */
    Interval range_;

    /*_ Set the internal range fields 
    */
    void calculateRange() ;

  };
}

#endif