boost/libs/range/test/adaptor_test/indexed.cpp

// Boost.Range library
//
//  Copyright Neil Groves 2014. Use, modification and
//  distribution is subject to 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)
//
//
// For more information, see http://www.boost.org/libs/range/
//
#include <boost/range/adaptor/indexed.hpp>

#include <boost/test/test_tools.hpp>
#include <boost/test/unit_test.hpp>

#include <boost/assign.hpp>
#include <boost/foreach.hpp>
#include <boost/range/algorithm_ext.hpp>
#include <boost/range/concepts.hpp>

#include <algorithm>
#include <list>
#include <vector>

#include "../test_utils.hpp"

namespace boost_range_test
{
    namespace
    {

template<typename Container, typename AdaptedRange>
void check_result(
    const Container&    reference_range,
    const AdaptedRange& adapted_range,
    std::ptrdiff_t      start_index
    )
{
    typedef typename boost::range_iterator<const Container>::type
                reference_iterator;

    typedef typename boost::range_iterator<const AdaptedRange>::type
                adapted_iterator;

    BOOST_REQUIRE_EQUAL(boost::size(reference_range),
                        boost::size(adapted_range));

    reference_iterator reference_it = boost::begin(reference_range);
    adapted_iterator adapted_it = boost::begin(adapted_range);
    for (std::ptrdiff_t i = start_index;
            reference_it != boost::end(reference_range);
            ++reference_it, ++adapted_it, ++i)
    {
        BOOST_CHECK_EQUAL(i, adapted_it->index());
        BOOST_CHECK_EQUAL(*reference_it, adapted_it->value());
    }
}

template<typename Container>
void indexed_test_impl(Container& c, std::ptrdiff_t start_index)
{
    // This is my preferred syntax using the | operator.
    check_result(c, c | boost::adaptors::indexed(), 0);
    check_result(c, c | boost::adaptors::indexed(start_index), start_index);

    // This is the function syntax
    check_result(c, boost::adaptors::index(c), 0);
    check_result(c, boost::adaptors::index(c, start_index), start_index);
}

template<typename Container>
void indexed_test_impl(Container& c)
{
    indexed_test_impl(c, 0);
    indexed_test_impl(c, -1);
    indexed_test_impl(c, 4);
}

template<typename Container>
void indexed_test_impl()
{
    using namespace boost::assign;

    Container c;

    // test empty container
    indexed_test_impl(c);

    // test one element
    c += 1;
    indexed_test_impl(c);

    // test many elements
    c += 1,2,2,2,3,4,4,4,4,5,6,7,8,9,9;
    indexed_test_impl(c);
}

template<typename Traversal, typename Range>
void check_traversal(const Range& rng)
{
    BOOST_STATIC_ASSERT(
        boost::is_convertible<
            typename boost::range_traversal<const Range>::type,
            Traversal
        >::value);
}

template<typename Traversal, typename Range>
void check_not_traversal(const Range& rng)
{
    BOOST_STATIC_ASSERT(
        !boost::is_convertible<
            typename boost::range_traversal<const Range>::type,
            Traversal
        >::value);
}

void indexed_test()
{
    indexed_test_impl< std::vector< int > >();
    indexed_test_impl< std::list< int > >();

    std::vector<int> vi;

    check_traversal<boost::random_access_traversal_tag>(
        vi | boost::adaptors::indexed());

    std::list<int> li;

    check_traversal<boost::forward_traversal_tag>(
        li | boost::adaptors::indexed());

    check_not_traversal<boost::bidirectional_traversal_tag>(
        li | boost::adaptors::indexed());

    check_not_traversal<boost::random_access_traversal_tag>(
        li | boost::adaptors::indexed());
}

    } // anonymous namesapce
} // namespace boost_range_test

boost::unit_test::test_suite*
init_unit_test_suite(int, char*[])
{
    boost::unit_test::test_suite* test
        = BOOST_TEST_SUITE( "Boost.Range indexed adaptor test suite" );

    test->add(BOOST_TEST_CASE(&boost_range_test::indexed_test));

    return test;
}