EnTT  3.10.0
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
entt::basic_sparse_set< Entity, Allocator > Class Template Reference

Basic sparse set implementation. More...

#include <sparse_set.hpp>

Inheritance diagram for entt::basic_sparse_set< Entity, Allocator >:
Inheritance graph
[legend]

Public Types

using allocator_type = Allocator
 Allocator type.
 
using entity_type = Entity
 Underlying entity identifier.
 
using version_type = typename entity_traits::version_type
 Underlying version type.
 
using size_type = typename packed_container_type::size_type
 Unsigned integer 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 = reverse_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. More...
 
 basic_sparse_set (deletion_policy pol, const allocator_type &allocator={})
 Constructs an empty container with the given policy and allocator. More...
 
 basic_sparse_set (const type_info &value, deletion_policy pol=deletion_policy::swap_and_pop, const allocator_type &allocator={})
 Constructs an empty container with the given value type, policy and allocator. More...
 
 basic_sparse_set (basic_sparse_set &&other)
 Move constructor. More...
 
 basic_sparse_set (basic_sparse_set &&other, const allocator_type &allocator)
 Allocator-extended move constructor. More...
 
virtual ~basic_sparse_set ()
 Default destructor.
 
basic_sparse_setoperator= (basic_sparse_set &&other)
 Move assignment operator. More...
 
void swap (basic_sparse_set &other)
 Exchanges the contents with those of a given sparse set. More...
 
constexpr allocator_type get_allocator () const
 Returns the associated allocator. More...
 
deletion_policy policy () const
 Returns the deletion policy of a sparse set. More...
 
virtual void reserve (const size_type cap)
 Increases the capacity of a sparse set. More...
 
virtual size_type capacity () const
 Returns the number of elements that a sparse set has currently allocated space for. More...
 
virtual void shrink_to_fit ()
 Requests the removal of unused capacity.
 
size_type extent () const
 Returns the extent of a sparse set. More...
 
size_type size () const
 Returns the number of elements in a sparse set. More...
 
bool empty () const
 Checks whether a sparse set is empty. More...
 
pointer data () const
 Direct access to the internal packed array. More...
 
const_iterator begin () const
 Returns an iterator to the beginning. More...
 
const_iterator cbegin () const
 Returns an iterator to the beginning. More...
 
iterator end () const
 Returns an iterator to the end. More...
 
const_iterator cend () const
 Returns an iterator to the end. More...
 
const_reverse_iterator rbegin () const
 Returns a reverse iterator to the beginning. More...
 
const_reverse_iterator crbegin () const
 Returns a reverse iterator to the beginning. More...
 
reverse_iterator rend () const
 Returns a reverse iterator to the end. More...
 
const_reverse_iterator crend () const
 Returns a reverse iterator to the end. More...
 
iterator find (const entity_type entt) const
 Finds an entity. More...
 
bool contains (const entity_type entt) const
 Checks if a sparse set contains an entity. More...
 
version_type current (const entity_type entt) const
 Returns the contained version for an identifier. More...
 
size_type index (const entity_type entt) const
 Returns the position of an entity in a sparse set. More...
 
entity_type at (const size_type pos) const
 Returns the entity at specified location, with bounds checking. More...
 
entity_type operator[] (const size_type pos) const
 Returns the entity at specified location, without bounds checking. More...
 
const void * get (const entity_type entt) const
 Returns the element assigned to an entity, if any. More...
 
void * get (const entity_type entt)
 Returns the element assigned to an entity, if any. More...
 
iterator emplace (const entity_type entt, const void *value=nullptr)
 Assigns an entity to a sparse set. More...
 
void bump (const entity_type entt)
 Bump the version number of an entity. More...
 
template<typename It >
iterator insert (It first, It last)
 Assigns one or more entities to a sparse set. More...
 
void erase (const entity_type entt)
 Erases an entity from a sparse set. More...
 
template<typename It >
void erase (It first, It last)
 Erases entities from a set. More...
 
bool remove (const entity_type entt)
 Removes an entity from a sparse set if it exists. More...
 
template<typename It >
size_type remove (It first, It last)
 Removes entities from a sparse set if they exist. More...
 
void compact ()
 Removes all tombstones from the packed array of a sparse set.
 
void swap_elements (const entity_type lhs, const entity_type rhs)
 Swaps two entities in a sparse set. More...
 
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. More...
 
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. More...
 
void respect (const basic_sparse_set &other)
 Sort entities according to their order in another sparse set. More...
 
void clear ()
 Clears a sparse set.
 
const type_infotype () const
 Returned value type, if any. More...
 
virtual void bind (any)
 Forwards variables to mixins, if any.
 

Protected Types

using basic_iterator = internal::sparse_set_iterator< packed_container_type >
 Random access iterator type.
 

Protected Member Functions

virtual void swap_and_pop (basic_iterator first, basic_iterator last)
 Erases entities from a sparse set. More...
 
virtual void in_place_pop (basic_iterator first, basic_iterator last)
 Erases entities from a sparse set. More...
 
virtual basic_iterator try_emplace (const Entity entt, const bool force_back, const void *=nullptr)
 Assigns an entity to a sparse set. More...
 

Detailed Description

template<typename Entity, typename Allocator>
class entt::basic_sparse_set< Entity, Allocator >

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 is largely used by the registry to offer users the fastest access ever to the components. Views and groups in general are almost entirely designed around sparse sets.

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.

Note
Internal data structures arrange elements to maximize performance. There are no guarantees that entities are returned in the insertion order when iterate a sparse set. Do not make assumption on the order in any case.
Template Parameters
EntityA valid entity type (see entt_traits for more details).
AllocatorType of allocator used to manage memory and elements.

Definition at line 174 of file sparse_set.hpp.

Constructor & Destructor Documentation

◆ basic_sparse_set() [1/5]

template<typename Entity , typename Allocator >
entt::basic_sparse_set< Entity, Allocator >::basic_sparse_set ( const allocator_type allocator)
inlineexplicit

Constructs an empty container with a given allocator.

Parameters
allocatorThe allocator to use.

Definition at line 314 of file sparse_set.hpp.

◆ basic_sparse_set() [2/5]

template<typename Entity , typename Allocator >
entt::basic_sparse_set< Entity, Allocator >::basic_sparse_set ( deletion_policy  pol,
const allocator_type allocator = {} 
)
inlineexplicit

Constructs an empty container with the given policy and allocator.

Parameters
polType of deletion policy.
allocatorThe allocator to use (possibly default-constructed).

Definition at line 322 of file sparse_set.hpp.

◆ basic_sparse_set() [3/5]

template<typename Entity , typename Allocator >
entt::basic_sparse_set< Entity, Allocator >::basic_sparse_set ( const type_info value,
deletion_policy  pol = deletion_policy::swap_and_pop,
const allocator_type allocator = {} 
)
inlineexplicit

Constructs an empty container with the given value type, policy and allocator.

Parameters
valueReturned value type, if any.
polType of deletion policy.
allocatorThe allocator to use (possibly default-constructed).

Definition at line 332 of file sparse_set.hpp.

◆ basic_sparse_set() [4/5]

template<typename Entity , typename Allocator >
entt::basic_sparse_set< Entity, Allocator >::basic_sparse_set ( basic_sparse_set< Entity, Allocator > &&  other)
inline

Move constructor.

Parameters
otherThe instance to move from.

Definition at line 343 of file sparse_set.hpp.

◆ basic_sparse_set() [5/5]

template<typename Entity , typename Allocator >
entt::basic_sparse_set< Entity, Allocator >::basic_sparse_set ( basic_sparse_set< Entity, Allocator > &&  other,
const allocator_type allocator 
)
inline

Allocator-extended move constructor.

Parameters
otherThe instance to move from.
allocatorThe allocator to use.

Definition at line 355 of file sparse_set.hpp.

Member Function Documentation

◆ at()

template<typename Entity , typename Allocator >
entity_type entt::basic_sparse_set< Entity, Allocator >::at ( const size_type  pos) const
inline

Returns the entity at specified location, with bounds checking.

Parameters
posThe position for which to return the entity.
Returns
The entity at specified location if any, a null entity otherwise.

Definition at line 615 of file sparse_set.hpp.

◆ begin()

template<typename Entity , typename Allocator >
const_iterator entt::basic_sparse_set< Entity, Allocator >::begin ( ) const
inline

Returns an iterator to the beginning.

The returned iterator points to the first entity of the internal packed array. If the sparse set is empty, the returned iterator will be equal to end().

Returns
An iterator to the first entity of the sparse set.

Definition at line 494 of file sparse_set.hpp.

◆ bump()

template<typename Entity , typename Allocator >
void entt::basic_sparse_set< Entity, Allocator >::bump ( const entity_type  entt)
inline

Bump the version number of an entity.

Warning
Attempting to bump the version of an entity that doesn't belong to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.

Definition at line 673 of file sparse_set.hpp.

◆ capacity()

template<typename Entity , typename Allocator >
virtual size_type entt::basic_sparse_set< Entity, Allocator >::capacity ( ) const
inlinevirtual

Returns the number of elements that a sparse set has currently allocated space for.

Returns
Capacity of the sparse set.

Reimplemented in entt::basic_storage< Entity, Type, Allocator, typename >, and entt::basic_storage< entity_type, payload_type >.

Definition at line 432 of file sparse_set.hpp.

◆ cbegin()

template<typename Entity , typename Allocator >
const_iterator entt::basic_sparse_set< Entity, Allocator >::cbegin ( ) const
inline

Returns an iterator to the beginning.

The returned iterator points to the first entity of the internal packed array. If the sparse set is empty, the returned iterator will be equal to end().

Returns
An iterator to the first entity of the sparse set.

Definition at line 500 of file sparse_set.hpp.

◆ cend()

template<typename Entity , typename Allocator >
const_iterator entt::basic_sparse_set< Entity, Allocator >::cend ( ) const
inline

Returns an iterator to the end.

The returned iterator points to the element following the last entity in a sparse set. Attempting to dereference the returned iterator results in undefined behavior.

Returns
An iterator to the element following the last entity of a sparse set.

Definition at line 519 of file sparse_set.hpp.

◆ contains()

template<typename Entity , typename Allocator >
bool entt::basic_sparse_set< Entity, Allocator >::contains ( const entity_type  entt) const
inline

Checks if a sparse set contains an entity.

Parameters
enttA valid identifier.
Returns
True if the sparse set contains the entity, false otherwise.

Definition at line 576 of file sparse_set.hpp.

◆ crbegin()

template<typename Entity , typename Allocator >
const_reverse_iterator entt::basic_sparse_set< Entity, Allocator >::crbegin ( ) const
inline

Returns a reverse iterator to the beginning.

The returned iterator points to the first entity of the reversed internal packed array. If the sparse set is empty, the returned iterator will be equal to rend().

Returns
An iterator to the first entity of the reversed internal packed array.

Definition at line 538 of file sparse_set.hpp.

◆ crend()

template<typename Entity , typename Allocator >
const_reverse_iterator entt::basic_sparse_set< Entity, Allocator >::crend ( ) const
inline

Returns a reverse iterator to the end.

The returned iterator points to the element following the last entity in the reversed sparse set. Attempting to dereference the returned iterator results in undefined behavior.

Returns
An iterator to the element following the last entity of the reversed sparse set.

Definition at line 557 of file sparse_set.hpp.

◆ current()

template<typename Entity , typename Allocator >
version_type entt::basic_sparse_set< Entity, Allocator >::current ( const entity_type  entt) const
inline

Returns the contained version for an identifier.

Parameters
enttA valid identifier.
Returns
The version for the given identifier if present, the tombstone version otherwise.

Definition at line 589 of file sparse_set.hpp.

◆ data()

template<typename Entity , typename Allocator >
pointer entt::basic_sparse_set< Entity, Allocator >::data ( ) const
inline

Direct access to the internal packed array.

Returns
A pointer to the internal packed array.

Definition at line 481 of file sparse_set.hpp.

◆ emplace()

template<typename Entity , typename Allocator >
iterator entt::basic_sparse_set< Entity, Allocator >::emplace ( const entity_type  entt,
const void *  value = nullptr 
)
inline

Assigns an entity to a sparse set.

Warning
Attempting to assign an entity that already belongs to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.
valueOptional opaque value to forward to mixins, if any.
Returns
Iterator pointing to the emplaced element in case of success, the end() iterator otherwise.

Definition at line 660 of file sparse_set.hpp.

◆ empty()

template<typename Entity , typename Allocator >
bool entt::basic_sparse_set< Entity, Allocator >::empty ( ) const
inline

Checks whether a sparse set is empty.

Returns
True if the sparse set is empty, false otherwise.

Definition at line 473 of file sparse_set.hpp.

◆ end()

template<typename Entity , typename Allocator >
iterator entt::basic_sparse_set< Entity, Allocator >::end ( ) const
inline

Returns an iterator to the end.

The returned iterator points to the element following the last entity in a sparse set. Attempting to dereference the returned iterator results in undefined behavior.

Returns
An iterator to the element following the last entity of a sparse set.

Definition at line 514 of file sparse_set.hpp.

◆ erase() [1/2]

template<typename Entity , typename Allocator >
void entt::basic_sparse_set< Entity, Allocator >::erase ( const entity_type  entt)
inline

Erases an entity from a sparse set.

Warning
Attempting to erase an entity that doesn't belong to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.

Definition at line 710 of file sparse_set.hpp.

◆ erase() [2/2]

template<typename Entity , typename Allocator >
template<typename It >
void entt::basic_sparse_set< Entity, Allocator >::erase ( It  first,
It  last 
)
inline

Erases entities from a set.

See also
erase
Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Definition at line 725 of file sparse_set.hpp.

◆ extent()

template<typename Entity , typename Allocator >
size_type entt::basic_sparse_set< Entity, Allocator >::extent ( ) const
inline

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.

Returns
Extent of the sparse set.

Definition at line 451 of file sparse_set.hpp.

◆ find()

template<typename Entity , typename Allocator >
iterator entt::basic_sparse_set< Entity, Allocator >::find ( const entity_type  entt) const
inline

Finds an entity.

Parameters
enttA valid identifier.
Returns
An iterator to the given entity if it's found, past the end iterator otherwise.

Definition at line 567 of file sparse_set.hpp.

◆ get() [1/2]

template<typename Entity , typename Allocator >
void* entt::basic_sparse_set< Entity, Allocator >::get ( const entity_type  entt)
inline

Returns the element assigned to an entity, if any.

Warning
Attempting to use an entity that doesn't belong to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.
Returns
An opaque pointer to the element assigned to the entity, if any.

Definition at line 644 of file sparse_set.hpp.

◆ get() [2/2]

template<typename Entity , typename Allocator >
const void* entt::basic_sparse_set< Entity, Allocator >::get ( const entity_type  entt) const
inline

Returns the element assigned to an entity, if any.

Warning
Attempting to use an entity that doesn't belong to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.
Returns
An opaque pointer to the element assigned to the entity, if any.

Definition at line 639 of file sparse_set.hpp.

◆ get_allocator()

template<typename Entity , typename Allocator >
constexpr allocator_type entt::basic_sparse_set< Entity, Allocator >::get_allocator ( ) const
inlineconstexpr

Returns the associated allocator.

Returns
The associated allocator.

Definition at line 403 of file sparse_set.hpp.

◆ in_place_pop()

template<typename Entity , typename Allocator >
virtual void entt::basic_sparse_set< Entity, Allocator >::in_place_pop ( basic_iterator  first,
basic_iterator  last 
)
inlineprotectedvirtual

Erases entities from a sparse set.

Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Reimplemented in entt::basic_storage< Entity, Type, Allocator, typename >, and entt::basic_storage< entity_type, payload_type >.

Definition at line 258 of file sparse_set.hpp.

◆ index()

template<typename Entity , typename Allocator >
size_type entt::basic_sparse_set< Entity, Allocator >::index ( const entity_type  entt) const
inline

Returns the position of an entity in a sparse set.

Warning
Attempting to get the position of an entity that doesn't belong to the sparse set results in undefined behavior.
Parameters
enttA valid identifier.
Returns
The position of the entity in the sparse set.

Definition at line 605 of file sparse_set.hpp.

◆ insert()

template<typename Entity , typename Allocator >
template<typename It >
iterator entt::basic_sparse_set< Entity, Allocator >::insert ( It  first,
It  last 
)
inline

Assigns one or more entities to a sparse set.

Warning
Attempting to assign an entity that already belongs to the sparse set results in undefined behavior.
Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
Returns
Iterator pointing to the first element inserted in case of success, the end() iterator otherwise.

Definition at line 693 of file sparse_set.hpp.

◆ operator=()

template<typename Entity , typename Allocator >
basic_sparse_set& entt::basic_sparse_set< Entity, Allocator >::operator= ( basic_sparse_set< Entity, Allocator > &&  other)
inline

Move assignment operator.

Parameters
otherThe instance to move from.
Returns
This sparse set.

Definition at line 374 of file sparse_set.hpp.

◆ operator[]()

template<typename Entity , typename Allocator >
entity_type entt::basic_sparse_set< Entity, Allocator >::operator[] ( const size_type  pos) const
inline

Returns the entity at specified location, without bounds checking.

Parameters
posThe position for which to return the entity.
Returns
The entity at specified location.

Definition at line 624 of file sparse_set.hpp.

◆ policy()

template<typename Entity , typename Allocator >
deletion_policy entt::basic_sparse_set< Entity, Allocator >::policy ( ) const
inline

Returns the deletion policy of a sparse set.

Returns
The deletion policy of the sparse set.

Definition at line 411 of file sparse_set.hpp.

◆ rbegin()

template<typename Entity , typename Allocator >
const_reverse_iterator entt::basic_sparse_set< Entity, Allocator >::rbegin ( ) const
inline

Returns a reverse iterator to the beginning.

The returned iterator points to the first entity of the reversed internal packed array. If the sparse set is empty, the returned iterator will be equal to rend().

Returns
An iterator to the first entity of the reversed internal packed array.

Definition at line 533 of file sparse_set.hpp.

◆ remove() [1/2]

template<typename Entity , typename Allocator >
bool entt::basic_sparse_set< Entity, Allocator >::remove ( const entity_type  entt)
inline

Removes an entity from a sparse set if it exists.

Parameters
enttA valid identifier.
Returns
True if the entity is actually removed, false otherwise.

Definition at line 740 of file sparse_set.hpp.

◆ remove() [2/2]

template<typename Entity , typename Allocator >
template<typename It >
size_type entt::basic_sparse_set< Entity, Allocator >::remove ( It  first,
It  last 
)
inline

Removes entities from a sparse set if they exist.

Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
Returns
The number of entities actually removed.

Definition at line 752 of file sparse_set.hpp.

◆ rend()

template<typename Entity , typename Allocator >
reverse_iterator entt::basic_sparse_set< Entity, Allocator >::rend ( ) const
inline

Returns a reverse iterator to the end.

The returned iterator points to the element following the last entity in the reversed sparse set. Attempting to dereference the returned iterator results in undefined behavior.

Returns
An iterator to the element following the last entity of the reversed sparse set.

Definition at line 552 of file sparse_set.hpp.

◆ reserve()

template<typename Entity , typename Allocator >
virtual void entt::basic_sparse_set< Entity, Allocator >::reserve ( const size_type  cap)
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.

Parameters
capDesired capacity.

Reimplemented in entt::basic_storage< entity_type, payload_type >.

Definition at line 423 of file sparse_set.hpp.

◆ respect()

template<typename Entity , typename Allocator >
void entt::basic_sparse_set< Entity, Allocator >::respect ( const basic_sparse_set< Entity, Allocator > &  other)
inline

Sort entities according to their order in another sparse set.

Entities that are part of both the sparse sets are ordered internally according to the order they have in other. All the other entities goes to the end of the list and there are no guarantees on their order.
In other terms, this function can be used to impose the same order on two sets by using one of them as a master and the other one as a slave.

Iterating the sparse set with a couple of iterators returns elements in the expected order after a call to respect. See begin and end for more details.

Parameters
otherThe sparse sets that imposes the order of the entities.

Definition at line 903 of file sparse_set.hpp.

◆ size()

template<typename Entity , typename Allocator >
size_type entt::basic_sparse_set< Entity, Allocator >::size ( ) const
inline

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.

Returns
Number of elements.

Definition at line 465 of file sparse_set.hpp.

◆ sort()

template<typename Entity , typename Allocator >
template<typename Compare , typename Sort = std_sort, typename... Args>
void entt::basic_sparse_set< Entity, Allocator >::sort ( Compare  compare,
Sort  algo = Sort{},
Args &&...  args 
)
inline

Sort all elements according to the given comparison function.

See also
sort_n
Template Parameters
CompareType of comparison function object.
SortType of sort function object.
ArgsTypes of arguments to forward to the sort function object.
Parameters
compareA valid comparison function object.
algoA valid sort function object.
argsArguments to forward to the sort function object, if any.

Definition at line 883 of file sparse_set.hpp.

◆ sort_n()

template<typename Entity , typename Allocator >
template<typename Compare , typename Sort = std_sort, typename... Args>
void entt::basic_sparse_set< Entity, Allocator >::sort_n ( const size_type  length,
Compare  compare,
Sort  algo = Sort{},
Args &&...  args 
)
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:

bool(const Entity, const Entity);

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:

  • An iterator to the first element of the range to sort.
  • An iterator past the last element of the range to sort.
  • A comparison function to use to compare the elements.
Template Parameters
CompareType of comparison function object.
SortType of sort function object.
ArgsTypes of arguments to forward to the sort function object.
Parameters
lengthNumber of elements to sort.
compareA valid comparison function object.
algoA valid sort function object.
argsArguments to forward to the sort function object, if any.

Definition at line 848 of file sparse_set.hpp.

◆ swap()

template<typename Entity , typename Allocator >
void entt::basic_sparse_set< Entity, Allocator >::swap ( basic_sparse_set< Entity, Allocator > &  other)
inline

Exchanges the contents with those of a given sparse set.

Parameters
otherSparse set to exchange the content with.

Definition at line 390 of file sparse_set.hpp.

◆ swap_and_pop()

template<typename Entity , typename Allocator >
virtual void entt::basic_sparse_set< Entity, Allocator >::swap_and_pop ( basic_iterator  first,
basic_iterator  last 
)
inlineprotectedvirtual

Erases entities from a sparse set.

Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Reimplemented in entt::basic_storage< Entity, Type, Allocator, typename >, and entt::basic_storage< entity_type, payload_type >.

Definition at line 241 of file sparse_set.hpp.

◆ swap_elements()

template<typename Entity , typename Allocator >
void entt::basic_sparse_set< Entity, Allocator >::swap_elements ( const entity_type  lhs,
const entity_type  rhs 
)
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.

Warning
Attempting to swap entities that don't belong to the sparse set results in undefined behavior.
Parameters
lhsA valid identifier.
rhsA valid identifier.

Definition at line 799 of file sparse_set.hpp.

◆ try_emplace()

template<typename Entity , typename Allocator >
virtual basic_iterator entt::basic_sparse_set< Entity, Allocator >::try_emplace ( const Entity  entt,
const bool  force_back,
const void *  = nullptr 
)
inlineprotectedvirtual

Assigns an entity to a sparse set.

Parameters
enttA valid identifier.
force_backForce back insertion.
Returns
Iterator pointing to the emplaced element.

Definition at line 271 of file sparse_set.hpp.

◆ type()

template<typename Entity , typename Allocator >
const type_info& entt::basic_sparse_set< Entity, Allocator >::type ( ) const
inline

Returned value type, if any.

Returns
Returned value type, if any.

Definition at line 942 of file sparse_set.hpp.


The documentation for this class was generated from the following files: