osrm-backend/unit_tests/util/packed_vector.cpp
Michael Bell 5d468f2897
Make edge metrics strongly typed (#6421)
This change takes the existing typedefs for weight, duration and
distance, and makes them proper types, using the existing Alias
functionality.

Primarily this is to prevent bugs where the metrics are switched,
but it also adds additional documentation. For example, it now
makes it clear (despite the naming of variables) that most of the
trip algorithm is running on the duration metric.

I've not made any changes to the casts performed between metrics
and numeric types, they now just more explicit.
2022-10-28 15:16:12 +01:00

278 lines
9.4 KiB
C++

#include "util/packed_vector.hpp"
#include "util/typedefs.hpp"
#include "common/range_tools.hpp"
#include <boost/range/adaptor/reversed.hpp>
#include <boost/range/any_range.hpp>
#include <boost/range/iterator_range.hpp>
#include <boost/test/unit_test.hpp>
#include <algorithm>
#include <numeric>
#include <random>
BOOST_AUTO_TEST_SUITE(packed_vector_test)
using namespace osrm;
using namespace osrm::util;
// Verify that the packed vector behaves as expected
BOOST_AUTO_TEST_CASE(insert_and_retrieve_packed_test)
{
PackedVector<OSMNodeID, 33> packed_ids;
std::vector<OSMNodeID> original_ids;
const constexpr std::size_t num_test_cases = 399;
const constexpr std::uint64_t max_id = (1ULL << 33) - 1;
std::mt19937 rng;
rng.seed(1337);
std::uniform_int_distribution<std::uint64_t> dist(0, max_id);
for (std::size_t i = 0; i < num_test_cases; i++)
{
OSMNodeID r{dist(rng)}; // max 33-bit uint
packed_ids.push_back(r);
original_ids.push_back(r);
}
for (std::size_t i = 0; i < num_test_cases; i++)
{
BOOST_CHECK_EQUAL(original_ids.at(i), packed_ids.at(i));
}
}
BOOST_AUTO_TEST_CASE(packed_vector_capacity_test)
{
PackedVector<OSMNodeID, 33> packed_vec;
const std::size_t original_size = packed_vec.capacity();
std::vector<OSMNodeID> dummy_vec;
BOOST_CHECK_EQUAL(original_size, dummy_vec.capacity());
packed_vec.reserve(100);
BOOST_CHECK(packed_vec.capacity() >= 100);
}
BOOST_AUTO_TEST_CASE(packed_vector_resize_test)
{
PackedVector<std::uint32_t, 33> packed_vec(100);
BOOST_CHECK_EQUAL(packed_vec.size(), 100);
packed_vec[99] = 1337;
packed_vec[0] = 42;
BOOST_CHECK_EQUAL(packed_vec[99], 1337u);
BOOST_CHECK_EQUAL(packed_vec[0], 42u);
}
BOOST_AUTO_TEST_CASE(packed_vector_iterator_test)
{
PackedVector<std::uint32_t, 33> packed_vec(100);
std::iota(packed_vec.begin(), packed_vec.end(), 0);
BOOST_CHECK(std::is_sorted(packed_vec.begin(), packed_vec.end()));
auto vec_idx = 0;
for (auto value : packed_vec)
{
BOOST_CHECK_EQUAL(packed_vec[vec_idx], value);
vec_idx++;
}
BOOST_CHECK_EQUAL(vec_idx, packed_vec.size());
auto range = boost::make_iterator_range(packed_vec.cbegin(), packed_vec.cend());
BOOST_CHECK_EQUAL(range.size(), packed_vec.size());
for (auto idx : util::irange<std::size_t>(0, packed_vec.size()))
{
BOOST_CHECK_EQUAL(packed_vec[idx], range[idx]);
}
auto reverse_range = boost::adaptors::reverse(
boost::make_iterator_range(packed_vec.cbegin(), packed_vec.cend()));
BOOST_CHECK_EQUAL(reverse_range.size(), packed_vec.size());
for (auto idx : util::irange<std::size_t>(0, packed_vec.size()))
{
BOOST_CHECK_EQUAL(packed_vec[packed_vec.size() - 1 - idx], reverse_range[idx]);
}
auto mut_range = boost::make_iterator_range(packed_vec.begin(), packed_vec.end());
BOOST_CHECK_EQUAL(range.size(), packed_vec.size());
for (auto idx : util::irange<std::size_t>(0, packed_vec.size()))
{
BOOST_CHECK_EQUAL(packed_vec[idx], mut_range[idx]);
}
auto mut_reverse_range =
boost::adaptors::reverse(boost::make_iterator_range(packed_vec.begin(), packed_vec.end()));
BOOST_CHECK_EQUAL(reverse_range.size(), packed_vec.size());
for (auto idx : util::irange<std::size_t>(0, packed_vec.size()))
{
BOOST_CHECK_EQUAL(packed_vec[packed_vec.size() - 1 - idx], mut_reverse_range[idx]);
}
}
BOOST_AUTO_TEST_CASE(packed_vector_10bit_small_test)
{
PackedVector<std::uint32_t, 10> vector = {10, 5, 8, 12, 254, 4, (1 << 10) - 1, 6};
std::vector<std::uint32_t> reference = {10, 5, 8, 12, 254, 4, (1 << 10) - 1, 6};
BOOST_CHECK_EQUAL(vector[0], reference[0]);
BOOST_CHECK_EQUAL(vector[1], reference[1]);
BOOST_CHECK_EQUAL(vector[2], reference[2]);
BOOST_CHECK_EQUAL(vector[3], reference[3]);
BOOST_CHECK_EQUAL(vector[4], reference[4]);
BOOST_CHECK_EQUAL(vector[5], reference[5]);
BOOST_CHECK_EQUAL(vector[6], reference[6]);
BOOST_CHECK_EQUAL(vector[7], reference[7]);
}
BOOST_AUTO_TEST_CASE(packed_vector_33bit_small_test)
{
std::vector<std::uint64_t> reference = {1597322404,
1939964443,
2112255763,
1432114613,
1067854538,
352118606,
1782436840,
1909002904,
165344818};
PackedVector<std::uint64_t, 33> vector = {1597322404,
1939964443,
2112255763,
1432114613,
1067854538,
352118606,
1782436840,
1909002904,
165344818};
BOOST_CHECK_EQUAL(vector[0], reference[0]);
BOOST_CHECK_EQUAL(vector[1], reference[1]);
BOOST_CHECK_EQUAL(vector[2], reference[2]);
BOOST_CHECK_EQUAL(vector[3], reference[3]);
BOOST_CHECK_EQUAL(vector[4], reference[4]);
BOOST_CHECK_EQUAL(vector[5], reference[5]);
BOOST_CHECK_EQUAL(vector[6], reference[6]);
BOOST_CHECK_EQUAL(vector[7], reference[7]);
}
BOOST_AUTO_TEST_CASE(values_overflow)
{
const std::uint64_t mask = (1ull << 42) - 1;
PackedVector<std::uint64_t, 42> vector(52, 0);
for (auto it = vector.begin(); it != vector.end(); ++it)
{
BOOST_CHECK_EQUAL(*it, 0);
}
std::uint64_t value = 1;
for (auto it = vector.begin(); it != vector.end(); ++it)
{
BOOST_CHECK_EQUAL(*it, 0);
*it = value;
BOOST_CHECK_EQUAL(*it, value & mask);
value <<= 1;
}
for (auto it = vector.rbegin(); it != vector.rend(); ++it)
{
value >>= 1;
BOOST_CHECK_EQUAL(*it, value & mask);
}
for (auto it = vector.cbegin(); it != vector.cend(); ++it)
{
BOOST_CHECK_EQUAL(*it, value & mask);
value <<= 1;
}
}
BOOST_AUTO_TEST_CASE(packed_vector_33bit_continious)
{
PackedVector<std::uint64_t, 33> vector;
for (std::uint64_t i : osrm::util::irange(0, 400))
{
vector.push_back(i);
BOOST_CHECK_EQUAL(vector.back(), i);
}
}
BOOST_AUTO_TEST_CASE(packed_weights_container_with_type_erasure)
{
using Vector = PackedVector<SegmentWeight, SEGMENT_WEIGHT_BITS>;
using WeightsAnyRange = boost::any_range<SegmentWeight,
boost::random_access_traversal_tag,
const typename Vector::internal_reference,
std::ptrdiff_t>;
PackedVector<SegmentWeight, SEGMENT_WEIGHT_BITS> vector(7);
std::iota(vector.begin(), vector.end(), SegmentWeight{0});
auto forward = boost::make_iterator_range(vector.begin() + 1, vector.begin() + 6);
auto forward_any = WeightsAnyRange(forward.begin(), forward.end());
CHECK_EQUAL_RANGE(forward,
SegmentWeight{1},
SegmentWeight{2},
SegmentWeight{3},
SegmentWeight{4},
SegmentWeight{5});
CHECK_EQUAL_RANGE(forward_any,
SegmentWeight{1},
SegmentWeight{2},
SegmentWeight{3},
SegmentWeight{4},
SegmentWeight{5});
auto reverse = boost::adaptors::reverse(forward);
auto reverse_any = WeightsAnyRange(reverse);
CHECK_EQUAL_RANGE(reverse,
SegmentWeight{5},
SegmentWeight{4},
SegmentWeight{3},
SegmentWeight{2},
SegmentWeight{1});
CHECK_EQUAL_RANGE(reverse_any,
SegmentWeight{5},
SegmentWeight{4},
SegmentWeight{3},
SegmentWeight{2},
SegmentWeight{1});
}
BOOST_AUTO_TEST_CASE(packed_weights_view_with_type_erasure)
{
using View = PackedVectorView<SegmentWeight, SEGMENT_WEIGHT_BITS>;
using PackedDataWord = std::uint64_t; // PackedVectorView<>::WordT
using WeightsAnyRange = boost::any_range<SegmentWeight,
boost::random_access_traversal_tag,
const typename View::internal_reference,
std::ptrdiff_t>;
PackedDataWord data[] = {0x200000400000, 0xc, 0};
View view(vector_view<PackedDataWord>(data, 3), 7);
auto forward = boost::make_iterator_range(view.begin() + 1, view.begin() + 4);
auto forward_any = WeightsAnyRange(forward.begin(), forward.end());
CHECK_EQUAL_RANGE(forward, SegmentWeight{1}, SegmentWeight{2}, SegmentWeight{3});
CHECK_EQUAL_RANGE(forward_any, SegmentWeight{1}, SegmentWeight{2}, SegmentWeight{3});
auto reverse = boost::adaptors::reverse(forward);
auto reverse_any = WeightsAnyRange(reverse);
CHECK_EQUAL_RANGE(reverse, SegmentWeight{3}, SegmentWeight{2}, SegmentWeight{1});
CHECK_EQUAL_RANGE(reverse_any, SegmentWeight{3}, SegmentWeight{2}, SegmentWeight{1});
}
BOOST_AUTO_TEST_SUITE_END()