libcxx/test/std/containers/container.adaptors/flat.multimap/flat.multimap.modifiers/emplace_hint.pass.cpp

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

// UNSUPPORTED: c++03, c++11, c++14, c++17, c++20

// <flat_map>

// class flat_multimap

// template <class... Args>
//   iterator emplace_hint(const_iterator position, Args&&... args);

#include <flat_map>
#include <cassert>
#include <deque>
#include <functional>
#include <vector>

#include "MinSequenceContainer.h"
#include "test_macros.h"
#include "../../../Emplaceable.h"
#include "DefaultOnly.h"
#include "min_allocator.h"
#include "../helpers.h"

#if defined(_LIBCPP_VERSION)
// spec only specifies `emplace(Args&&...)` is_constructible_v<pair<key_type, mapped_type>, Args...> is true.
// nothing mentioned for emplace_hint
template <class M, class... Args>
concept CanEmplaceHint =
    requires(M m, typename M::const_iterator i, Args&&... args) { m.emplace_hint(i, std::forward<Args>(args)...); };

using Map = std::flat_multimap<Emplaceable, Emplaceable>;
static_assert(CanEmplaceHint<Map>);
static_assert(CanEmplaceHint<Map, Emplaceable, Emplaceable>);
static_assert(CanEmplaceHint<Map, std::piecewise_construct_t, std::tuple<int, double>, std::tuple<int, double>>);
static_assert(!CanEmplaceHint<Map, Emplaceable>);
static_assert(!CanEmplaceHint<Map, int, double>);
#endif

template <class KeyContainer, class ValueContainer>
constexpr void test() {
  using Key   = typename KeyContainer::value_type;
  using Value = typename ValueContainer::value_type;
  using M     = std::flat_multimap<Key, Value, std::less<Key>, KeyContainer, ValueContainer>;
  using R     = M::iterator;
  {
    // was empty
    M m;
    std::same_as<R> decltype(auto) r = m.emplace_hint(m.end(), typename M::value_type(2, 3.5));
    assert(r == m.begin());
    assert(m.size() == 1);
    assert(m.begin()->first == 2);
    assert(m.begin()->second == 3.5);
  }
  {
    // hint correct and no duplicates
    M m                              = {{0, 0.0}, {1, 1.0}, {3, 3.0}};
    auto it                          = m.begin() + 2;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 2);
    assert(m.size() == 4);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint correct and at the begin
    M m                              = {{3, 3.0}, {4, 4.0}};
    auto it                          = m.begin();
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin());
    assert(m.size() == 3);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint correct and at the end
    M m                              = {{0, 0.0}, {1, 1.0}};
    auto it                          = m.end();
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 2);
    assert(m.size() == 3);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint correct and at first duplicate
    M m                              = {{0, 0.0}, {1, 1.0}, {2, 1.9}, {2, 2.1}, {3, 3.0}};
    auto it                          = m.begin() + 2;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 2);
    assert(m.size() == 6);
    assert(r->first == 2);
    assert(r->second == 2.0);
    assert(std::next(r)->first == 2);
    assert(std::next(r)->second == 1.9);
  }
  {
    // hint correct and in-between duplicates
    M m                              = {{0, 0.0}, {1, 1.0}, {2, 1.8}, {2, 1.9}, {2, 2.1}, {3, 3.0}};
    auto it                          = m.begin() + 4;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 4);
    assert(m.size() == 7);
    assert(r->first == 2);
    assert(r->second == 2.0);
    assert(std::next(r)->first == 2);
    assert(std::next(r)->second == 2.1 || std::next(r)->second == 1.9);
  }
  {
    // hint correct and after duplicates
    M m                              = {{0, 0.0}, {1, 1.0}, {2, 1.8}, {2, 1.9}, {2, 2.1}, {3, 3.0}};
    auto it                          = m.begin() + 5;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 5);
    assert(m.size() == 7);
    assert(r->first == 2);
    assert(r->second == 2.0);
    assert(std::next(r)->first == 3);
    assert(std::next(r)->second == 3.0);
  }
  {
    // hint incorrect and no duplicates
    M m                              = {{0, 0.0}, {1, 1.0}, {3, 3.0}};
    auto it                          = m.begin() + 1;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 2);
    assert(m.size() == 4);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint incorrect and at the begin
    M m                              = {{0, 0.0}, {1, 1.0}};
    auto it                          = m.begin();
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin() + 2);
    assert(m.size() == 3);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint incorrect and at the end
    M m                              = {{3, 3.0}, {4, 4.0}};
    auto it                          = m.end();
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    assert(r == m.begin());
    assert(m.size() == 3);
    assert(r->first == 2);
    assert(r->second == 2.0);
  }
  {
    // hint incorrect and before the first duplicate
    M m                              = {{0, 0.0}, {1, 1.0}, {2, 1.8}, {2, 1.9}, {2, 2.1}, {3, 3.0}};
    auto it                          = m.begin();
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    // the result is as left as possible
    assert(r == m.begin() + 2);
    assert(m.size() == 7);
    assert(r->first == 2);
    assert(r->second == 2.0);
    assert(std::next(r)->first == 2);
    assert(std::next(r)->second == 1.8);
  }
  {
    // hint incorrect and after the last duplicate
    M m                              = {{0, 0.0}, {1, 1.0}, {2, 1.8}, {2, 1.9}, {2, 2.1}, {3, 3.0}, {4, 4.0}};
    auto it                          = m.begin() + 6;
    std::same_as<R> decltype(auto) r = m.emplace_hint(it, typename M::value_type(2, 2.0));
    // the result is as right as possible
    assert(r == m.begin() + 5);
    assert(m.size() == 8);
    assert(r->first == 2);
    assert(r->second == 2.0);
    assert(std::next(r)->first == 3);
    assert(std::next(r)->second == 3.0);
  }
}

template <class KeyContainer, class ValueContainer>
constexpr void test_emplaceable() {
  using M = std::flat_multimap<int, Emplaceable, std::less<int>, KeyContainer, ValueContainer>;
  using R = M::iterator;

  M m;
  ASSERT_SAME_TYPE(decltype(m.emplace_hint(m.cbegin())), R);
  R r = m.emplace_hint(m.end(), std::piecewise_construct, std::forward_as_tuple(2), std::forward_as_tuple());
  assert(r == m.begin());
  assert(m.size() == 1);
  assert(r->first == 2);
  assert(r->second == Emplaceable());
  r = m.emplace_hint(m.end(), std::piecewise_construct, std::forward_as_tuple(1), std::forward_as_tuple(2, 3.5));
  assert(r == m.begin());
  assert(m.size() == 2);
  assert(r->first == 1);
  assert(r->second == Emplaceable(2, 3.5));
  r = m.emplace_hint(m.end(), std::piecewise_construct, std::forward_as_tuple(1), std::forward_as_tuple(2, 3.6));
  assert(r == m.begin() + 1);
  assert(m.size() == 3);
  assert(r->first == 1);
  assert(r->second == Emplaceable(2, 3.6));
}

constexpr bool test() {
  test<std::vector<int>, std::vector<double>>();
#ifndef __cpp_lib_constexpr_deque
  if (!TEST_IS_CONSTANT_EVALUATED)
#endif
    test<std::deque<int>, std::vector<double>>();
  test<MinSequenceContainer<int>, MinSequenceContainer<double>>();
  test<std::vector<int, min_allocator<int>>, std::vector<double, min_allocator<double>>>();

  test_emplaceable<std::vector<int>, std::vector<Emplaceable>>();
#ifndef __cpp_lib_constexpr_deque
  if (!TEST_IS_CONSTANT_EVALUATED)
#endif
    test_emplaceable<std::deque<int>, std::vector<Emplaceable>>();
  test_emplaceable<MinSequenceContainer<int>, MinSequenceContainer<Emplaceable>>();
  test_emplaceable<std::vector<int, min_allocator<int>>, std::vector<Emplaceable, min_allocator<Emplaceable>>>();
  if (!TEST_IS_CONSTANT_EVALUATED) {
    auto emplace_func = [](auto& m, auto key_arg, auto value_arg) {
      m.emplace_hint(m.begin(), std::piecewise_construct, std::tuple(key_arg), std::tuple(value_arg));
    };
    test_emplace_exception_guarantee(emplace_func);
  }
  return true;
}

int main(int, char**) {
  test();
#if TEST_STD_VER >= 26
  static_assert(test());
#endif

  return 0;
}