Chris@16: /* Boost interval/interval.hpp header file
Chris@16:  *
Chris@16:  * Copyright 2002-2003 Hervé Brönnimann, Guillaume Melquiond, Sylvain Pion
Chris@16:  *
Chris@16:  * Distributed under the Boost Software License, Version 1.0.
Chris@16:  * (See accompanying file LICENSE_1_0.txt or
Chris@16:  * copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16:  */
Chris@16: 
Chris@16: #ifndef BOOST_NUMERIC_INTERVAL_INTERVAL_HPP
Chris@16: #define BOOST_NUMERIC_INTERVAL_INTERVAL_HPP
Chris@16: 
Chris@16: #include <stdexcept>
Chris@16: #include <string>
Chris@16: #include <boost/numeric/interval/detail/interval_prototype.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace numeric {
Chris@16: 
Chris@16: namespace interval_lib {
Chris@16:     
Chris@16: class comparison_error
Chris@16:   : public std::runtime_error 
Chris@16: {
Chris@16: public:
Chris@16:   comparison_error()
Chris@16:     : std::runtime_error("boost::interval: uncertain comparison")
Chris@16:   { }
Chris@16: };
Chris@16: 
Chris@16: } // namespace interval_lib
Chris@16: 
Chris@16: /*
Chris@16:  * interval class
Chris@16:  */
Chris@16: 
Chris@16: template<class T, class Policies>
Chris@16: class interval
Chris@16: {
Chris@16: private:
Chris@16:   struct interval_holder;
Chris@16:   struct number_holder;
Chris@16: public:
Chris@16:   typedef T base_type;
Chris@16:   typedef Policies traits_type;
Chris@16: 
Chris@16:   T const &lower() const;
Chris@16:   T const &upper() const;
Chris@16: 
Chris@16:   interval();
Chris@16:   interval(T const &v);
Chris@16:   template<class T1> interval(T1 const &v);
Chris@16:   interval(T const &l, T const &u);
Chris@16:   template<class T1, class T2> interval(T1 const &l, T2 const &u);
Chris@16:   interval(interval<T, Policies> const &r);
Chris@16:   template<class Policies1> interval(interval<T, Policies1> const &r);
Chris@16:   template<class T1, class Policies1> interval(interval<T1, Policies1> const &r);
Chris@16: 
Chris@16:   interval &operator=(T const &v);
Chris@16:   template<class T1> interval &operator=(T1 const &v);
Chris@16:   interval &operator=(interval<T, Policies> const &r);
Chris@16:   template<class Policies1> interval &operator=(interval<T, Policies1> const &r);
Chris@16:   template<class T1, class Policies1> interval &operator=(interval<T1, Policies1> const &r);
Chris@16:  
Chris@16:   void assign(const T& l, const T& u);
Chris@16: 
Chris@16:   static interval empty();
Chris@16:   static interval whole();
Chris@16:   static interval hull(const T& x, const T& y);
Chris@16: 
Chris@16:   interval& operator+= (const T& r);
Chris@16:   interval& operator+= (const interval& r);
Chris@16:   interval& operator-= (const T& r);
Chris@16:   interval& operator-= (const interval& r);
Chris@16:   interval& operator*= (const T& r);
Chris@16:   interval& operator*= (const interval& r);
Chris@16:   interval& operator/= (const T& r);
Chris@16:   interval& operator/= (const interval& r);
Chris@16: 
Chris@16:   bool operator< (const interval_holder& r) const;
Chris@16:   bool operator> (const interval_holder& r) const;
Chris@16:   bool operator<= (const interval_holder& r) const;
Chris@16:   bool operator>= (const interval_holder& r) const;
Chris@16:   bool operator== (const interval_holder& r) const;
Chris@16:   bool operator!= (const interval_holder& r) const;
Chris@16: 
Chris@16:   bool operator< (const number_holder& r) const;
Chris@16:   bool operator> (const number_holder& r) const;
Chris@16:   bool operator<= (const number_holder& r) const;
Chris@16:   bool operator>= (const number_holder& r) const;
Chris@16:   bool operator== (const number_holder& r) const;
Chris@16:   bool operator!= (const number_holder& r) const;
Chris@16: 
Chris@16:   // the following is for internal use only, it is not a published interface
Chris@16:   // nevertheless, it's public because friends don't always work correctly.
Chris@16:   interval(const T& l, const T& u, bool): low(l), up(u) {}
Chris@16:   void set_empty();
Chris@16:   void set_whole();
Chris@16:   void set(const T& l, const T& u);
Chris@16: 
Chris@16: private:
Chris@16:   struct interval_holder {
Chris@16:     template<class Policies2>
Chris@16:     interval_holder(const interval<T, Policies2>& r)
Chris@16:       : low(r.lower()), up(r.upper())
Chris@16:     {
Chris@16:       typedef typename Policies2::checking checking2;
Chris@16:       if (checking2::is_empty(low, up))
Chris@16:         throw interval_lib::comparison_error();
Chris@16:     }
Chris@16: 
Chris@16:     const T& low;
Chris@16:     const T& up;
Chris@16:   };
Chris@16: 
Chris@16:   struct number_holder {
Chris@16:     number_holder(const T& r) : val(r)
Chris@16:     {
Chris@16:       typedef typename Policies::checking checking;
Chris@16:       if (checking::is_nan(r))
Chris@16:         throw interval_lib::comparison_error();
Chris@16:     }
Chris@16:     
Chris@16:     const T& val;
Chris@16:   };
Chris@16: 
Chris@16:   typedef typename Policies::checking checking;
Chris@16:   typedef typename Policies::rounding rounding;
Chris@16: 
Chris@16:   T low;
Chris@16:   T up;
Chris@16: };
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies>::interval():
Chris@16:   low(static_cast<T>(0)), up(static_cast<T>(0))
Chris@16: {}
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies>::interval(T const &v): low(v), up(v)
Chris@16: {
Chris@16:   if (checking::is_nan(v)) set_empty();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class T1> inline
Chris@16: interval<T, Policies>::interval(T1 const &v)
Chris@16: {
Chris@16:   if (checking::is_nan(v)) set_empty();
Chris@16:   else {
Chris@16:     rounding rnd;
Chris@16:     low = rnd.conv_down(v);
Chris@16:     up  = rnd.conv_up  (v);
Chris@16:   }
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class T1, class T2> inline
Chris@16: interval<T, Policies>::interval(T1 const &l, T2 const &u)
Chris@16: {
Chris@16:   if (checking::is_nan(l) || checking::is_nan(u) || !(l <= u)) set_empty();
Chris@16:   else {
Chris@16:     rounding rnd;
Chris@16:     low = rnd.conv_down(l);
Chris@16:     up  = rnd.conv_up  (u);
Chris@16:   }
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies>::interval(T const &l, T const &u): low(l), up(u)
Chris@16: {
Chris@16:   if (checking::is_nan(l) || checking::is_nan(u) || !(l <= u))
Chris@16:     set_empty();
Chris@16: }
Chris@16: 
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies>::interval(interval<T, Policies> const &r): low(r.lower()), up(r.upper())
Chris@16: {}
Chris@16: 
Chris@16: template<class T, class Policies> template<class Policies1> inline
Chris@16: interval<T, Policies>::interval(interval<T, Policies1> const &r): low(r.lower()), up(r.upper())
Chris@16: {
Chris@16:   typedef typename Policies1::checking checking1;
Chris@16:   if (checking1::is_empty(r.lower(), r.upper())) set_empty();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class T1, class Policies1> inline
Chris@16: interval<T, Policies>::interval(interval<T1, Policies1> const &r)
Chris@16: {
Chris@16:   typedef typename Policies1::checking checking1;
Chris@16:   if (checking1::is_empty(r.lower(), r.upper())) set_empty();
Chris@16:   else {
Chris@16:     rounding rnd;
Chris@16:     low = rnd.conv_down(r.lower());
Chris@16:     up  = rnd.conv_up  (r.upper());
Chris@16:   }
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies> &interval<T, Policies>::operator=(T const &v)
Chris@16: {
Chris@16:   if (checking::is_nan(v)) set_empty();
Chris@16:   else low = up = v;
Chris@16:   return *this;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class T1> inline
Chris@16: interval<T, Policies> &interval<T, Policies>::operator=(T1 const &v)
Chris@16: {
Chris@16:   if (checking::is_nan(v)) set_empty();
Chris@16:   else {
Chris@16:     rounding rnd;
Chris@16:     low = rnd.conv_down(v);
Chris@16:     up  = rnd.conv_up  (v);
Chris@16:   }
Chris@16:   return *this;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies> &interval<T, Policies>::operator=(interval<T, Policies> const &r)
Chris@16: {
Chris@16:   low = r.lower();
Chris@16:   up  = r.upper();
Chris@16:   return *this;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class Policies1> inline
Chris@16: interval<T, Policies> &interval<T, Policies>::operator=(interval<T, Policies1> const &r)
Chris@16: {
Chris@16:   typedef typename Policies1::checking checking1;
Chris@16:   if (checking1::is_empty(r.lower(), r.upper())) set_empty();
Chris@16:   else {
Chris@16:     low = r.lower();
Chris@16:     up  = r.upper();
Chris@16:   }
Chris@16:   return *this;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> template<class T1, class Policies1> inline
Chris@16: interval<T, Policies> &interval<T, Policies>::operator=(interval<T1, Policies1> const &r)
Chris@16: {
Chris@16:   typedef typename Policies1::checking checking1;
Chris@16:   if (checking1::is_empty(r.lower(), r.upper())) set_empty();
Chris@16:   else {
Chris@16:     rounding rnd;
Chris@16:     low = rnd.conv_down(r.lower());
Chris@16:     up  = rnd.conv_up  (r.upper());
Chris@16:   }
Chris@16:   return *this;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: void interval<T, Policies>::assign(const T& l, const T& u)
Chris@16: {
Chris@16:   if (checking::is_nan(l) || checking::is_nan(u) || !(l <= u))
Chris@16:     set_empty();
Chris@16:   else set(l, u);
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: void interval<T, Policies>::set(const T& l, const T& u)
Chris@16: {
Chris@16:   low = l;
Chris@16:   up  = u;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: void interval<T, Policies>::set_empty()
Chris@16: {
Chris@16:   low = checking::empty_lower();
Chris@16:   up  = checking::empty_upper();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: void interval<T, Policies>::set_whole()
Chris@16: {
Chris@16:   low = checking::neg_inf();
Chris@16:   up  = checking::pos_inf();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies> interval<T, Policies>::hull(const T& x, const T& y)
Chris@16: {
Chris@16:   bool bad_x = checking::is_nan(x);
Chris@16:   bool bad_y = checking::is_nan(y);
Chris@16:   if (bad_x)
Chris@16:     if (bad_y) return interval::empty();
Chris@16:     else       return interval(y, y, true);
Chris@16:   else
Chris@16:     if (bad_y) return interval(x, x, true);
Chris@16:   if (x <= y) return interval(x, y, true);
Chris@16:   else        return interval(y, x, true);
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies> interval<T, Policies>::empty()
Chris@16: {
Chris@16:   return interval<T, Policies>(checking::empty_lower(),
Chris@16:                                checking::empty_upper(), true);
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: interval<T, Policies> interval<T, Policies>::whole()
Chris@16: {
Chris@16:   return interval<T, Policies>(checking::neg_inf(), checking::pos_inf(), true);
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: const T& interval<T, Policies>::lower() const
Chris@16: {
Chris@16:   return low;
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: const T& interval<T, Policies>::upper() const
Chris@16: {
Chris@16:   return up;
Chris@16: }
Chris@16: 
Chris@16: /*
Chris@16:  * interval/interval comparisons
Chris@16:  */
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator< (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up < r.low) return true;
Chris@16:     else if (low >= r.up) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator> (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (low > r.up) return true;
Chris@16:     else if (up <= r.low) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator<= (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up <= r.low) return true;
Chris@16:     else if (low > r.up) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator>= (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (low >= r.up) return true;
Chris@16:     else if (up < r.low) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator== (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up == r.low && low == r.up) return true;
Chris@16:     else if (up < r.low || low > r.up) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator!= (const interval_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up < r.low || low > r.up) return true;
Chris@16:     else if (up == r.low && low == r.up) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: /*
Chris@16:  * interval/number comparisons
Chris@16:  */
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator< (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up < r.val) return true;
Chris@16:     else if (low >= r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator> (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (low > r.val) return true;
Chris@16:     else if (up <= r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator<= (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up <= r.val) return true;
Chris@16:     else if (low > r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator>= (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (low >= r.val) return true;
Chris@16:     else if (up < r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator== (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up == r.val && low == r.val) return true;
Chris@16:     else if (up < r.val || low > r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: template<class T, class Policies> inline
Chris@16: bool interval<T, Policies>::operator!= (const number_holder& r) const
Chris@16: {
Chris@16:   if (!checking::is_empty(low, up)) {
Chris@16:     if (up < r.val || low > r.val) return true;
Chris@16:     else if (up == r.val && low == r.val) return false;
Chris@16:   }
Chris@16:   throw interval_lib::comparison_error();
Chris@16: }
Chris@16: 
Chris@16: } // namespace numeric
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #endif // BOOST_NUMERIC_INTERVAL_INTERVAL_HPP