You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
105 lines
4.1 KiB
105 lines
4.1 KiB
/****************************************************************************
|
|
Copyright (c) 2021-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <functional>
|
|
#include "base/std/container/vector.h"
|
|
|
|
namespace cc {
|
|
|
|
/**
|
|
* @en Recyclable object pool. It's designed to be entirely reused each time.
|
|
* There is no put and get method, each time you get the [[data]], you can use all elements as new.
|
|
* You shouldn't simultaneously use the same RecyclePool in more than two overlapped logic.
|
|
* Its size can be automatically incremented or manually resized.
|
|
* @zh 循环对象池。这种池子被设计为每次使用都完整复用。
|
|
* 它没有回收和提取的函数，通过获取 [[data]] 可以获取池子中所有元素，全部都应该被当做新对象来使用。
|
|
* 开发者不应该在相互交叉的不同逻辑中同时使用同一个循环对象池。
|
|
* 池子尺寸可以在池子满时自动扩充，也可以手动调整。
|
|
* @see [[Pool]]
|
|
*/
|
|
template <typename T>
|
|
class RecyclePool final {
|
|
public:
|
|
/**
|
|
* @en Constructor with the allocator of elements and initial pool size, all elements will be pre-allocated.
|
|
* @zh 使用元素的构造器和初始大小的构造函数，所有元素都会被预创建。
|
|
* @param fn The allocator of elements in pool, it's invoked directly without `new`
|
|
* @param size Initial pool size
|
|
*/
|
|
RecyclePool(const std::function<T *()> &fn, uint32_t size);
|
|
|
|
RecyclePool(const RecyclePool &) = delete;
|
|
RecyclePool(RecyclePool &&) = delete;
|
|
~RecyclePool() = default;
|
|
RecyclePool &operator=(const RecyclePool &) = delete;
|
|
RecyclePool &operator=(RecyclePool &&) = delete;
|
|
|
|
/**
|
|
* @en The length of the object pool.
|
|
* @zh 对象池大小。
|
|
*/
|
|
inline uint32_t getLength() const { return _count; }
|
|
|
|
/**
|
|
* @en The underlying array of all pool elements.
|
|
* @zh 实际对象池数组。
|
|
*/
|
|
inline const ccstd::vector<T *> &getData() const { return _data; }
|
|
|
|
/**
|
|
* @en Resets the object pool. Only changes the length to 0
|
|
* @zh 清空对象池。目前仅仅会设置尺寸为 0
|
|
*/
|
|
inline void reset() { _count = 0; }
|
|
|
|
/**
|
|
* @en Resize the object poo, and fills with new created elements.
|
|
* @zh 设置对象池大小，并填充新的元素。
|
|
* @param size The new size of the pool
|
|
*/
|
|
void resize(uint32_t size);
|
|
|
|
/**
|
|
* @en Expand the object pool, the size will be increment to current size times two, and fills with new created elements.
|
|
* @zh 扩充对象池容量，会自动扩充尺寸到两倍，并填充新的元素。
|
|
* @param idx
|
|
*/
|
|
void add();
|
|
|
|
/**
|
|
* @en Remove an element of the object pool. This will also decrease size of the pool
|
|
* @zh 移除对象池中的一个元素，同时会减小池子尺寸。
|
|
* @param idx The index of the element to be removed
|
|
*/
|
|
void removeAt(uint32_t idx);
|
|
|
|
private:
|
|
uint32_t _count{0};
|
|
ccstd::vector<T *> _data;
|
|
};
|
|
|
|
} // namespace cc
|
|
|