/* * This file is part of the TrinityCore 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 General Public License as published by the * Free Software Foundation; either version 2 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 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 TRINITY_CONTAINERS_H #define TRINITY_CONTAINERS_H #include "Define.h" #include "MapUtils.h" #include "Random.h" #include #include #include #include #include #include namespace Trinity { 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, 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; } 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 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 Trinity::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; } /* * 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 const& 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 inline 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); } /** * @fn void Trinity::Containers::RandomShuffle(Iterator begin, Iterator end) * * @brief Reorder the elements of the iterator range randomly. * * @param begin Beginning of the range to reorder * @param end End of the range to reorder */ template inline void RandomShuffle(Iterator begin, Iterator end) { std::shuffle(begin, end, RandomEngine::Instance()); } /** * @fn void Trinity::Containers::RandomShuffle(C& container) * * @brief Reorder the elements of the container randomly. * * @param container Container to reorder */ template inline void RandomShuffle(C& container) { RandomShuffle(std::begin(container), std::end(container)); } /** * @fn bool Trinity::Containers::Intersects(Iterator first1, Iterator last1, Iterator first2, Iterator last2) * * @brief Checks if two SORTED containers have a common element * * @param first1 Iterator pointing to start of the first container * @param last1 Iterator pointing to end of the first container * @param first2 Iterator pointing to start of the second container * @param last2 Iterator pointing to end of the second container * * @return true if containers have a common element, false otherwise. */ template inline bool Intersects(Iterator1 first1, Iterator1 last1, Iterator2 first2, Iterator2 last2) { while (first1 != last1 && first2 != last2) { if (*first1 < *first2) ++first1; else if (*first2 < *first1) ++first2; else return true; } return false; } /** * @fn bool Trinity::Containers::Intersects(Iterator first1, Iterator last1, Iterator first2, Iterator last2, Predicate&& equalPred) * * @brief Checks if two SORTED containers have a common element * * @param first1 Iterator pointing to start of the first container * @param last1 Iterator pointing to end of the first container * @param first2 Iterator pointing to start of the second container * @param last2 Iterator pointing to end of the second container * @param equalPred Additional predicate to exclude elements * * @return true if containers have a common element, false otherwise. */ template inline bool Intersects(Iterator1 first1, Iterator1 last1, Iterator2 first2, Iterator2 last2, Predicate&& equalPred) { while (first1 != last1 && first2 != last2) { if (*first1 < *first2) ++first1; else if (*first2 < *first1) ++first2; else if (!equalPred(*first1, *first2)) ++first1, ++first2; else return true; } return false; } namespace Impl { template void EraseIfMoveAssignable(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 void EraseIfNotMoveAssignable(Container& c, Predicate p) { for (auto it = c.begin(); it != c.end();) { if (p(*it)) it = c.erase(it); else ++it; } } } template void EraseIf(Container& c, Predicate p) { if constexpr (std::is_move_assignable_v) Impl::EraseIfMoveAssignable(c, std::ref(p)); else Impl::EraseIfNotMoveAssignable(c, std::ref(p)); } /** * Returns a mutable reference to element at index i * Will resize vector if neccessary to ensure element at i can be safely written * * This exists as separate overload instead of one function with default argument to allow using * with vectors of non-default-constructible classes */ template inline decltype(auto) EnsureWritableVectorIndex(std::vector& vec, typename std::vector::size_type i) { if (i >= vec.size()) vec.resize(i + 1); return vec[i]; } /** * Returns a mutable reference to element at index i * Will resize vector if neccessary to ensure element at i can be safely written * * This overload allows specifying what value to pad vector with during .resize */ template inline decltype(auto) EnsureWritableVectorIndex(std::vector& vec, typename std::vector::size_type i, T const& resizeDefault) { if (i >= vec.size()) vec.resize(i + 1, resizeDefault); return vec[i]; } } //! namespace Containers } //! namespace Trinity #endif //! #ifdef TRINITY_CONTAINERS_H