/* * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Affero General Public License as published by the * Free Software Foundation; either version 3 of the License, or (at your * option) any later version. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with this program. If not, see . */ #ifndef ACORE_CONTAINERS_H #define ACORE_CONTAINERS_H #include "Define.h" #include "Random.h" #include #include #include #include namespace Acore { template constexpr inline T* AddressOrSelf(T* ptr) { return ptr; } template constexpr inline T* AddressOrSelf(T& not_ptr) { return std::addressof(not_ptr); } template class CheckedBufferOutputIterator { public: using iterator_category = std::output_iterator_tag; using value_type = void; using pointer = T*; using reference = T&; using difference_type = std::ptrdiff_t; CheckedBufferOutputIterator(T* buf, std::size_t n) : _buf(buf), _end(buf + n) {} T& operator*() const { check(); return *_buf; } CheckedBufferOutputIterator& operator++() { check(); ++_buf; return *this; } CheckedBufferOutputIterator operator++(int) { CheckedBufferOutputIterator v = *this; operator++(); return v; } [[nodiscard]] std::size_t remaining() const { return (_end - _buf); } private: T* _buf; T* _end; void check() const { if (!(_buf < _end)) { throw std::out_of_range("index"); } } }; } namespace Acore::Containers { // resizes to have at most elements // if it has more than elements, the elements to keep are selected randomly template void RandomResize(C& container, std::size_t requestedSize) { static_assert(std::is_base_of::iterator_category>::value, "Invalid container passed to Acore::Containers::RandomResize"); if (std::size(container) <= requestedSize) { return; } auto keepIt = std::begin(container), curIt = std::begin(container); uint32 elementsToKeep = requestedSize, elementsToProcess = std::size(container); while (elementsToProcess) { // this element has chance (elementsToKeep / elementsToProcess) of being kept if (urand(1, elementsToProcess) <= elementsToKeep) { if (keepIt != curIt) { *keepIt = std::move(*curIt); } ++keepIt; --elementsToKeep; } ++curIt; --elementsToProcess; } container.erase(keepIt, std::end(container)); } template void RandomResize(C& container, Predicate&& predicate, std::size_t requestedSize) { //! First use predicate filter C containerCopy; std::copy_if(std::begin(container), std::end(container), std::inserter(containerCopy, std::end(containerCopy)), predicate); if (requestedSize) { RandomResize(containerCopy, requestedSize); } container = std::move(containerCopy); } /* * Select a random element from a container. * * Note: container cannot be empty */ template inline auto SelectRandomContainerElement(C const& container) -> typename std::add_const::type& { auto it = std::begin(container); std::advance(it, urand(0, uint32(std::size(container)) - 1)); return *it; } /* * @brief Selects a random element from a container that matches the given predicate * * @param container Source container to select from * @param predicate Unary predicate to filter elements * @return Iterator to the randomly selected element, or end iterator if no elements match the predicate * * Note: container cannot be empty */ template inline auto SelectRandomContainerElementIf(C const& container, Predicate&& predicate) -> decltype(std::begin(container)) { std::vector matchingElements; for (auto it = std::begin(container); it != std::end(container); ++it) if (predicate(*it)) matchingElements.push_back(it); if (matchingElements.empty()) return std::end(container); auto randomIt = matchingElements[urand(0, matchingElements.size() - 1)]; return randomIt; } /* * Select a random element from a container where each element has a different chance to be selected. * * @param container Container to select an element from * @param weights Chances of each element to be selected, must be in the same order as elements in container. * Caller is responsible for checking that sum of all weights is greater than 0. * * Note: container cannot be empty */ template inline auto SelectRandomWeightedContainerElement(C const& container, std::vector weights) -> decltype(std::begin(container)) { auto it = std::begin(container); std::advance(it, urandweighted(weights.size(), weights.data())); return it; } /* * Select a random element from a container where each element has a different chance to be selected. * * @param container Container to select an element from * @param weightExtractor Function retrieving chance of each element in container, expected to take an element of the container and returning a double * * Note: container cannot be empty */ template auto SelectRandomWeightedContainerElement(C const& container, Fn weightExtractor) -> decltype(std::begin(container)) { std::vector weights; weights.reserve(std::size(container)); double weightSum = 0.0; for (auto& val : container) { double weight = weightExtractor(val); weights.push_back(weight); weightSum += weight; } if (weightSum <= 0.0) { weights.assign(std::size(container), 1.0); } return SelectRandomWeightedContainerElement(container, weights); } /** * Returns a pointer to mapped value (or the value itself if map stores pointers) */ template inline auto MapGetValuePtr(M& map, typename M::key_type const& key) -> decltype(AddressOrSelf(map.find(key)->second)) { auto itr = map.find(key); return itr != map.end() ? AddressOrSelf(itr->second) : nullptr; } /* * @fn void Acore::Containers::RandomShuffle(C& container) * * @brief Reorder the elements of the container randomly. * * @param container Container to reorder */ template inline void RandomShuffle(C& container) { std::shuffle(std::begin(container), std::end(container), RandomEngine::Instance()); } template class M, class... Rest> void MultimapErasePair(M& multimap, K const& key, V const& value) { auto range = multimap.equal_range(key); for (auto itr = range.first; itr != range.second;) { if (itr->second == value) { itr = multimap.erase(itr); } else { ++itr; } } } template std::enable_if_t().begin())>, void> EraseIf(Container& c, Predicate p) { auto wpos = c.begin(); for (auto rpos = c.begin(), end = c.end(); rpos != end; ++rpos) { if (!p(*rpos)) { if (rpos != wpos) { std::swap(*rpos, *wpos); } ++wpos; } } c.erase(wpos, c.end()); } template std::enable_if_t().begin())>, void> EraseIf(Container& c, Predicate p) { for (auto it = c.begin(); it != c.end();) { if (p(*it)) { it = c.erase(it); } else { ++it; } } } } #endif //! #ifdef ACORE_CONTAINERS_H