gaia::cnt::darr_soa< T, Allocator > Class Template Reference

Array with variable size of elements of type. More...

#include <darray_soa_impl.h>

Public Types
using	value_type = T
	Element type stored by the container.
using	reference = T &
	Mutable element reference type.
using	const_reference = const T &
	Read-only element reference type.
using	pointer = T *
	Mutable element pointer type.
using	const_pointer = const T *
	Read-only element pointer type.
using	view_policy = mem::data_view_policy_soa< T::gaia_Data_Layout, T >
	Data-layout access policy used by the container.
using	difference_type = darr_soa_detail::difference_type
	Type used for iterator differences.
using	size_type = darr_soa_detail::size_type
	Unsigned type used for sizes and indices.
using	iterator = darr_soa_iterator< T >
	Mutable random-access iterator type.
using	const_iterator = const_darr_soa_iterator< T >
	Read-only random-access iterator type.
using	iterator_category = core::random_access_iterator_tag
	Iterator category exposed by the container.

Public Member Functions
	darr_soa (core::zero_t) noexcept
	Constructs a value-initialized container.
	darr_soa (size_type count, const_reference value)
	Constructs a container with copies of a value.
	darr_soa (size_type count)
	Constructs a container with the requested number of value-initialized elements.
template<typename InputIt >
	darr_soa (InputIt first, InputIt last)
	Constructs a container from an iterator range.
	darr_soa (std::initializer_list< T > il)
	Constructs a container from an initializer list.
	darr_soa (const darr_soa &other)
	Copy-constructs a container.
	darr_soa (darr_soa &&other) noexcept
	Move-constructs a container.
darr_soa &	operator= (std::initializer_list< T > il)
	Replaces the elements from an initializer list.
darr_soa &	operator= (const darr_soa &other)
	Copy-assigns the container.
darr_soa &	operator= (darr_soa &&other) noexcept
	Move-assigns the container.
GAIA_NODISCARD pointer	data () noexcept
	Returns a pointer to the element storage.
GAIA_NODISCARD const_pointer	data () const noexcept
	Returns a pointer to the element storage.
GAIA_NODISCARD decltype(auto)	operator[] (size_type pos) noexcept
	Accesses an element without bounds checking in optimized builds.
GAIA_NODISCARD decltype(auto)	operator[] (size_type pos) const noexcept
	Accesses an element without bounds checking in optimized builds.
void	reserve (size_type cap)
	Ensures storage for at least the requested number of elements.
void	resize (size_type count)
	Changes the number of elements.
void	resize (size_type count, const_reference value)
	Changes the size and initializes new elements from a value.
void	push_back (const T &arg)
	Appends an element.
void	push_back (T &&arg)
	Appends an element.
template<typename... Args>
decltype(auto)	emplace_back (Args &&... args)
	Constructs and appends an element.
void	pop_back () noexcept
	Removes the last element.
iterator	insert (iterator pos, const T &arg)
	Insert the element to the position given by iterator pos.
iterator	insert (iterator pos, T &&arg)
	Insert the element to the position given by iterator pos.
iterator	erase (iterator pos) noexcept
	Removes the element at pos.
iterator	erase (iterator first, iterator last) noexcept
	Removes the elements in the range [first, last)
void	clear () noexcept
	Removes all elements.
void	shrink_to_fit ()
	Reduces allocated storage to match the current size when possible.
template<typename Func >
auto	retain (Func &&func) noexcept
	Removes all elements that fail the predicate.
GAIA_NODISCARD size_type	size () const noexcept
	Returns the number of elements.
GAIA_NODISCARD bool	empty () const noexcept
	Checks whether the container has no elements.
GAIA_NODISCARD size_type	capacity () const noexcept
	Returns the number of elements that fit without reallocation.
GAIA_NODISCARD size_type	max_size () const noexcept
	Returns the maximum number of elements supported by this container.
GAIA_NODISCARD decltype(auto)	front () noexcept
	Accesses the first element.
GAIA_NODISCARD decltype(auto)	front () const noexcept
	Accesses the first element.
GAIA_NODISCARD decltype(auto)	back () noexcept
	Accesses the last element.
GAIA_NODISCARD decltype(auto)	back () const noexcept
	Accesses the last element.
GAIA_NODISCARD auto	begin () noexcept
	Returns an iterator to the first element.
GAIA_NODISCARD auto	begin () const noexcept
	Returns an iterator to the first element.
GAIA_NODISCARD auto	cbegin () const noexcept
	Returns a read-only iterator to the first element.
GAIA_NODISCARD auto	rbegin () noexcept
	Returns a reverse traversal iterator to the last element.
GAIA_NODISCARD auto	rbegin () const noexcept
	Returns a reverse traversal iterator to the last element.
GAIA_NODISCARD auto	crbegin () const noexcept
	Returns a read-only reverse traversal iterator to the last element.
GAIA_NODISCARD auto	end () noexcept
	Returns an iterator one past the last element.
GAIA_NODISCARD auto	end () const noexcept
	Returns an iterator one past the last element.
GAIA_NODISCARD auto	cend () const noexcept
	Returns a read-only iterator one past the last element.
GAIA_NODISCARD auto	rend () noexcept
	Returns the reverse traversal sentinel preceding the first element.
GAIA_NODISCARD auto	rend () const noexcept
	Returns the reverse traversal sentinel preceding the first element.
GAIA_NODISCARD auto	crend () const noexcept
	Returns the read-only reverse traversal sentinel preceding the first element.
GAIA_NODISCARD bool	operator== (const darr_soa &other) const noexcept
	Compares two containers element by element.
GAIA_NODISCARD constexpr bool	operator!= (const darr_soa &other) const noexcept
	Checks whether two containers differ.
template<size_t Item>
auto	view_mut () noexcept
	Returns a mutable view of one structure-of-arrays member.
template<size_t Item>
auto	view () const noexcept
	Returns a read-only view of one structure-of-arrays member.

Detailed Description

template<typename T, typename Allocator = mem::DefaultAllocatorAdaptor>
class gaia::cnt::darr_soa< T, Allocator >

Array with variable size of elements of type.

Template Parameters

T	allocated on heap. Interface compatiblity with std::vector where it matters. Can be used only with SoA types.

Constructor & Destructor Documentation

darr_soa() [1/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( size_type  count, const_reference  value  )

inline

Constructs a container with copies of a value.

Parameters

count	Number of elements.
value	Value assigned to each new element.

darr_soa() [2/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( size_type  count )

inline

Constructs a container with the requested number of value-initialized elements.

Parameters

count

Number of elements.

darr_soa() [3/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

template<typename InputIt >

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( InputIt  first, InputIt  last  )

inline

Constructs a container from an iterator range.

Template Parameters

InputIt

Input iterator type.

Parameters

first	Iterator to the first source element.
last	Iterator one past the last source element.

darr_soa() [4/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( std::initializer_list< T >  il )

inline

Constructs a container from an initializer list.

Parameters

il	Initializer list supplying the elements.

darr_soa() [5/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( const darr_soa< T, Allocator > &  other )

inline

Copy-constructs a container.

Parameters

other

Container to copy or move from.

darr_soa() [6/6]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

gaia::cnt::darr_soa< T, Allocator >::darr_soa ( darr_soa< T, Allocator > &&  other )

inlinenoexcept

Move-constructs a container.

Parameters

other

Container to copy or move from.

Member Function Documentation

back() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::back ( ) const

inlinenoexcept

Accesses the last element.

Returns

Reference to the last element.

back() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::back ( )

inlinenoexcept

Accesses the last element.

Returns

Reference to the last element.

begin() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::begin ( ) const

inlinenoexcept

Returns an iterator to the first element.

Returns

Iterator to the first element.

begin() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::begin ( )

inlinenoexcept

Returns an iterator to the first element.

Returns

Iterator to the first element.

capacity()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD size_type gaia::cnt::darr_soa< T, Allocator >::capacity ( ) const

inlinenoexcept

Returns the number of elements that fit without reallocation.

Returns

Current element capacity.

cbegin()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::cbegin ( ) const

inlinenoexcept

Returns a read-only iterator to the first element.

Returns

Iterator to the first element.

cend()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::cend ( ) const

inlinenoexcept

Returns a read-only iterator one past the last element.

Returns

Iterator one past the last element.

crbegin()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::crbegin ( ) const

inlinenoexcept

Returns a read-only reverse traversal iterator to the last element.

Returns

Iterator to the last element.

crend()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::crend ( ) const

inlinenoexcept

Returns the read-only reverse traversal sentinel preceding the first element.

Returns

Reverse traversal sentinel preceding the first element.

data() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD const_pointer gaia::cnt::darr_soa< T, Allocator >::data ( ) const

inlinenoexcept

Returns a pointer to the element storage.

Returns

Pointer to the first element storage location.

data() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD pointer gaia::cnt::darr_soa< T, Allocator >::data ( )

inlinenoexcept

Returns a pointer to the element storage.

Returns

Pointer to the first element storage location.

emplace_back()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

template<typename... Args>

decltype(auto) gaia::cnt::darr_soa< T, Allocator >::emplace_back ( Args &&...  args )

inline

Constructs and appends an element.

Template Parameters

Args	Types of the forwarded constructor arguments.

Parameters

args	Arguments forwarded to the element constructor.

Returns

No value. The deduced return type is void.

empty()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD bool gaia::cnt::darr_soa< T, Allocator >::empty ( ) const

inlinenoexcept

Checks whether the container has no elements.

Returns

True if the container contains no elements.

end() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::end ( ) const

inlinenoexcept

Returns an iterator one past the last element.

Returns

Iterator one past the last element.

end() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::end ( )

inlinenoexcept

Returns an iterator one past the last element.

Returns

Iterator one past the last element.

erase() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

iterator gaia::cnt::darr_soa< T, Allocator >::erase ( iterator  first, iterator  last  )

inlinenoexcept

Removes the elements in the range [first, last)

Returns

Iterator to the element following the removed element or range.

Parameters

first	Iterator to the element to remove
last	Iterator to the one beyond the last element to remove

erase() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

iterator gaia::cnt::darr_soa< T, Allocator >::erase ( iterator  pos )

inlinenoexcept

Removes the element at pos.

Returns

Iterator to the element following the removed element or range.

Parameters

pos	Iterator to the element to remove

front() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::front ( ) const

inlinenoexcept

Accesses the first element.

Returns

Reference to the first element.

front() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::front ( )

inlinenoexcept

Accesses the first element.

Returns

Reference to the first element.

insert() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

iterator gaia::cnt::darr_soa< T, Allocator >::insert ( iterator  pos, const T &  arg  )

inline

Insert the element to the position given by iterator pos.

Returns

Iterator to the inserted element.

Parameters

pos	Position in the container
arg	Data to insert

insert() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

iterator gaia::cnt::darr_soa< T, Allocator >::insert ( iterator  pos, T &&  arg  )

inline

Insert the element to the position given by iterator pos.

Returns

Iterator to the inserted element.

Parameters

pos	Position in the container
arg	Data to insert

max_size()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD size_type gaia::cnt::darr_soa< T, Allocator >::max_size ( ) const

inlinenoexcept

Returns the maximum number of elements supported by this container.

Returns

Maximum supported element count.

operator!=()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD constexpr bool gaia::cnt::darr_soa< T, Allocator >::operator!= ( const darr_soa< T, Allocator > &  other ) const

inlineconstexprnoexcept

Checks whether two containers differ.

Parameters

other

Container to copy or move from.

Returns

True if the containers differ.

operator=() [1/3]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

darr_soa & gaia::cnt::darr_soa< T, Allocator >::operator= ( const darr_soa< T, Allocator > &  other )

inline

Copy-assigns the container.

Parameters

other

Container to copy or move from.

Returns

Reference to this container.

operator=() [2/3]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

darr_soa & gaia::cnt::darr_soa< T, Allocator >::operator= ( darr_soa< T, Allocator > &&  other )

inlinenoexcept

Move-assigns the container.

Parameters

other

Container to copy or move from.

Returns

Reference to this container.

operator=() [3/3]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

darr_soa & gaia::cnt::darr_soa< T, Allocator >::operator= ( std::initializer_list< T >  il )

inline

Replaces the elements from an initializer list.

Parameters

il	Initializer list supplying the elements.

Returns

Reference to this container.

operator==()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD bool gaia::cnt::darr_soa< T, Allocator >::operator== ( const darr_soa< T, Allocator > &  other ) const

inlinenoexcept

Compares two containers element by element.

Parameters

other

Container to copy or move from.

Returns

True if both containers contain equal elements.

operator[]() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::operator[] ( size_type  pos ) const

inlinenoexcept

Accesses an element without bounds checking in optimized builds.

Parameters

pos	Zero-based element index.

Returns

Reference to the selected element.

operator[]() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD decltype(auto) gaia::cnt::darr_soa< T, Allocator >::operator[] ( size_type  pos )

inlinenoexcept

Accesses an element without bounds checking in optimized builds.

Parameters

pos	Zero-based element index.

Returns

Reference to the selected element.

push_back() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

void gaia::cnt::darr_soa< T, Allocator >::push_back ( const T &  arg )

inline

Appends an element.

Parameters

arg	Element value to append.

push_back() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

void gaia::cnt::darr_soa< T, Allocator >::push_back ( T &&  arg )

inline

Appends an element.

Parameters

arg	Element value to append.

rbegin() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::rbegin ( ) const

inlinenoexcept

Returns a reverse traversal iterator to the last element.

Returns

Iterator to the last element.

rbegin() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::rbegin ( )

inlinenoexcept

Returns a reverse traversal iterator to the last element.

Returns

Iterator to the last element.

rend() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::rend ( ) const

inlinenoexcept

Returns the reverse traversal sentinel preceding the first element.

Returns

Reverse traversal sentinel preceding the first element.

rend() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD auto gaia::cnt::darr_soa< T, Allocator >::rend ( )

inlinenoexcept

Returns the reverse traversal sentinel preceding the first element.

Returns

Reverse traversal sentinel preceding the first element.

reserve()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

void gaia::cnt::darr_soa< T, Allocator >::reserve ( size_type  cap )

inline

Ensures storage for at least the requested number of elements.

Parameters

cap	Requested element capacity.

resize() [1/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

void gaia::cnt::darr_soa< T, Allocator >::resize ( size_type  count )

inline

Changes the number of elements.

Parameters

count

Number of elements.

resize() [2/2]

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

void gaia::cnt::darr_soa< T, Allocator >::resize ( size_type  count, const_reference  value  )

inline

Changes the size and initializes new elements from a value.

Parameters

count	Number of elements.
value	Value assigned to each new element.

retain()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

template<typename Func >

auto gaia::cnt::darr_soa< T, Allocator >::retain ( Func &&  func )

inlinenoexcept

Removes all elements that fail the predicate.

Template Parameters

Func	Predicate callable type.

Parameters

func	A lambda or a functor with the bool operator()(Container::value_type&) overload.

Returns

The new size of the array.

size()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

GAIA_NODISCARD size_type gaia::cnt::darr_soa< T, Allocator >::size ( ) const

inlinenoexcept

Returns the number of elements.

Returns

Current element count.

view()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

template<size_t Item>

auto gaia::cnt::darr_soa< T, Allocator >::view ( ) const

inlinenoexcept

Returns a read-only view of one structure-of-arrays member.

Template Parameters

Item	Zero-based member index in the structure-of-arrays element.

Returns

Read-only view of the selected member.

view_mut()

template<typename T , typename Allocator = mem::DefaultAllocatorAdaptor>

template<size_t Item>

auto gaia::cnt::darr_soa< T, Allocator >::view_mut ( )

inlinenoexcept

Returns a mutable view of one structure-of-arrays member.

Template Parameters

Item	Zero-based member index in the structure-of-arrays element.

Returns

Mutable view of the selected member.

---

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

• /home/runner/work/gaia-ecs/gaia-ecs/include/gaia/cnt/impl/darray_soa_impl.h