EnTT 3.13.0
|
Basic sparse set implementation. More...
#include <sparse_set.hpp>
Public Types | |
using | traits_type = entt_traits< Entity > |
Entity traits. | |
using | entity_type = typename traits_type::value_type |
Underlying entity identifier. | |
using | version_type = typename traits_type::version_type |
Underlying version type. | |
using | size_type = std::size_t |
Unsigned integer type. | |
using | allocator_type = Allocator |
Allocator type. | |
using | pointer = typename packed_container_type::const_pointer |
Pointer type to contained entities. | |
using | iterator = basic_iterator |
Random access iterator type. | |
using | const_iterator = iterator |
Constant random access iterator type. | |
using | reverse_iterator = std::reverse_iterator< iterator > |
Reverse iterator type. | |
using | const_reverse_iterator = std::reverse_iterator< const_iterator > |
Constant reverse iterator type. | |
Public Member Functions | |
basic_sparse_set () | |
Default constructor. | |
basic_sparse_set (const allocator_type &allocator) | |
Constructs an empty container with a given allocator. | |
basic_sparse_set (deletion_policy pol, const allocator_type &allocator={}) | |
Constructs an empty container with the given policy and allocator. | |
basic_sparse_set (const type_info &elem, deletion_policy pol=deletion_policy::swap_and_pop, const allocator_type &allocator={}) | |
Constructs an empty container with the given value type, policy and allocator. | |
basic_sparse_set (basic_sparse_set &&other) noexcept | |
Move constructor. | |
basic_sparse_set (basic_sparse_set &&other, const allocator_type &allocator) noexcept | |
Allocator-extended move constructor. | |
virtual | ~basic_sparse_set () |
Default destructor. | |
basic_sparse_set & | operator= (basic_sparse_set &&other) noexcept |
Move assignment operator. | |
void | swap (basic_sparse_set &other) |
Exchanges the contents with those of a given sparse set. | |
constexpr allocator_type | get_allocator () const noexcept |
Returns the associated allocator. | |
deletion_policy | policy () const noexcept |
Returns the deletion policy of a sparse set. | |
size_type | free_list () const noexcept |
Returns the head of the free list, if any. | |
void | free_list (const size_type len) noexcept |
Sets the head of the free list, if possible. | |
virtual void | reserve (const size_type cap) |
Increases the capacity of a sparse set. | |
virtual size_type | capacity () const noexcept |
Returns the number of elements that a sparse set has currently allocated space for. | |
virtual void | shrink_to_fit () |
Requests the removal of unused capacity. | |
size_type | extent () const noexcept |
Returns the extent of a sparse set. | |
size_type | size () const noexcept |
Returns the number of elements in a sparse set. | |
bool | empty () const noexcept |
Checks whether a sparse set is empty. | |
bool | contiguous () const noexcept |
Checks whether a sparse set is fully packed. | |
pointer | data () const noexcept |
Direct access to the internal packed array. | |
iterator | begin () const noexcept |
Returns an iterator to the beginning. | |
const_iterator | cbegin () const noexcept |
Returns an iterator to the beginning. | |
iterator | end () const noexcept |
Returns an iterator to the end. | |
const_iterator | cend () const noexcept |
Returns an iterator to the end. | |
reverse_iterator | rbegin () const noexcept |
Returns a reverse iterator to the beginning. | |
const_reverse_iterator | crbegin () const noexcept |
Returns a reverse iterator to the beginning. | |
reverse_iterator | rend () const noexcept |
Returns a reverse iterator to the end. | |
const_reverse_iterator | crend () const noexcept |
Returns a reverse iterator to the end. | |
iterator | begin (int) const noexcept |
Returns an iterator to the beginning. Useful only in case of swap-only policy. | |
const_iterator | cbegin (int) const noexcept |
Returns an iterator to the beginning. Useful only in case of swap-only policy. | |
iterator | end (int) const noexcept |
Returns an iterator to the end. Useful only in case of swap-only policy. | |
const_iterator | cend (int) const noexcept |
Returns an iterator to the end. Useful only in case of swap-only policy. | |
reverse_iterator | rbegin (int) const noexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
const_reverse_iterator | crbegin (int) const noexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
reverse_iterator | rend (int) const noexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
const_reverse_iterator | crend (int) const noexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
const_iterator | find (const entity_type entt) const noexcept |
Finds an entity. | |
bool | contains (const entity_type entt) const noexcept |
Checks if a sparse set contains an entity. | |
version_type | current (const entity_type entt) const noexcept |
Returns the contained version for an identifier. | |
size_type | index (const entity_type entt) const noexcept |
Returns the position of an entity in a sparse set. | |
entity_type | at (const size_type pos) const noexcept |
Returns the entity at specified location, with bounds checking. | |
entity_type | operator[] (const size_type pos) const noexcept |
Returns the entity at specified location, without bounds checking. | |
const void * | value (const entity_type entt) const noexcept |
Returns the element assigned to an entity, if any. | |
void * | value (const entity_type entt) noexcept |
Returns the element assigned to an entity, if any. | |
iterator | push (const entity_type entt, const void *elem=nullptr) |
Assigns an entity to a sparse set. | |
template<typename It > | |
iterator | push (It first, It last) |
Assigns one or more entities to a sparse set. | |
version_type | bump (const entity_type entt) |
Bump the version number of an entity. | |
void | erase (const entity_type entt) |
Erases an entity from a sparse set. | |
template<typename It > | |
void | erase (It first, It last) |
Erases entities from a set. | |
bool | remove (const entity_type entt) |
Removes an entity from a sparse set if it exists. | |
template<typename It > | |
size_type | remove (It first, It last) |
Removes entities from a sparse set if they exist. | |
void | compact () |
Removes all tombstones from a sparse set. | |
void | swap_elements (const entity_type lhs, const entity_type rhs) |
Swaps two entities in a sparse set. | |
template<typename Compare , typename Sort = std_sort, typename... Args> | |
void | sort_n (const size_type length, Compare compare, Sort algo=Sort{}, Args &&...args) |
Sort the first count elements according to the given comparison function. | |
template<typename Compare , typename Sort = std_sort, typename... Args> | |
void | sort (Compare compare, Sort algo=Sort{}, Args &&...args) |
Sort all elements according to the given comparison function. | |
template<typename It > | |
void | sort_as (It first, It last) |
Sort entities according to their order in a range. | |
void | sort_as (const basic_sparse_set &other) |
Sort entities according to their order in a range. | |
void | clear () |
Clears a sparse set. | |
const type_info & | type () const noexcept |
Returned value type, if any. | |
virtual void | bind (any) noexcept |
Forwards variables to derived classes, if any. | |
Protected Types | |
using | basic_iterator = internal::sparse_set_iterator< packed_container_type > |
Random access iterator type. | |
Protected Member Functions | |
void | swap_only (const basic_iterator it) |
Erases an entity from a sparse set. | |
void | swap_and_pop (const basic_iterator it) |
Erases an entity from a sparse set. | |
void | in_place_pop (const basic_iterator it) |
Erases an entity from a sparse set. | |
virtual void | pop (basic_iterator first, basic_iterator last) |
Erases entities from a sparse set. | |
virtual void | pop_all () |
Erases all entities of a sparse set. | |
virtual basic_iterator | try_emplace (const Entity entt, const bool force_back, const void *=nullptr) |
Assigns an entity to a sparse set. | |
Basic sparse set implementation.
Sparse set or packed array or whatever is the name users give it.
Two arrays: an external one and an internal one; a sparse one and a packed one; one used for direct access through contiguous memory, the other one used to get the data through an extra level of indirection.
This type of data structure is widely documented in the literature and on the web. This is nothing more than a customized implementation suitable for the purpose of the framework.
Entity | A valid entity type. |
Allocator | Type of allocator used to manage memory and elements. |
Definition at line 158 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::allocator_type = Allocator |
Allocator type.
Definition at line 382 of file sparse_set.hpp.
|
protected |
Random access iterator type.
Definition at line 236 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::const_iterator = iterator |
Constant random access iterator type.
Definition at line 388 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::const_reverse_iterator = std::reverse_iterator<const_iterator> |
Constant reverse iterator type.
Definition at line 392 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::entity_type = typename traits_type::value_type |
Underlying entity identifier.
Definition at line 376 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::iterator = basic_iterator |
Random access iterator type.
Definition at line 386 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::pointer = typename packed_container_type::const_pointer |
Pointer type to contained entities.
Definition at line 384 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::reverse_iterator = std::reverse_iterator<iterator> |
Reverse iterator type.
Definition at line 390 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::size_type = std::size_t |
Unsigned integer type.
Definition at line 380 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::traits_type = entt_traits<Entity> |
Entity traits.
Definition at line 374 of file sparse_set.hpp.
using entt::basic_sparse_set< Entity, Allocator >::version_type = typename traits_type::version_type |
Underlying version type.
Definition at line 378 of file sparse_set.hpp.
|
inline |
Default constructor.
Definition at line 395 of file sparse_set.hpp.
|
inlineexplicit |
Constructs an empty container with a given allocator.
allocator | The allocator to use. |
Definition at line 402 of file sparse_set.hpp.
|
inlineexplicit |
Constructs an empty container with the given policy and allocator.
pol | Type of deletion policy. |
allocator | The allocator to use (possibly default-constructed). |
Definition at line 410 of file sparse_set.hpp.
|
inlineexplicit |
Constructs an empty container with the given value type, policy and allocator.
elem | Returned value type, if any. |
pol | Type of deletion policy. |
allocator | The allocator to use (possibly default-constructed). |
Definition at line 420 of file sparse_set.hpp.
|
inlinenoexcept |
Move constructor.
other | The instance to move from. |
Definition at line 431 of file sparse_set.hpp.
|
inlinenoexcept |
Allocator-extended move constructor.
other | The instance to move from. |
allocator | The allocator to use. |
Definition at line 443 of file sparse_set.hpp.
|
inlinevirtual |
Default destructor.
Definition at line 453 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the entity at specified location, with bounds checking.
pos | The position for which to return the entity. |
Definition at line 757 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning.
If the sparse set is empty, the returned iterator will be equal to end()
.
Definition at line 606 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to end()
.
Definition at line 663 of file sparse_set.hpp.
|
inlinevirtualnoexcept |
Forwards variables to derived classes, if any.
Definition at line 1094 of file sparse_set.hpp.
|
inline |
Bump the version number of an entity.
entt | A valid identifier. |
Definition at line 838 of file sparse_set.hpp.
|
inlinevirtualnoexcept |
Returns the number of elements that a sparse set has currently allocated space for.
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Mask, Registry::entity_type, Allocator >.
Definition at line 537 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning.
If the sparse set is empty, the returned iterator will be equal to end()
.
Definition at line 612 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to end()
.
Definition at line 668 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the end.
Definition at line 626 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the end. Useful only in case of swap-only policy.
Definition at line 678 of file sparse_set.hpp.
|
inline |
Clears a sparse set.
Definition at line 1077 of file sparse_set.hpp.
|
inline |
Removes all tombstones from a sparse set.
Definition at line 925 of file sparse_set.hpp.
|
inlinenoexcept |
Checks if a sparse set contains an entity.
entt | A valid identifier. |
Definition at line 717 of file sparse_set.hpp.
|
inlinenoexcept |
Checks whether a sparse set is fully packed.
Definition at line 586 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 644 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 688 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the end.
Definition at line 658 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 698 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the contained version for an identifier.
entt | A valid identifier. |
Definition at line 731 of file sparse_set.hpp.
|
inlinenoexcept |
Direct access to the internal packed array.
Definition at line 594 of file sparse_set.hpp.
|
inlinenoexcept |
Checks whether a sparse set is empty.
Definition at line 578 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the end.
Definition at line 621 of file sparse_set.hpp.
|
inlinenoexcept |
Returns an iterator to the end. Useful only in case of swap-only policy.
Definition at line 673 of file sparse_set.hpp.
|
inline |
Erases an entity from a sparse set.
entt | A valid identifier. |
Definition at line 855 of file sparse_set.hpp.
|
inline |
Erases entities from a set.
It | Type of input iterator. |
first | An iterator to the first element of the range of entities. |
last | An iterator past the last element of the range of entities. |
Definition at line 870 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the extent of a sparse set.
The extent of a sparse set is also the size of the internal sparse array. There is no guarantee that the internal packed array has the same size. Usually the size of the internal sparse array is equal or greater than the one of the internal packed array.
Definition at line 556 of file sparse_set.hpp.
|
inlinenoexcept |
Finds an entity.
entt | A valid identifier. |
Definition at line 708 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the head of the free list, if any.
Definition at line 507 of file sparse_set.hpp.
|
inlinenoexcept |
Sets the head of the free list, if possible.
len | The value to use as the new head of the free list. |
Definition at line 515 of file sparse_set.hpp.
|
inlineconstexprnoexcept |
Returns the associated allocator.
Definition at line 491 of file sparse_set.hpp.
|
inlineprotected |
Erases an entity from a sparse set.
it | An iterator to the element to pop. |
Definition at line 270 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the position of an entity in a sparse set.
entt | A valid identifier. |
Definition at line 747 of file sparse_set.hpp.
|
inlinenoexcept |
Move assignment operator.
other | The instance to move from. |
Definition at line 462 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the entity at specified location, without bounds checking.
pos | The position for which to return the entity. |
Definition at line 766 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the deletion policy of a sparse set.
Definition at line 499 of file sparse_set.hpp.
|
inlineprotectedvirtual |
Erases entities from a sparse set.
first | An iterator to the first element of the range of entities. |
last | An iterator past the last element of the range of entities. |
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Mask, Registry::entity_type, Allocator >.
Definition at line 282 of file sparse_set.hpp.
|
inlineprotectedvirtual |
Erases all entities of a sparse set.
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Mask, Registry::entity_type, Allocator >.
Definition at line 303 of file sparse_set.hpp.
|
inline |
Assigns an entity to a sparse set.
entt | A valid identifier. |
elem | Optional opaque element to forward to mixins, if any. |
end()
iterator otherwise. Definition at line 802 of file sparse_set.hpp.
|
inline |
Assigns one or more entities to a sparse set.
It | Type of input iterator. |
first | An iterator to the first element of the range of entities. |
last | An iterator past the last element of the range of entities. |
end()
iterator otherwise. Definition at line 820 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 639 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 683 of file sparse_set.hpp.
|
inline |
Removes an entity from a sparse set if it exists.
entt | A valid identifier. |
Definition at line 885 of file sparse_set.hpp.
|
inline |
Removes entities from a sparse set if they exist.
It | Type of input iterator. |
first | An iterator to the first element of the range of entities. |
last | An iterator past the last element of the range of entities. |
Definition at line 897 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the end.
Definition at line 653 of file sparse_set.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning. Useful only in case of swap-only policy.
If the sparse set is empty, the returned iterator will be equal to rend()
.
Definition at line 693 of file sparse_set.hpp.
|
inlinevirtual |
Increases the capacity of a sparse set.
If the new capacity is greater than the current capacity, new storage is allocated, otherwise the method does nothing.
cap | Desired capacity. |
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Mask, Registry::entity_type, Allocator >.
Definition at line 528 of file sparse_set.hpp.
|
inlinevirtual |
Requests the removal of unused capacity.
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Mask, Registry::entity_type, Allocator >.
Definition at line 542 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the number of elements in a sparse set.
The number of elements is also the size of the internal packed array. There is no guarantee that the internal sparse array has the same size. Usually the size of the internal sparse array is equal or greater than the one of the internal packed array.
Definition at line 570 of file sparse_set.hpp.
|
inline |
Sort all elements according to the given comparison function.
Compare | Type of comparison function object. |
Sort | Type of sort function object. |
Args | Types of arguments to forward to the sort function object. |
compare | A valid comparison function object. |
algo | A valid sort function object. |
args | Arguments to forward to the sort function object, if any. |
Definition at line 1036 of file sparse_set.hpp.
|
inline |
Sort entities according to their order in a range.
other | The sparse sets that imposes the order of the entities. |
Definition at line 1072 of file sparse_set.hpp.
|
inline |
Sort entities according to their order in a range.
Entities that are part of both the sparse set and the range are ordered internally according to the order they have in the range.
All other entities goes to the end of the sparse set and there are no guarantees on their order.
It | Type of input iterator. |
first | An iterator to the first element of the range of entities. |
last | An iterator past the last element of the range of entities. |
Definition at line 1053 of file sparse_set.hpp.
|
inline |
Sort the first count elements according to the given comparison function.
The comparison function object must return true
if the first element is less than the second one, false
otherwise. The signature of the comparison function should be equivalent to the following:
Moreover, the comparison function object shall induce a strict weak ordering on the values.
The sort function object must offer a member function template operator()
that accepts three arguments:
Compare | Type of comparison function object. |
Sort | Type of sort function object. |
Args | Types of arguments to forward to the sort function object. |
length | Number of elements to sort. |
compare | A valid comparison function object. |
algo | A valid sort function object. |
args | Arguments to forward to the sort function object, if any. |
Definition at line 1001 of file sparse_set.hpp.
|
inline |
Exchanges the contents with those of a given sparse set.
other | Sparse set to exchange the content with. |
Definition at line 478 of file sparse_set.hpp.
|
inlineprotected |
Erases an entity from a sparse set.
it | An iterator to the element to pop. |
Definition at line 253 of file sparse_set.hpp.
|
inline |
Swaps two entities in a sparse set.
For what it's worth, this function affects both the internal sparse array and the internal packed array. Users should not care of that anyway.
lhs | A valid identifier. |
rhs | A valid identifier. |
Definition at line 961 of file sparse_set.hpp.
|
inlineprotected |
Erases an entity from a sparse set.
it | An iterator to the element to pop. |
Definition at line 242 of file sparse_set.hpp.
|
inlineprotectedvirtual |
Assigns an entity to a sparse set.
entt | A valid identifier. |
force_back | Force back insertion. |
Reimplemented in entt::basic_storage< Type, Entity, Allocator, typename >, and entt::basic_storage< Entity, Entity, Allocator >.
Definition at line 333 of file sparse_set.hpp.
|
inlinenoexcept |
Returned value type, if any.
Definition at line 1089 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the element assigned to an entity, if any.
entt | A valid identifier. |
Definition at line 781 of file sparse_set.hpp.
|
inlinenoexcept |
Returns the element assigned to an entity, if any.
entt | A valid identifier. |
Definition at line 786 of file sparse_set.hpp.