////////////////////////////////////////////////////////////////////////////// // // (C) Copyright Ion Gaztanaga 2025-2026. 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) // // See http://www.boost.org/libs/container for documentation. // ////////////////////////////////////////////////////////////////////////////// #include #include #include "segmented_test_helper.hpp" #include using namespace boost::container; void test_remove_copy_segmented() { test_detail::seg_vector sv; int a1[] = {1, 2, 3}; int a2[] = {2, 4, 2}; int a3[] = {5, 2}; sv.add_segment_range(a1, a1 + 3); sv.add_segment_range(a2, a2 + 3); sv.add_segment_range(a3, a3 + 2); boost::container::vector out(8, 0); boost::container::vector::iterator r = segmented_remove_copy(sv.begin(), sv.end(), out.begin(), 2); int expected[] = {1, 3, 4, 5}; std::size_t count = static_cast(r - out.begin()); BOOST_TEST_EQ(count, 4u); for(std::size_t i = 0; i < count; ++i) BOOST_TEST_EQ(out[i], expected[i]); } void test_remove_copy_empty() { test_detail::seg_vector sv; boost::container::vector out; boost::container::vector::iterator r = segmented_remove_copy(sv.begin(), sv.end(), out.begin(), 0); BOOST_TEST(r == out.begin()); } void test_remove_copy_none_removed() { test_detail::seg_vector sv; int a[] = {1, 3, 5}; sv.add_segment_range(a, a + 3); boost::container::vector out(3, 0); boost::container::vector::iterator r = segmented_remove_copy(sv.begin(), sv.end(), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 3u); BOOST_TEST_EQ(out[0], 1); BOOST_TEST_EQ(out[1], 3); BOOST_TEST_EQ(out[2], 5); } void test_remove_copy_non_segmented() { int src[] = {1, 2, 3, 2, 4}; boost::container::vector v(src, src + 5); boost::container::vector out(5, 0); boost::container::vector::iterator r = segmented_remove_copy(v.begin(), v.end(), out.begin(), 2); std::size_t count = static_cast(r - out.begin()); BOOST_TEST_EQ(count, 3u); BOOST_TEST_EQ(out[0], 1); BOOST_TEST_EQ(out[1], 3); BOOST_TEST_EQ(out[2], 4); } void test_remove_copy_sentinel_segmented() { test_detail::seg_vector sv; int a1[] = {1, 2, 3}; int a2[] = {2, 4, 2}; int a3[] = {5, 2}; sv.add_segment_range(a1, a1 + 3); sv.add_segment_range(a2, a2 + 3); sv.add_segment_range(a3, a3 + 2); boost::container::vector out(8, 0); boost::container::vector::iterator r = segmented_remove_copy(sv.begin(), test_detail::make_sentinel(sv.end()), out.begin(), 2); int expected[] = {1, 3, 4, 5}; std::size_t count = static_cast(r - out.begin()); BOOST_TEST_EQ(count, 4u); for(std::size_t i = 0; i < count; ++i) BOOST_TEST_EQ(out[i], expected[i]); } void test_remove_copy_sentinel_non_segmented() { int src[] = {1, 2, 3, 2, 4}; boost::container::vector v(src, src + 5); boost::container::vector out(5, 0); boost::container::vector::iterator r = segmented_remove_copy(v.begin(), test_detail::make_sentinel(v.end()), out.begin(), 2); std::size_t count = static_cast(r - out.begin()); BOOST_TEST_EQ(count, 3u); BOOST_TEST_EQ(out[0], 1); BOOST_TEST_EQ(out[1], 3); BOOST_TEST_EQ(out[2], 4); } void test_remove_copy_seg2() { test_detail::seg2_vector sv2; int a1[] = {1, 2, 3}; int a2[] = {2, 4, 2}; int a3[] = {5, 2}; sv2.add_flat_segment_range(a1, a1 + 3); sv2.add_flat_segment_range(a2, a2 + 3); sv2.add_flat_segment_range(a3, a3 + 2); boost::container::vector out(8, 0); boost::container::vector::iterator r = segmented_remove_copy(sv2.begin(), sv2.end(), out.begin(), 2); int expected[] = {1, 3, 4, 5}; std::size_t count = static_cast(r - out.begin()); BOOST_TEST_EQ(count, 4u); for(std::size_t i = 0; i < count; ++i) BOOST_TEST_EQ(out[i], expected[i]); } void test_remove_copy_single_segment_whole() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6}; sv.add_segment_range(a, a + 6); boost::container::vector out(6, 0); boost::container::vector::iterator r = segmented_remove_copy(sv.begin(), sv.end(), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 4u); BOOST_TEST_EQ(out[0], 1); BOOST_TEST_EQ(out[1], 3); BOOST_TEST_EQ(out[2], 4); BOOST_TEST_EQ(out[3], 6); BOOST_TEST_EQ(out[4], 0); } void test_remove_copy_single_segment_interior() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6}; sv.add_segment_range(a, a + 6); boost::container::vector out(6, 0); boost::container::vector::iterator r = segmented_remove_copy(test_detail::iter_at(sv, 1), test_detail::iter_at(sv, 5), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 2u); BOOST_TEST_EQ(out[0], 3); BOOST_TEST_EQ(out[1], 4); BOOST_TEST_EQ(out[2], 0); BOOST_TEST_EQ(out[3], 0); } void test_remove_copy_single_segment_empty_mid() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6}; sv.add_segment_range(a, a + 6); test_detail::seg_vector::iterator mid = test_detail::iter_at(sv, 3); boost::container::vector out(3, 99); boost::container::vector::iterator r = segmented_remove_copy(mid, mid, out.begin(), 2); BOOST_TEST(r == out.begin()); BOOST_TEST_EQ(out[0], 99); BOOST_TEST_EQ(out[1], 99); BOOST_TEST_EQ(out[2], 99); } void test_remove_copy_single_segment_sentinel() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6}; sv.add_segment_range(a, a + 6); boost::container::vector out(6, 0); boost::container::vector::iterator r = segmented_remove_copy(test_detail::iter_at(sv, 1), test_detail::make_sentinel(test_detail::iter_at(sv, 5)), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 2u); BOOST_TEST_EQ(out[0], 3); BOOST_TEST_EQ(out[1], 4); BOOST_TEST_EQ(out[2], 0); } void test_remove_copy_single_segment_seg2_outer() { test_detail::seg2_vector sv2; test_detail::seg_vector inner; int a1[] = {1, 2, 3}; int a2[] = {4, 2}; int a3[] = {6, 7}; inner.add_segment_range(a1, a1 + 3); inner.add_segment_range(a2, a2 + 2); inner.add_segment_range(a3, a3 + 2); sv2.add_segment(inner); boost::container::vector out(8, 0); boost::container::vector::iterator r = segmented_remove_copy(test_detail::iter_at(sv2, 1), test_detail::iter_at(sv2, 6), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 3u); BOOST_TEST_EQ(out[0], 3); BOOST_TEST_EQ(out[1], 4); BOOST_TEST_EQ(out[2], 6); BOOST_TEST_EQ(out[3], 0); } void test_remove_copy_single_segment_seg2_both() { test_detail::seg2_vector sv2; test_detail::seg_vector inner; int a[] = {1, 2, 3, 4, 2, 6}; inner.add_segment_range(a, a + 6); sv2.add_segment(inner); boost::container::vector out(6, 0); boost::container::vector::iterator r = segmented_remove_copy(test_detail::iter_at(sv2, 1), test_detail::iter_at(sv2, 5), out.begin(), 2); BOOST_TEST_EQ(static_cast(r - out.begin()), 2u); BOOST_TEST_EQ(out[0], 3); BOOST_TEST_EQ(out[1], 4); BOOST_TEST_EQ(out[2], 0); } void test_remove_copy_single_segment_src_multi_dst() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6, 7, 8}; sv.add_segment_range(a, a + 8); test_detail::seg_vector out; out.add_segment(2, 0); out.add_segment(3, 0); typedef test_detail::seg_vector::iterator iter_t; iter_t r = segmented_remove_copy(test_detail::iter_at(sv, 1), test_detail::iter_at(sv, 7), out.begin(), 2); BOOST_TEST(r == test_detail::iter_at(out, 4)); int expected[] = {3, 4, 6, 7}; iter_t it = out.begin(); for(int i = 0; i < 4; ++i, ++it) BOOST_TEST_EQ(*it, expected[i]); BOOST_TEST_EQ(*it, 0); } void test_remove_copy_single_segment_src_and_dst() { test_detail::seg_vector sv; int a[] = {1, 2, 3, 4, 2, 6}; sv.add_segment_range(a, a + 6); test_detail::seg_vector out; out.add_segment(4, 0); typedef test_detail::seg_vector::iterator iter_t; iter_t r = segmented_remove_copy(test_detail::iter_at(sv, 1), test_detail::iter_at(sv, 5), out.begin(), 2); BOOST_TEST(r == test_detail::iter_at(out, 2)); iter_t it = out.begin(); BOOST_TEST_EQ(*it, 3); ++it; BOOST_TEST_EQ(*it, 4); ++it; BOOST_TEST_EQ(*it, 0); ++it; BOOST_TEST_EQ(*it, 0); } void test_remove_copy_single_segment_dst_from_flat() { int src[] = {1, 2, 3, 2, 4}; boost::container::vector v(src, src + 5); test_detail::seg_vector out; out.add_segment(5, 0); typedef test_detail::seg_vector::iterator iter_t; iter_t r = segmented_remove_copy(v.begin(), v.end(), out.begin(), 2); BOOST_TEST(r == test_detail::iter_at(out, 3)); iter_t it = out.begin(); BOOST_TEST_EQ(*it, 1); ++it; BOOST_TEST_EQ(*it, 3); ++it; BOOST_TEST_EQ(*it, 4); ++it; BOOST_TEST_EQ(*it, 0); ++it; BOOST_TEST_EQ(*it, 0); } ////////////////////////////////////////////////////////////////////////////// // Shape matrix. // // for_each_shape2_all crosses the twelve branch specs of the source range with // the twelve of the destination, at both segmentation depths, so the two // segmentations vary independently. The 'e' specs carry empty segments, which // is the only way into the sfirst == slast branch of // segmented_remove_copy_dst_bounded with an empty destination segment. // // The output length is data dependent, so each source size is run against a // destination sized to exactly the number of survivors, which puts the guard // immediately after the last slot the algorithm may write, and against one // with three spare slots, which pins the slots it must leave alone. The guard // value differs from the removed value, so a read one past the end of the // source would copy the guard and be caught by the exact-size form. // // The reference answer is filtered out of flatten_n_ints over the logical // source range, not flatten_all_ints, which deliberately includes the guard. ////////////////////////////////////////////////////////////////////////////// const int shape_removed = 2; // the value handed to segmented_remove_copy const int shape_filler = -998; // guard just past the end of every range const int shape_fill = -1; // every destination slot before the call const int shape_dst_vals[] = {-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1}; std::size_t shape_survivor_count(const int* v, std::size_t n) { std::size_t c = 0; for(std::size_t i = 0; i != n; ++i) if(v[i] != shape_removed) ++c; return c; } struct remove_copy_shape_check { template void operator()(CSrc& src, std::size_t n_src, const char* src_spec, CDst& dst, std::size_t n_dst, const char* dst_spec) const { typedef typename CDst::iterator dst_iter_t; const boost::container::vector in = test_detail::flatten_n_ints(src, n_src); boost::container::vector ref; for(std::size_t i = 0; i != n_src; ++i) if(in[i] != shape_removed) ref.push_back(in[i]); const dst_iter_t r = segmented_remove_copy (src.begin(), test_detail::iter_at(src, n_src), dst.begin(), shape_removed); BOOST_TEST(r == test_detail::iter_at(dst, ref.size())); BOOST_TEST(test_detail::filler_intact(src, n_src, shape_filler)); BOOST_TEST(test_detail::filler_intact(dst, n_dst, shape_filler)); const boost::container::vector got = test_detail::flatten_n_ints(dst, n_dst); BOOST_TEST_EQ(got.size(), n_dst); for(std::size_t i = 0; i != n_dst; ++i) BOOST_TEST_EQ(got[i], i < ref.size() ? ref[i] : shape_fill); // The source is read-only, so it has to come back unchanged. const boost::container::vector src_after = test_detail::flatten_n_ints(src, n_src); for(std::size_t i = 0; i != n_src; ++i) BOOST_TEST_EQ(src_after[i], in[i]); BOOST_TEST(src_spec != 0 && dst_spec != 0); } }; void test_remove_copy_shape_matrix() { // Interleaved removals, a leading and a trailing removal, nothing removed // and everything removed, so the empty and the full answer are both in. static const int mixed[] = {1, 2, 3, 2, 4, 2, 5, 6, 2, 7}; static const int edges[] = {2, 1, 3, 4, 5, 2}; static const int none[] = {1, 3, 5, 7, 9, 11}; static const int all_rm[] = {2, 2, 2, 2, 2, 2}; static const int* const sets[] = {mixed, edges, none, all_rm}; static const std::size_t set_len[] = {10u, 6u, 6u, 6u}; static const std::size_t sizes[] = {0u, 1u, 2u, 3u, 5u, 6u}; for(std::size_t s = 0; s != sizeof(sets)/sizeof(sets[0]); ++s) { for(std::size_t i = 0; i != sizeof(sizes)/sizeof(sizes[0]); ++i) { const std::size_t n_src = sizes[i]; if(n_src > set_len[s]) continue; const std::size_t m = shape_survivor_count(sets[s], n_src); test_detail::for_each_shape2_all (sets[s], n_src, shape_dst_vals, m, shape_filler, remove_copy_shape_check()); test_detail::for_each_shape2_all (sets[s], n_src, shape_dst_vals, m + 3u, shape_filler, remove_copy_shape_check()); } } } ////////////////////////////////////////////////////////////////////////////// // Unrolled cleanup block coverage. // // remove_copy_cleanup_blocks<32> only runs with a random-access source and a // destination segment that still has room for 32 more elements. Every other // range in this file is far shorter than one block, so without these cases the // block and its remainder never execute and all the work falls to the checked // tail loop. // // Two removal densities are used: every third element removed, so a // destination sized to the survivor count still has block room, and no element // removed at all. Between them the block stops on the source count in some // cases and on the destination room in others, and the tail loop is handed // both an empty and a non-empty remainder. ////////////////////////////////////////////////////////////////////////////// template void remove_copy_block_case(const char* src_spec, const char* dst_spec, std::size_t n, std::size_t every) { boost::container::vector vals; vals.reserve(n); for(std::size_t i = 0; i != n; ++i) vals.push_back(every && (i % every) == 0 ? shape_removed : static_cast(i) + 10); CSrc src; test_detail::make_range(src, src_spec, &vals[0], n, shape_filler); boost::container::vector ref; for(std::size_t i = 0; i != n; ++i) if(vals[i] != shape_removed) ref.push_back(vals[i]); CDst dst; test_detail::make_dest_range(dst, dst_spec, ref.size(), shape_fill, shape_filler); typedef typename CDst::iterator dst_iter_t; const dst_iter_t r = segmented_remove_copy (src.begin(), test_detail::iter_at(src, n), dst.begin(), shape_removed); BOOST_TEST(r == test_detail::iter_at(dst, ref.size())); BOOST_TEST(test_detail::filler_intact(src, n, shape_filler)); BOOST_TEST(test_detail::filler_intact(dst, ref.size(), shape_filler)); const boost::container::vector got = test_detail::flatten_n_ints(dst, ref.size()); BOOST_TEST_EQ(got.size(), ref.size()); for(std::size_t i = 0; i != got.size(); ++i) BOOST_TEST_EQ(got[i], ref[i]); } void test_remove_copy_unrolled_blocks() { typedef test_detail::seg_vector s1_t; typedef test_detail::seg2_vector s2_t; static const std::size_t sizes[] = {33u, 39u, 64u, 200u, 320u}; static const std::size_t densities[] = {0u, 3u}; for(std::size_t i = 0; i != sizeof(sizes)/sizeof(sizes[0]); ++i) { const std::size_t n = sizes[i]; for(std::size_t d = 0; d != sizeof(densities)/sizeof(densities[0]); ++d) { const std::size_t e = densities[d]; remove_copy_block_case("s", "s", n, e); remove_copy_block_case("m", "m", n, e); remove_copy_block_case("e", "e", n, e); remove_copy_block_case("s", "ss", n, e); remove_copy_block_case("m", "mm", n, e); remove_copy_block_case("sm", "s", n, e); remove_copy_block_case("mm", "mm", n, e); remove_copy_block_case("ee", "ee", n, e); } } } ////////////////////////////////////////////////////////////////////////////// // Comparison count. // // [alg.remove] mandates "Exactly last - first applications of the // corresponding predicate or comparison", whatever the segmentation of either // range. A leaf that compares an element, then finds the destination segment // full and returns without consuming it hands that element back to the // destination walker, which compares it again; only an equality catches that. // There is no predicate overload, so the count comes from the value type. ////////////////////////////////////////////////////////////////////////////// struct remove_copy_count_check { template void operator()(CSrc& src, std::size_t n_src, const char* src_spec, CDst& dst, std::size_t n_dst, const char* dst_spec) const { test_detail::counted_int_ops().reset(); segmented_remove_copy(src.begin(), test_detail::iter_at(src, n_src), dst.begin(), test_detail::counted_int(shape_removed)); const std::size_t applied = test_detail::counted_int_ops().cmp; BOOST_TEST_EQ(applied, n_src); BOOST_TEST(src_spec != 0 && dst_spec != 0 && n_dst <= n_src + 3u); } }; void remove_copy_add_block(test_detail::seg_vector& c, std::size_t block) { c.add_segment(block, test_detail::counted_int(0)); } void remove_copy_add_block(test_detail::seg2_vector& c, std::size_t block) { test_detail::seg_vector inner; inner.add_segment(block, test_detail::counted_int(0)); c.add_segment(inner); } // Destination segments of a handful of elements each, so that boundary // crossings dominate: with 64 elements and blocks of 8 there are seven of them, // and the depth-2 destination multiplies them. template void remove_copy_count_small_dst(std::size_t n, std::size_t block, bool all_kept) { boost::container::vector src; src.reserve(n); for(std::size_t i = 0; i != n; ++i) src.push_back(test_detail::counted_int (all_kept ? static_cast(i) + 10 : shape_removed)); CDst dst; for(std::size_t room = 0; room < n; room += block) remove_copy_add_block(dst, block); test_detail::counted_int_ops().reset(); segmented_remove_copy(src.begin(), src.end(), dst.begin(), test_detail::counted_int(shape_removed)); BOOST_TEST_EQ(test_detail::counted_int_ops().cmp, n); } void test_remove_copy_comparison_count() { static const int mixed[] = {1, 2, 3, 2, 4, 2, 5, 6, 2, 7}; static const int edges[] = {2, 1, 3, 4, 5, 2}; static const int none[] = {1, 3, 5, 7, 9, 11}; static const int all_rm[] = {2, 2, 2, 2, 2, 2}; static const int* const sets[] = {mixed, edges, none, all_rm}; static const std::size_t set_len[] = {10u, 6u, 6u, 6u}; static const std::size_t sizes[] = {0u, 1u, 2u, 3u, 5u, 6u}; for(std::size_t s = 0; s != sizeof(sets)/sizeof(sets[0]); ++s) { for(std::size_t i = 0; i != sizeof(sizes)/sizeof(sizes[0]); ++i) { const std::size_t n_src = sizes[i]; if(n_src > set_len[s]) continue; const std::size_t m = shape_survivor_count(sets[s], n_src); test_detail::for_each_shape2_all (sets[s], n_src, shape_dst_vals, m, shape_filler, remove_copy_count_check()); test_detail::for_each_shape2_all (sets[s], n_src, shape_dst_vals, m + 3u, shape_filler, remove_copy_count_check()); } } static const std::size_t blocks[] = {1u, 2u, 3u, 8u, 16u}; for(std::size_t b = 0; b != sizeof(blocks)/sizeof(blocks[0]); ++b) { for(int ak = 0; ak != 2; ++ak) { const bool a = ak != 0; remove_copy_count_small_dst > (64u, blocks[b], a); remove_copy_count_small_dst > (64u, blocks[b], a); } } } int main() { test_remove_copy_segmented(); test_remove_copy_empty(); test_remove_copy_none_removed(); test_remove_copy_single_segment_whole(); test_remove_copy_single_segment_interior(); test_remove_copy_single_segment_empty_mid(); test_remove_copy_single_segment_sentinel(); test_remove_copy_single_segment_seg2_outer(); test_remove_copy_single_segment_seg2_both(); test_remove_copy_non_segmented(); test_remove_copy_sentinel_segmented(); test_remove_copy_sentinel_non_segmented(); test_remove_copy_seg2(); test_remove_copy_single_segment_src_multi_dst(); test_remove_copy_single_segment_src_and_dst(); test_remove_copy_single_segment_dst_from_flat(); test_remove_copy_shape_matrix(); test_remove_copy_unrolled_blocks(); test_remove_copy_comparison_count(); return boost::report_errors(); }