Files
safe_numerics/include/safe_range.hpp
Robert Ramey 471f1b85ec got test_checked to work.
This verifies error detection for instrinsic integers at both compile and run time
2015-05-29 13:06:45 -07:00

231 lines
5.8 KiB
C++

#ifndef BOOST_NUMERIC_SAFE_RANGE_HPP
#define BOOST_NUMERIC_SAFE_RANGE_HPP
// MS compatible compilers support #pragma once
#if defined(_MSC_VER) && (_MSC_VER >= 1020)
# pragma once
#endif
// Copyright (c) 2012 Robert Ramey
//
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#include <boost/integer.hpp>
#include "numeric.hpp"
#include "safe_base.hpp"
#include "native.hpp"
#include "policies.hpp"
typedef boost::numeric::policies<boost::numeric::native, boost::numeric::throw_exception> default_policies;
/////////////////////////////////////////////////////////////////
// higher level types implemented in terms of safe_base
namespace boost {
namespace numeric {
namespace detail {
template<
boost::intmax_t MIN,
boost::intmax_t MAX
>
struct signed_stored_type {
// double check that MIN < MAX
typedef typename boost::int_t<
boost::mpl::max<
typename boost::numeric::detail::log<MIN, 2>,
typename boost::numeric::detail::log<MAX, 2>
>::type::value
>::least type;
};
template<
boost::uintmax_t MIN,
boost::uintmax_t MAX
>
struct unsigned_stored_type {
// calculate max(abs(MIN, MAX))
typedef typename boost::uint_t<
boost::mpl::max<
typename boost::numeric::detail::ulog<MIN, 2>,
typename boost::numeric::detail::ulog<MAX, 2>
>::type::value
>::least type;
};
} // detail
} // numeric
} // boost
/////////////////////////////////////////////////////////////////
// safe_signed_range
namespace boost {
namespace numeric {
template<
boost::intmax_t MIN,
boost::intmax_t MAX,
class P = default_policies
>
class safe_signed_range : public
safe_base<
typename detail::signed_stored_type<MIN, MAX>::type,
safe_signed_range<MIN, MAX, P>,
P
>
{
BOOST_CONCEPT_ASSERT((ExceptionPolicy<
typename get_exception_policy<P>::type
>));
static_assert(
MIN < MAX,
"minimum must be less than maximum"
);
typedef typename boost::numeric::safe_base<
typename detail::signed_stored_type<MIN, MAX>::type,
safe_signed_range<MIN, MAX, P>
> base;
public:
template<class T>
stored_type validate(const T & t) const {
if(safe_compare::less_than(t, MIN)
|| safe_compare::greater_than(t, MAX))
overflow("safe range out of range");
return static_cast<stored_type>(t);
}
SAFE_NUMERIC_CONSTEXPR safe_signed_range() :
base()
{}
template<class T>
SAFE_NUMERIC_CONSTEXPR safe_signed_range(const T & t) :
base(t)
{}
};
template<
boost::intmax_t MIN,
boost::intmax_t MAX,
class P
>
std::ostream & operator<<(
std::ostream & os,
const safe_signed_range<MIN, MAX, P> & t
){
return os << t.get_stored_value();
}
template<
boost::intmax_t MIN,
boost::intmax_t MAX,
class P
>
std::istream & operator>>(
std::istream & is,
safe_signed_range<MIN, MAX, P> & t
){
return is >> t.get_stored_value();
}
} // numeric
} // boost
/////////////////////////////////////////////////////////////////
// numeric limits for safe_signed_range
namespace std {
template<
intmax_t MIN,
intmax_t MAX,
class P
>
class numeric_limits<boost::numeric::safe_signed_range<MIN, MAX, P> >
: public boost::numeric::base_type<boost::numeric::safe_signed_range<MIN, MAX, P> >
{
typedef boost::numeric::base_type<boost::numeric::safe_signed_range<MIN, MAX, P> SSR;
typedef typename boost::mpl::print<SSR>::type t0;
public:
SAFE_NUMERIC_CONSTEXPR static SSR min() noexcept { return SSR(MIN); }
SAFE_NUMERIC_CONSTEXPR static SSR max() noexcept { return SSR(MAX); }
};
} // std
/////////////////////////////////////////////////////////////////
// safe_unsigned_range
namespace boost {
namespace numeric {
template<
boost::uintmax_t MIN,
boost::uintmax_t MAX,
class P = boost::numeric::default_policies
>
class safe_unsigned_range : public
safe_base<
typename detail::unsigned_stored_type<MIN, MAX>::type,
safe_unsigned_range<MIN, MAX, P>,
P
>
{
BOOST_CONCEPT_ASSERT((ExceptionPolicy<
typename get_exception_policy<P>::type
>));
static_assert(
MIN < MAX,
"minimum must be less than maximum"
);
typedef typename boost::numeric::safe_base<
typename detail::unsigned_stored_type<MIN, MAX>::type,
safe_unsigned_range<MIN, MAX, P>,
P
> base;
public:
// typedef typename detail::unsigned_stored_type<MIN, MAX>::type stored_type;
template<class T>
stored_type validate(const T & t) const {
if(safe_compare::less_than(t, MIN)
|| safe_compare::greater_than(t, MAX))
overflow("safe range out of range");
return static_cast<stored_type>(t);
}
SAFE_NUMERIC_CONSTEXPR safe_unsigned_range(){}
template<class T>
SAFE_NUMERIC_CONSTEXPR safe_unsigned_range(const T & t) :
base(t)
{}
};
} // numeric
} // boost
/////////////////////////////////////////////////////////////////
// numeric limits for safe_unsigned_range
namespace std {
template<
std::uintmax_t MIN,
std::uintmax_t MAX,
class P
>
class numeric_limits<boost::numeric::safe_unsigned_range<MIN, MAX, P> >
: public boost::numeric::base_type<boost::numeric::safe_unsigned_range<MIN, MAX, P> >
{
typedefboost::numeric::base_type<boost::numeric::safe_unsigned_range<MIN, MAX, P> SUR;
typedef typename boost::mpl::print<SUR>::type t0;
public:
SAFE_NUMERIC_CONSTEXPR static SUR min() noexcept { return SUR(MIN); }
SAFE_NUMERIC_CONSTEXPR static SUR max() noexcept { return SUR(MAX); }
};
} // std
#endif // BOOST_NUMERIC_SAFE_RANGE_HPP