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