// Copyright 2015-2016 Hans Dembinski
//
// 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)

#define BOOST_TEST_MODULE histogram_test
#include <boost/test/unit_test.hpp>
#include <boost/test/test_tools.hpp>
#include <boost/histogram/histogram.hpp>
#include <boost/histogram/static_storage.hpp>
#include <boost/histogram/dynamic_storage.hpp>
#include <boost/histogram/axis_ostream_operators.hpp>
#include <limits>
#include <sstream>
using namespace boost::histogram;

BOOST_AUTO_TEST_CASE(init_0)
{
    auto h = histogram();
    BOOST_CHECK_EQUAL(h.dim(), 0);
    BOOST_CHECK_EQUAL(h.size(), 0);
    auto h2 = histogram_t<Dynamic>();
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(init_1)
{
    auto h = histogram(regular_axis{3, -1, 1});
    BOOST_CHECK_EQUAL(h.dim(), 1);
    BOOST_CHECK_EQUAL(h.size(), 5);
    BOOST_CHECK_EQUAL(h.shape(0), 5);
    auto h2 = histogram_t<Dynamic>(regular_axis{3, -1, 1});
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(init_2)
{
    auto h = histogram(regular_axis{3, -1, 1},
                       integer_axis{-1, 1});
    BOOST_CHECK_EQUAL(h.dim(), 2);
    BOOST_CHECK_EQUAL(h.size(), 25);
    BOOST_CHECK_EQUAL(h.shape(0), 5);
    BOOST_CHECK_EQUAL(h.shape(1), 5);
    auto h2 = histogram_t<Dynamic>(regular_axis{3, -1, 1},
                                   integer_axis{-1, 1});
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(init_3)
{
    auto h = histogram(regular_axis{3, -1, 1},
                       integer_axis{-1, 1},
                       polar_axis{3});
    BOOST_CHECK_EQUAL(h.dim(), 3);
    BOOST_CHECK_EQUAL(h.size(), 75);
    auto h2 = histogram_t<Dynamic>(regular_axis{3, -1, 1},
                                   integer_axis{-1, 1},
                                   polar_axis{3});
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(init_4)
{
    auto h = histogram(regular_axis{3, -1, 1},
                       integer_axis{-1, 1},
                       polar_axis{3},
                       variable_axis{-1, 0, 1});
    BOOST_CHECK_EQUAL(h.dim(), 4);
    BOOST_CHECK_EQUAL(h.size(), 300);
    auto h2 = histogram_t<Dynamic>(regular_axis{3, -1, 1},
                                   integer_axis{-1, 1},
                                   polar_axis{3},
                                   variable_axis{-1, 0, 1});
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(init_5)
{
    auto h = histogram(regular_axis{3, -1, 1},
                       integer_axis{-1, 1},
                       polar_axis{3},
                       variable_axis{-1, 0, 1},
                       category_axis{"A", "B", "C"});
    BOOST_CHECK_EQUAL(h.dim(), 5);
    BOOST_CHECK_EQUAL(h.size(), 900);
    auto h2 = histogram_t<Dynamic>(regular_axis{3, -1, 1},
                                   integer_axis{-1, 1},
                                   polar_axis{3},
                                   variable_axis{-1, 0, 1},
                                   category_axis{"A", "B", "C"});
    BOOST_CHECK(h2 == h);
}

BOOST_AUTO_TEST_CASE(copy_ctor)
{
    auto h = histogram(integer_axis(0, 1),
                       integer_axis(0, 1));
    h.fill(0, 0);
    auto h2 = histogram_t<2>(h);
    BOOST_CHECK(h2 == h);
    auto h3 = histogram_t<Dynamic>(h);
    BOOST_CHECK(h3 == h);
}

BOOST_AUTO_TEST_CASE(copy_assign)
{
    auto h = histogram(regular_axis(1, -1, 1),
                       regular_axis(2, -2, 2));
    h.fill(0.0, 0.0);
    auto h2 = histogram_t<2>();
    BOOST_CHECK(!(h == h2));
    h2 = h;
    BOOST_CHECK(h == h2);
    // test self-assign
    h2 = h2;
    BOOST_CHECK(h == h2);
    auto h3 = histogram_t<Dynamic>();
    h3 = h;
    BOOST_CHECK(h == h3);
}

BOOST_AUTO_TEST_CASE(move_ctor)
{
    auto h = histogram(regular_axis(1, -1, 1),
                       regular_axis(2, -2, 2));
    h.fill(0.0, 0.0);
    const auto href = h;
    auto h2 = histogram_t<2>(std::move(h));
    BOOST_CHECK_EQUAL(h.dim(), 2);
    BOOST_CHECK_EQUAL(h.sum(), 0);
    BOOST_CHECK_EQUAL(h.size(), 0);
    BOOST_CHECK(h2 == href);
    auto h3 = histogram_t<Dynamic>(std::move(h2));
    BOOST_CHECK_EQUAL(h2.dim(), 2);
    BOOST_CHECK_EQUAL(h2.sum(), 0);
    BOOST_CHECK_EQUAL(h2.size(), 0);
    BOOST_CHECK(h3 == href);
}

BOOST_AUTO_TEST_CASE(move_assign)
{
    auto h = histogram(regular_axis(1, -1, 1),
                       regular_axis(2, -2, 2));
    h.fill(0.0, 0.0);
    auto href = h;
    auto h2 = histogram_t<2>();
    h2 = std::move(h);
    BOOST_CHECK(h2 == href);
    BOOST_CHECK_EQUAL(h.dim(), 2);
    BOOST_CHECK_EQUAL(h.sum(), 0);
    BOOST_CHECK_EQUAL(h.size(), 0);
    auto h3 = histogram_t<Dynamic>();
    h3 = std::move(h2);
    BOOST_CHECK_EQUAL(h2.dim(), 2);
    BOOST_CHECK_EQUAL(h2.sum(), 0);
    BOOST_CHECK_EQUAL(h2.size(), 0);
    BOOST_CHECK(h3 == href);
}

BOOST_AUTO_TEST_CASE(equal_compare)
{
    auto a = histogram_t<1>(integer_axis(0, 1));
    auto b = histogram_t<2>(integer_axis(0, 1), integer_axis(0, 1));
    BOOST_CHECK(!(a == b));
    BOOST_CHECK(!(b == a));
    auto c = histogram_t<Dynamic>(integer_axis(0, 1));
    BOOST_CHECK(!(b == c));
    BOOST_CHECK(!(c == b));
    BOOST_CHECK(a == c);
    BOOST_CHECK(c == a);
    auto d = histogram_t<Dynamic>(regular_axis(2, 0, 1));
    BOOST_CHECK(!(c == d));
    BOOST_CHECK(!(d == c));
    c.fill(0);
    BOOST_CHECK(!(a == c));
    BOOST_CHECK(!(c == a));
    a.fill(0);
    BOOST_CHECK(a == c);
    BOOST_CHECK(c == a);
    a.fill(0);
    BOOST_CHECK(!(a == c));
    BOOST_CHECK(!(c == a));
}

BOOST_AUTO_TEST_CASE(d1)
{
    auto h = histogram(integer_axis(0, 1));
    h.fill(0);
    h.fill(-0.0);
    h.fill(-1.0);
    h.fill(10.0);

    BOOST_CHECK_EQUAL(h.dim(), 1);
    BOOST_CHECK_EQUAL(h.bins(0), 2);
    BOOST_CHECK_EQUAL(h.shape(0), 4);
    BOOST_CHECK_EQUAL(h.sum(), 4);

    BOOST_CHECK_THROW(h.value(-2), std::out_of_range);
    BOOST_CHECK_EQUAL(h.value(-1), 1.0);
    BOOST_CHECK_EQUAL(h.value(0), 2.0);
    BOOST_CHECK_EQUAL(h.value(1), 0.0);
    BOOST_CHECK_EQUAL(h.value(2), 1.0);
    BOOST_CHECK_THROW(h.value(3), std::out_of_range);

    BOOST_CHECK_THROW(h.variance(-2), std::out_of_range);
    BOOST_CHECK_EQUAL(h.variance(-1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(0), 2.0);
    BOOST_CHECK_EQUAL(h.variance(1), 0.0);
    BOOST_CHECK_EQUAL(h.variance(2), 1.0);
    BOOST_CHECK_THROW(h.variance(3), std::out_of_range);
}

BOOST_AUTO_TEST_CASE(d1_2)
{
    auto h = histogram(integer_axis(0, 1, "", false));
    h.fill(0);
    h.fill(-0.0);
    h.fill(-1.0);
    h.fill(10.0);

    BOOST_CHECK_EQUAL(h.dim(), 1);
    BOOST_CHECK_EQUAL(h.bins(0), 2);
    BOOST_CHECK_EQUAL(h.shape(0), 2);
    BOOST_CHECK_EQUAL(h.sum(), 2);

    BOOST_CHECK_THROW(h.value(-1), std::out_of_range);
    BOOST_CHECK_EQUAL(h.value(0), 2.0);
    BOOST_CHECK_EQUAL(h.value(1), 0.0);
    BOOST_CHECK_THROW(h.value(2), std::out_of_range);

    BOOST_CHECK_THROW(h.variance(-1), std::out_of_range);
    BOOST_CHECK_EQUAL(h.variance(0), 2.0);
    BOOST_CHECK_EQUAL(h.variance(1), 0.0);
    BOOST_CHECK_THROW(h.variance(2), std::out_of_range);
}

BOOST_AUTO_TEST_CASE(d1w)
{
    auto h = histogram(regular_axis(2, -1, 1));
    h.fill(0);
    h.wfill(-1.0, 2.0);
    h.fill(-1.0);
    h.fill(-2.0);
    h.wfill(10.0, 5.0);

    BOOST_CHECK_EQUAL(h.sum(), 10);

    BOOST_CHECK_EQUAL(h.value(-1), 1.0);
    BOOST_CHECK_EQUAL(h.value(0), 3.0);
    BOOST_CHECK_EQUAL(h.value(1), 1.0);
    BOOST_CHECK_EQUAL(h.value(2), 5.0);

    BOOST_CHECK_EQUAL(h.variance(-1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(0), 5.0);
    BOOST_CHECK_EQUAL(h.variance(1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(2), 25.0);
}

BOOST_AUTO_TEST_CASE(d2)
{
    auto h = histogram(regular_axis(2, -1, 1),
                       integer_axis(-1, 1, std::string(), false));
    h.fill(-1, -1);
    h.fill(-1, 0);
    h.fill(-1, -10);
    h.fill(-10, 0);

    BOOST_CHECK_EQUAL(h.dim(), 2);
    BOOST_CHECK_EQUAL(h.bins(0), 2);
    BOOST_CHECK_EQUAL(h.shape(0), 4);
    BOOST_CHECK_EQUAL(h.bins(1), 3);
    BOOST_CHECK_EQUAL(h.shape(1), 3);
    BOOST_CHECK_EQUAL(h.sum(), 3);

    BOOST_CHECK_EQUAL(h.value(-1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(-1, 1), 1.0);
    BOOST_CHECK_EQUAL(h.value(-1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(0, 0), 1.0);
    BOOST_CHECK_EQUAL(h.value(0, 1), 1.0);
    BOOST_CHECK_EQUAL(h.value(0, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(1, 1), 0.0);
    BOOST_CHECK_EQUAL(h.value(1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(2, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(2, 1), 0.0);
    BOOST_CHECK_EQUAL(h.value(2, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(-1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(-1, 1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(-1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(0, 0), 1.0);
    BOOST_CHECK_EQUAL(h.variance(0, 1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(0, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(1, 1), 0.0);
    BOOST_CHECK_EQUAL(h.variance(1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(2, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(2, 1), 0.0);
    BOOST_CHECK_EQUAL(h.variance(2, 2), 0.0);
}

BOOST_AUTO_TEST_CASE(d2w)
{
    auto h = histogram(regular_axis(2, -1, 1),
                       integer_axis(-1, 1, std::string(), false));
    h.fill(-1, 0);       // -> 0, 1
    h.wfill(-1, -1, 10); // -> 0, 0
    h.wfill(-1, -10, 5); // is ignored
    h.wfill(-10, 0, 7);  // -> -1, 1

    BOOST_CHECK_EQUAL(h.sum(), 18);

    BOOST_CHECK_EQUAL(h.value(-1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(-1, 1), 7.0);
    BOOST_CHECK_EQUAL(h.value(-1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(0, 0), 10.0);
    BOOST_CHECK_EQUAL(h.value(0, 1), 1.0);
    BOOST_CHECK_EQUAL(h.value(0, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(1, 1), 0.0);
    BOOST_CHECK_EQUAL(h.value(1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.value(2, 0), 0.0);
    BOOST_CHECK_EQUAL(h.value(2, 1), 0.0);
    BOOST_CHECK_EQUAL(h.value(2, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(-1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(-1, 1), 49.0);
    BOOST_CHECK_EQUAL(h.variance(-1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(0, 0), 100.0);
    BOOST_CHECK_EQUAL(h.variance(0, 1), 1.0);
    BOOST_CHECK_EQUAL(h.variance(0, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(1, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(1, 1), 0.0);
    BOOST_CHECK_EQUAL(h.variance(1, 2), 0.0);

    BOOST_CHECK_EQUAL(h.variance(2, 0), 0.0);
    BOOST_CHECK_EQUAL(h.variance(2, 1), 0.0);
    BOOST_CHECK_EQUAL(h.variance(2, 2), 0.0);
}

BOOST_AUTO_TEST_CASE(add_0)
{
    auto a = histogram(integer_axis(-1, 1));
    auto b = histogram(regular_axis(3, -1, 1));
    BOOST_CHECK_THROW(a + b, std::logic_error);
}

BOOST_AUTO_TEST_CASE(add_1)
{
    auto a = histogram(integer_axis(-1, 1));
    auto b = histogram(integer_axis(-1, 1));
    a.fill(-1);
    b.fill(1);
    auto c = a;
    c += b;
    BOOST_CHECK_EQUAL(c.value(-1), 0);
    BOOST_CHECK_EQUAL(c.value(0), 1);
    BOOST_CHECK_EQUAL(c.value(1), 0);
    BOOST_CHECK_EQUAL(c.value(2), 1);
    BOOST_CHECK_EQUAL(c.value(3), 0);
    auto d = a + b;
    BOOST_CHECK_EQUAL(d.value(-1), 0);
    BOOST_CHECK_EQUAL(d.value(0), 1);
    BOOST_CHECK_EQUAL(d.value(1), 0);
    BOOST_CHECK_EQUAL(d.value(2), 1);
    BOOST_CHECK_EQUAL(d.value(3), 0);
}

BOOST_AUTO_TEST_CASE(add_2w)
{
    auto a = histogram(integer_axis(-1, 1));
    auto b = histogram(integer_axis(-1, 1));

    a.fill(0);
    b.wfill(-1, 3);
    auto c = a;
    c += b;
    BOOST_CHECK_EQUAL(c.value(-1), 0);
    BOOST_CHECK_EQUAL(c.value(0), 3);
    BOOST_CHECK_EQUAL(c.value(1), 1);
    BOOST_CHECK_EQUAL(c.value(2), 0);
    BOOST_CHECK_EQUAL(c.value(3), 0);    
    auto d = a + b;
    BOOST_CHECK_EQUAL(d.value(-1), 0);
    BOOST_CHECK_EQUAL(d.value(0), 3);
    BOOST_CHECK_EQUAL(d.value(1), 1);
    BOOST_CHECK_EQUAL(d.value(2), 0);
    BOOST_CHECK_EQUAL(d.value(3), 0);
}

BOOST_AUTO_TEST_CASE(add_3)
{
    auto a = histogram_t<1, dynamic_storage>(integer_axis(-1, 1));
    auto b = histogram_t<1, static_storage<int>>(integer_axis(-1, 1));
    a.fill(-1);
    b.fill(1);
    auto c = a;
    c += b;
    BOOST_CHECK_EQUAL(c.value(-1), 0);
    BOOST_CHECK_EQUAL(c.value(0), 1);
    BOOST_CHECK_EQUAL(c.value(1), 0);
    BOOST_CHECK_EQUAL(c.value(2), 1);
    BOOST_CHECK_EQUAL(c.value(3), 0);
    auto d = a + b;
    BOOST_CHECK_EQUAL(d.value(-1), 0);
    BOOST_CHECK_EQUAL(d.value(0), 1);
    BOOST_CHECK_EQUAL(d.value(1), 0);
    BOOST_CHECK_EQUAL(d.value(2), 1);
    BOOST_CHECK_EQUAL(d.value(3), 0);
}

BOOST_AUTO_TEST_CASE(add_4)
{
    auto a = histogram_t<1, static_storage<char>>(integer_axis(-1, 1));
    auto b = histogram_t<1, static_storage<int>>(integer_axis(-1, 1));
    a.fill(-1);
    b.fill(1);
    auto c = a;
    c += b;
    BOOST_CHECK_EQUAL(c.value(-1), 0);
    BOOST_CHECK_EQUAL(c.value(0), 1);
    BOOST_CHECK_EQUAL(c.value(1), 0);
    BOOST_CHECK_EQUAL(c.value(2), 1);
    BOOST_CHECK_EQUAL(c.value(3), 0);
    auto d = a + b;
    BOOST_CHECK_EQUAL(d.value(-1), 0);
    BOOST_CHECK_EQUAL(d.value(0), 1);
    BOOST_CHECK_EQUAL(d.value(1), 0);
    BOOST_CHECK_EQUAL(d.value(2), 1);
    BOOST_CHECK_EQUAL(d.value(3), 0);
}

BOOST_AUTO_TEST_CASE(doc_example_0)
{
    namespace bh = boost::histogram;

    // create 1d-histogram with 10 equidistant bins from -1.0 to 2.0,
    // with axis of histogram labeled as "x"
    auto h = bh::histogram(bh::regular_axis(10, -1.0, 2.0, "x"));

    // fill histogram with data
    h.fill(-1.5); // put in underflow bin
    h.fill(-1.0); // included in first bin, bin interval is semi-open
    h.fill(-0.5);
    h.fill(1.1);
    h.fill(0.3);
    h.fill(1.7);
    h.fill(2.0);  // put in overflow bin, bin interval is semi-open
    h.fill(20.0); // put in overflow bin
    h.wfill(0.1, 5.0); // fill with a weighted entry, weight is 5.0

    std::ostringstream os1;
    // access histogram counts
    for (int i = -1; i <= h.bins(0); ++i) {
        const bh::regular_axis& a = h.axis<bh::regular_axis>(0);
        os1 << "bin " << i
            << " x in [" << a[i] << ", " << a[i+1] << "): "
            << h.value(i) << " +/- " << std::sqrt(h.variance(i))
            << "\n";
    }

    std::ostringstream os2;
    os2 << "bin -1 x in [-inf, -1): 1 +/- 1\n"
           "bin 0 x in [-1, -0.7): 1 +/- 1\n"
           "bin 1 x in [-0.7, -0.4): 1 +/- 1\n"
           "bin 2 x in [-0.4, -0.1): 0 +/- 0\n"
           "bin 3 x in [-0.1, 0.2): 5 +/- 5\n"
           "bin 4 x in [0.2, 0.5): 1 +/- 1\n"
           "bin 5 x in [0.5, 0.8): 0 +/- 0\n"
           "bin 6 x in [0.8, 1.1): 0 +/- 0\n"
           "bin 7 x in [1.1, 1.4): 1 +/- 1\n"
           "bin 8 x in [1.4, 1.7): 0 +/- 0\n"
           "bin 9 x in [1.7, 2): 1 +/- 1\n"
           "bin 10 x in [2, inf): 2 +/- 1.41421\n";

    BOOST_CHECK_EQUAL(os1.str(), os2.str());
}