//
// Copyright 2010-2011 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#include <uhd/types/ranges.hpp>
#include <boost/test/unit_test.hpp>
#include <iostream>

using namespace uhd;

static const double tolerance = 0.001; // %


BOOST_AUTO_TEST_CASE(test_ranges_bounds)
{
    meta_range_t mr;
    mr.push_back(range_t(-1.0, +1.0, 0.1));
    BOOST_CHECK_CLOSE(mr.start(), -1.0, tolerance);
    BOOST_CHECK_CLOSE(mr.stop(), +1.0, tolerance);
    BOOST_CHECK_CLOSE(mr.step(), 0.1, tolerance);

    mr.push_back(range_t(40.0, 60.0, 1.0));
    BOOST_CHECK_CLOSE(mr.start(), -1.0, tolerance);
    BOOST_CHECK_CLOSE(mr.stop(), 60.0, tolerance);
    BOOST_CHECK_CLOSE(mr.step(), 0.1, tolerance);

    BOOST_CHECK_EQUAL(mr.size(), unsigned(2));

    BOOST_CHECK_CLOSE(mr[0].start(), -1.0, tolerance);
    BOOST_CHECK_CLOSE(mr[0].stop(), +1.0, tolerance);
    BOOST_CHECK_CLOSE(mr[0].step(), 0.1, tolerance);
}

BOOST_AUTO_TEST_CASE(test_ranges_clip)
{
    meta_range_t mr;
    mr.push_back(range_t(-1.0, +1.0, 0.1));
    mr.push_back(range_t(40.0, 60.0, 1.0));

    BOOST_CHECK_CLOSE(mr.clip(-30.0), -1.0, tolerance);
    BOOST_CHECK_CLOSE(mr.clip(70.0), 60.0, tolerance);
    BOOST_CHECK_CLOSE(mr.clip(20.0), 1.0, tolerance);
    BOOST_CHECK_CLOSE(mr.clip(50.0), 50.0, tolerance);

    BOOST_CHECK_CLOSE(mr.clip(50.9, false), 50.9, tolerance);
    BOOST_CHECK_CLOSE(mr.clip(50.9, true), 51.0, tolerance);
}

BOOST_AUTO_TEST_CASE(test_meta_range_t_ctor)
{
    meta_range_t mr1(0.0, 10.0, 1.0);
    BOOST_CHECK_CLOSE(mr1.clip(5.0), 5.0, tolerance);
    BOOST_CHECK_CLOSE(mr1.clip(11.0), 10.0, tolerance);
    BOOST_CHECK_CLOSE(mr1.clip(5.1, true), 5.0, tolerance);

    meta_range_t mr2(0.0, 10.0);
    BOOST_CHECK_CLOSE(mr2.clip(5.0), 5.0, tolerance);
    BOOST_CHECK_CLOSE(mr2.clip(11.0), 10.0, tolerance);
    BOOST_CHECK_CLOSE(mr2.clip(5.1, true), 5.1, tolerance);

    meta_range_t mr3(mr2.begin(), mr2.end());
    BOOST_CHECK_CLOSE(mr3.clip(5.0), 5.0, tolerance);
    BOOST_CHECK_CLOSE(mr3.clip(11.0), 10.0, tolerance);
    BOOST_CHECK_CLOSE(mr3.clip(5.1, true), 5.1, tolerance);
}

BOOST_AUTO_TEST_CASE(test_ranges_clip2)
{
    meta_range_t mr;
    mr.push_back(range_t(1.));
    mr.push_back(range_t(2.));
    mr.push_back(range_t(3.));

    BOOST_CHECK_CLOSE(mr.clip(2., true), 2., tolerance);
    BOOST_CHECK_CLOSE(mr.clip(0., true), 1., tolerance);
    BOOST_CHECK_CLOSE(mr.clip(1.2, true), 1., tolerance);
    BOOST_CHECK_CLOSE(mr.clip(3.1, true), 3., tolerance);
    BOOST_CHECK_CLOSE(mr.clip(4., true), 3., tolerance);
}

BOOST_AUTO_TEST_CASE(test_ranges_compare)
{
    range_t range(1);
    range_t n_range(1);
    range_t d_range(2);

    BOOST_CHECK(range == n_range);
    BOOST_CHECK(range != d_range);
}

BOOST_AUTO_TEST_CASE(test_meta_range_monotonize)
{
    // This meta_range is both not sorted and contains overlapping (and
    // fully contained) sub-ranges.
    meta_range_t mr;
    mr.push_back(range_t(3.0, 4.0));
    mr.push_back(range_t(1.0, 2.0));
    mr.push_back(range_t(2.1, 3.1));
    mr.push_back(range_t(1.4, 1.6));

    meta_range_t monotonic_mr = mr.as_monotonic();
    BOOST_CHECK(monotonic_mr.start() == 1.0);
    BOOST_CHECK(monotonic_mr.stop() == 4.0);

    BOOST_CHECK_CLOSE(monotonic_mr.at(0).start(), 1.0, tolerance);
    BOOST_CHECK_CLOSE(monotonic_mr.at(0).stop(), 2.0, tolerance);
    BOOST_CHECK_CLOSE(monotonic_mr.at(1).start(), 2.1, tolerance);
    BOOST_CHECK_CLOSE(monotonic_mr.at(1).stop(), 4.0, tolerance);
}

BOOST_AUTO_TEST_CASE(test_meta_range_init_braces)
{
    constexpr double max = 2949.12e6;

    meta_range_t mr(0.0, max);
    BOOST_CHECK_EQUAL(mr.start(), 0.0);
    BOOST_CHECK_CLOSE(mr.stop(), max, tolerance);
    BOOST_CHECK_CLOSE(mr.clip((mr.start() + mr.stop()) / 2.0), max / 2.0, tolerance);

    meta_range_t mr2{0.0, max};
    BOOST_CHECK_EQUAL(mr2.start(), 0.0);
    BOOST_CHECK_CLOSE(mr2.stop(), max, tolerance);
    BOOST_CHECK_CLOSE(mr2.clip((mr2.start() + mr2.stop()) / 2.0), max / 2.0, tolerance);
}

BOOST_AUTO_TEST_CASE(test_meta_range_init_list)
{
    meta_range_t mr{range_t(1.0, 2.0), range_t(3.0, 4.0)};
    BOOST_CHECK(mr.start() == 1.0);
    BOOST_CHECK(mr.stop() == 4.0);
    BOOST_CHECK_CLOSE(mr.clip(1.5), 1.5, tolerance);
    BOOST_CHECK_CLOSE(mr.clip(2.8), 3.0, tolerance);

    meta_range_t mr2{1.0, 2.25, 3.0, 4.0};
    BOOST_CHECK(mr2.start() == 1.0);
    BOOST_CHECK(mr2.stop() == 4.0);
    BOOST_CHECK_EQUAL(mr2.clip(2.0), 2.25);

    // test for two sub-ranges given by initializer list
    // This is not recommended notation, prefer the notation of mr above!
    meta_range_t mr3{{0, 100}, {200, 400}};
    BOOST_CHECK_EQUAL(mr3.start(), 0);
    BOOST_CHECK_EQUAL(mr3.stop(), 400);
    BOOST_CHECK_EQUAL(mr3.clip(110), 100);
    BOOST_CHECK_EQUAL(mr3.clip(160), 200);
}
