libs/histogram/test/axis_integer_test.cpp

   1 // Copyright 2015-2018 Hans Dembinski
   2 //
   3 // Distributed under the Boost Software License, Version 1.0.
   4 // (See accompanying file LICENSE_1_0.txt
   5 // or copy at http://www.boost.org/LICENSE_1_0.txt)
   6
   7 #include <boost/core/lightweight_test.hpp>
   8 #include <boost/histogram/axis/integer.hpp>
   9 #include <boost/histogram/axis/ostream.hpp>
  10 #include <limits>
  11 #include <sstream>
  12 #include <type_traits>
  13 #include "std_ostream.hpp"
  14 #include "throw_exception.hpp"
  15 #include "utility_axis.hpp"
  16 #include "utility_str.hpp"
  17
  18 int main() {
  19   using namespace boost::histogram;
  20
  21   BOOST_TEST(std::is_nothrow_move_assignable<axis::integer<>>::value);
  22   BOOST_TEST(std::is_nothrow_move_constructible<axis::integer<>>::value);
  23
  24   // bad_ctor
  25   { BOOST_TEST_THROWS(axis::integer<>(1, -1), std::invalid_argument); }
  26
  27   // axis::integer with double type
  28   {
  29     axis::integer<double> a{-1, 2, "foo"};
  30     BOOST_TEST_EQ(a.metadata(), "foo");
  31     BOOST_TEST_EQ(static_cast<const axis::integer<double>&>(a).metadata(), "foo");
  32     a.metadata() = "bar";
  33     BOOST_TEST_EQ(static_cast<const axis::integer<double>&>(a).metadata(), "bar");
  34     BOOST_TEST_EQ(a.bin(-1).lower(), -std::numeric_limits<double>::infinity());
  35     BOOST_TEST_EQ(a.bin(a.size()).upper(), std::numeric_limits<double>::infinity());
  36     BOOST_TEST_EQ(a.index(-10), -1);
  37     BOOST_TEST_EQ(a.index(-2), -1);
  38     BOOST_TEST_EQ(a.index(-1), 0);
  39     BOOST_TEST_EQ(a.index(0), 1);
  40     BOOST_TEST_EQ(a.index(1), 2);
  41     BOOST_TEST_EQ(a.index(2), 3);
  42     BOOST_TEST_EQ(a.index(10), 3);
  43     BOOST_TEST_EQ(a.index(std::numeric_limits<double>::quiet_NaN()), 3);
  44
  45     BOOST_TEST_EQ(str(a),
  46                   "integer(-1, 2, metadata=\"bar\", options=underflow | overflow)");
  47
  48     axis::integer<double> b;
  49     BOOST_TEST_NE(a, b);
  50     b = a;
  51     BOOST_TEST_EQ(a, b);
  52     axis::integer<double> c = std::move(b);
  53     BOOST_TEST_EQ(c, a);
  54     axis::integer<double> d;
  55     BOOST_TEST_NE(c, d);
  56     d = std::move(c);
  57     BOOST_TEST_EQ(d, a);
  58   }
  59
  60   // empty axis::integer
  61   {
  62     axis::integer<> a;
  63     BOOST_TEST_EQ(a.size(), 0);
  64     BOOST_TEST_EQ(a.bin(1), 1);
  65     BOOST_TEST_EQ(a.bin(0), 0);
  66     BOOST_TEST_EQ(a.bin(-1), -1);
  67     BOOST_TEST_EQ(a.index(-10), -1);
  68     BOOST_TEST_EQ(a.index(-1), -1);
  69     BOOST_TEST_EQ(a.index(0), 0);
  70     BOOST_TEST_EQ(a.index(10), 0);
  71
  72     BOOST_TEST_EQ(str(a), "integer(0, 0, options=underflow | overflow)");
  73
  74     axis::integer<> b{1, 1};
  75     BOOST_TEST_EQ(b.size(), 0);
  76     BOOST_TEST_EQ(b.bin(1), 2);
  77     BOOST_TEST_EQ(b.bin(0), 1);
  78     BOOST_TEST_EQ(b.bin(-1), 0);
  79     BOOST_TEST_EQ(b.index(-10), -1);
  80     BOOST_TEST_EQ(b.index(-1), -1);
  81     BOOST_TEST_EQ(b.index(0), -1);
  82     BOOST_TEST_EQ(b.index(1), 0);
  83     BOOST_TEST_EQ(b.index(10), 0);
  84
  85     BOOST_TEST_EQ(str(b), "integer(1, 1, options=underflow | overflow)");
  86   }
  87
  88   // axis::integer with int type
  89   {
  90     axis::integer<int> a{-1, 2};
  91     BOOST_TEST_EQ(a.bin(-2), -3);
  92     BOOST_TEST_EQ(a.bin(4), 3);
  93     BOOST_TEST_EQ(a.index(-10), -1);
  94     BOOST_TEST_EQ(a.index(-2), -1);
  95     BOOST_TEST_EQ(a.index(-1), 0);
  96     BOOST_TEST_EQ(a.index(0), 1);
  97     BOOST_TEST_EQ(a.index(1), 2);
  98     BOOST_TEST_EQ(a.index(2), 3);
  99     BOOST_TEST_EQ(a.index(10), 3);
 100
 101     BOOST_TEST_EQ(str(a), "integer(-1, 2, options=underflow | overflow)");
 102   }
 103
 104   // axis::integer int,circular
 105   {
 106     axis::integer<int, axis::null_type, axis::option::circular_t> a(-1, 1);
 107     BOOST_TEST_EQ(a.value(-1), -2);
 108     BOOST_TEST_EQ(a.value(0), -1);
 109     BOOST_TEST_EQ(a.value(1), 0);
 110     BOOST_TEST_EQ(a.value(2), 1);
 111     BOOST_TEST_EQ(a.value(3), 2);
 112     BOOST_TEST_EQ(a.index(-2), 1);
 113     BOOST_TEST_EQ(a.index(-1), 0);
 114     BOOST_TEST_EQ(a.index(0), 1);
 115     BOOST_TEST_EQ(a.index(1), 0);
 116     BOOST_TEST_EQ(a.index(2), 1);
 117
 118     BOOST_TEST_EQ(str(a), "integer(-1, 1, options=circular)");
 119   }
 120
 121   // axis::integer double,circular
 122   {
 123     axis::integer<double, axis::null_type, axis::option::circular_t> a(-1, 1);
 124     BOOST_TEST_EQ(a.value(-1), -2);
 125     BOOST_TEST_EQ(a.value(0), -1);
 126     BOOST_TEST_EQ(a.value(1), 0);
 127     BOOST_TEST_EQ(a.value(2), 1);
 128     BOOST_TEST_EQ(a.value(3), 2);
 129     BOOST_TEST_EQ(a.index(-2), 1);
 130     BOOST_TEST_EQ(a.index(-1), 0);
 131     BOOST_TEST_EQ(a.index(0), 1);
 132     BOOST_TEST_EQ(a.index(1), 0);
 133     BOOST_TEST_EQ(a.index(2), 1);
 134     BOOST_TEST_EQ(a.index(std::numeric_limits<double>::quiet_NaN()), 2);
 135   }
 136
 137   // axis::integer with growth
 138   {
 139     axis::integer<double, axis::null_type, axis::option::growth_t> a;
 140     BOOST_TEST_EQ(a.size(), 0);
 141     BOOST_TEST_EQ(a.update(0), std::make_pair(0, -1));
 142     BOOST_TEST_EQ(a.size(), 1);
 143     BOOST_TEST_EQ(a.update(1), std::make_pair(1, -1));
 144     BOOST_TEST_EQ(a.size(), 2);
 145     BOOST_TEST_EQ(a.update(-1), std::make_pair(0, 1));
 146     BOOST_TEST_EQ(a.size(), 3);
 147     BOOST_TEST_EQ(a.update(std::numeric_limits<double>::infinity()),
 148                   std::make_pair(a.size(), 0));
 149     BOOST_TEST_EQ(a.update(std::numeric_limits<double>::quiet_NaN()),
 150                   std::make_pair(a.size(), 0));
 151     BOOST_TEST_EQ(a.update(-std::numeric_limits<double>::infinity()),
 152                   std::make_pair(-1, 0));
 153   }
 154
 155   // iterators
 156   {
 157     test_axis_iterator(axis::integer<int>(0, 4), 0, 4);
 158     test_axis_iterator(axis::integer<double>(0, 4), 0, 4);
 159     test_axis_iterator(
 160         axis::integer<int, axis::null_type, axis::option::circular_t>(0, 4), 0, 4);
 161   }
 162
 163   // shrink and rebin
 164   {
 165     using A = axis::integer<>;
 166     auto a = A(-1, 5);
 167     auto b = A(a, 2, 5, 1);
 168     BOOST_TEST_EQ(b.size(), 3);
 169     BOOST_TEST_EQ(b.value(0), 1);
 170     BOOST_TEST_EQ(b.value(3), 4);
 171     auto c = A(a, 1, 5, 1);
 172     BOOST_TEST_EQ(c.size(), 4);
 173     BOOST_TEST_EQ(c.value(0), 0);
 174     BOOST_TEST_EQ(c.value(4), 4);
 175     auto e = A(a, 2, 5, 1);
 176     BOOST_TEST_EQ(e.size(), 3);
 177     BOOST_TEST_EQ(e.value(0), 1);
 178     BOOST_TEST_EQ(e.value(3), 4);
 179   }
 180
 181   // shrink and rebin with circular option
 182   {
 183     using A = axis::integer<int, axis::null_type, axis::option::circular_t>;
 184     auto a = A(1, 5);
 185     auto b = A(a, 0, 4, 1);
 186     BOOST_TEST_EQ(a, b);
 187     BOOST_TEST_THROWS(A(a, 1, 4, 1), std::invalid_argument);
 188     BOOST_TEST_THROWS(A(a, 0, 3, 1), std::invalid_argument);
 189     BOOST_TEST_THROWS(A(a, 0, 4, 2), std::invalid_argument);
 190   }
 191
 192   return boost::report_errors();
 193 }