vecmem::data::jagged_vector_buffer< TYPE > Class Template Reference

Object owning all the data of a jagged vector. More...

#include <vecmem/containers/data/jagged_vector_buffer.hpp>

Inheritance diagram for vecmem::data::jagged_vector_buffer< TYPE >:

Public Types
using	base_type = jagged_vector_view< TYPE >
	The base type used by this class.
using	size_type = typename base_type::size_type
	Use the base class's size_type.
using	value_type = typename base_type::value_type
	Use the base class's value_type.
using	pointer = typename base_type::pointer
	Pointer type to the jagged array.

Public Member Functions
	jagged_vector_buffer ()
	Make sure that the template type does not have a custom destructor.
template<typename OTHERTYPE , std::enable_if_t< std::is_convertible< TYPE, OTHERTYPE >::value, bool > = true>
	jagged_vector_buffer (const jagged_vector_view< OTHERTYPE > &other, memory_resource &resource, memory_resource *host_access_resource=nullptr, buffer_type type=buffer_type::fixed_size)
	Constructor from an existing vecmem::data::jagged_vector_view.
template<typename SIZE_TYPE = std::size_t, std::enable_if_t< std::is_integral< SIZE_TYPE >::value &&std::is_unsigned< SIZE_TYPE >::value, bool > = true>
	jagged_vector_buffer (const std::vector< SIZE_TYPE > &capacities, memory_resource &resource, memory_resource *host_access_resource=nullptr, buffer_type type=buffer_type::fixed_size)
	Constructor from a vector of ("inner vector") sizes.
	jagged_vector_buffer (jagged_vector_buffer &&) noexcept=default
	Move constructor.
jagged_vector_buffer &	operator= (jagged_vector_buffer &&) noexcept=default
	Move assignment.
VECMEM_HOST_AND_DEVICE bool	operator== (const jagged_vector_view< OTHERTYPE > &rhs) const
	Equality check.
VECMEM_HOST_AND_DEVICE bool	operator!= (const jagged_vector_view< OTHERTYPE > &rhs) const
	Inequality check. Simply based on operator==.
VECMEM_HOST_AND_DEVICE size_type	size () const
	Get the "outer" size of the jagged vector.
VECMEM_HOST_AND_DEVICE size_type	capacity () const
	Get the maximum capacity of the "outer" vector.
VECMEM_HOST_AND_DEVICE pointer	ptr () const
	Get a pointer to the vector elements.
VECMEM_HOST_AND_DEVICE pointer	host_ptr () const
	Access the host accessible array describing the inner vectors.

Detailed Description

template<typename TYPE>
class vecmem::data::jagged_vector_buffer< TYPE >

Object owning all the data of a jagged vector.

This type is needed for the explicit memory management of jagged vectors.

Constructor & Destructor Documentation

jagged_vector_buffer() [1/3]

template<typename TYPE >

vecmem::data::jagged_vector_buffer< TYPE >::jagged_vector_buffer

(

)

Make sure that the template type does not have a custom destructor.

A custom implementation for the default constructor is necessary because vecmem::data::jagged_vector_view does not set its members to anything explicitly in its default constructor.

Make sure that vecmem::data::vector_view does not have a custom destructor Default constructor

(In order to be trivially default constructible.) So here we need to be explicit.

jagged_vector_buffer() [2/3]

template<typename TYPE >

template<typename OTHERTYPE , std::enable_if_t< std::is_convertible< TYPE, OTHERTYPE >::value, bool > >

vecmem::data::jagged_vector_buffer< TYPE >::jagged_vector_buffer	(	const jagged_vector_view< OTHERTYPE > &	other,
		memory_resource &	resource,
		memory_resource *	host_access_resource = nullptr,
		buffer_type	type = buffer_type::fixed_size
	)

Constructor from an existing vecmem::data::jagged_vector_view.

Parameters

other	The existing vecmem::data::jagged_vector_view object that this buffer should mirror.
resource	The device accessible memory resource, which may also be host accessible.
host_access_resource	An optional host accessible memory resource. Needed if resource is not host accessible.
type	The type (resizable or not) of the buffer

jagged_vector_buffer() [3/3]

template<typename TYPE >

template<typename SIZE_TYPE , std::enable_if_t< std::is_integral< SIZE_TYPE >::value &&std::is_unsigned< SIZE_TYPE >::value, bool > >

vecmem::data::jagged_vector_buffer< TYPE >::jagged_vector_buffer	(	const std::vector< SIZE_TYPE > &	capacities,
		memory_resource &	resource,
		memory_resource *	host_access_resource = nullptr,
		buffer_type	type = buffer_type::fixed_size
	)

Constructor from a vector of ("inner vector") sizes.

Parameters

capacities	Simple vector holding the capacities/sizes of the "inner vectors" for the jagged vector buffer.
resource	The device accessible memory resource, which may also be host accessible.
host_access_resource	An optional host accessible memory resource. Needed if resource is not host accessible.
type	The type (resizable or not) of the buffer

Member Function Documentation

host_ptr()

VECMEM_HOST_AND_DEVICE auto vecmem::data::jagged_vector_view< TYPE >::host_ptr ( ) const

inherited

Access the host accessible array describing the inner vectors.

This may or may not return the same pointer as ptr(). If the underlying data is stored in host-accessible memory, then the two will be the same.

If not, then ptr() will return the device accessible array, and this function returns a host-accessible one.

Returns

A host-accessible pointer to the array describing the inner vectors

operator==()

VECMEM_HOST_AND_DEVICE bool vecmem::data::jagged_vector_view< TYPE >::operator== ( const jagged_vector_view< OTHERTYPE > &  rhs ) const

inherited

Equality check.

Two objects are only equal if they point at the same memory.

---

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

• core/include/vecmem/containers/data/jagged_vector_buffer.hpp
• core/include/vecmem/containers/impl/jagged_vector_buffer.ipp