ListOffset< PRIMITIVE, BUILDER > Class Template Reference

Builds a ListOffsetArray which describes unequal-length lists (often called a "jagged" or "ragged" array). The underlying data for all lists are in a BUILDER content. It is subdivided into lists according to an offsets array, which specifies the starting and stopping index of each list. More...

#include <LayoutBuilder.h>

Public Member Functions
	ListOffset ()
	Creates a new ListOffset layout builder by allocating a new offset buffer, using AWKWARD_LAYOUTBUILDER_DEFAULT_OPTIONS for initializing the buffer.
	ListOffset (const awkward::BuilderOptions &options)
	Creates a new ListOffset layout builder by allocating a new offset buffer, taking options from BuilderOptions for initializing the buffer.
BUILDER &	content () noexcept
	Returns the reference to the builder content.
BUILDER &	begin_list () noexcept
	Begins a list and returns the reference to the builder content.
void	end_list () noexcept
	Ends a list and appends the current length of the list contents in the offsets buffer.
const std::string &	parameters () const noexcept
	Parameters for the builder form.
void	set_parameters (std::string parameter) noexcept
	Sets the form parameters.
void	set_id (size_t &id) noexcept
	Assigns a unique ID to each node.
void	clear () noexcept
	Discards the accumulated offsets and clears the builder content.
size_t	length () const noexcept
	Current length of the content.
bool	is_valid (std::string &error) const noexcept
	Checks for validity and consistency.
void	buffer_nbytes (std::map< std::string, size_t > &names_nbytes) const noexcept
	Retrieves the names and sizes (in bytes) of the buffers used in the builder and its contents.
void	to_buffers (std::map< std::string, void * > &buffers) const noexcept
	Copies and concatenates all the accumulated data in each of the buffers of the builder and its contents to user-defined pointers.
void	to_buffer (void *buffer, const char *name) const noexcept
	Copies and concatenates the accumulated data in the builder buffer to a user-defined pointer if the given node name matches with the node associated with the builder; otherwise, it searches the builder contents to locate a matching node.
void	to_char_buffers (std::map< std::string, uint8_t * > &buffers) const noexcept
	Copies and concatenates all the accumulated data in the builder to a map of user-allocated buffers.
std::string	form () const noexcept
	Generates a unique description of the builder and its contents in the form of a JSON-like string.

Detailed Description

template<typename PRIMITIVE, typename BUILDER>
class awkward::LayoutBuilder::ListOffset< PRIMITIVE, BUILDER >

Builds a ListOffsetArray which describes unequal-length lists (often called a "jagged" or "ragged" array). The underlying data for all lists are in a BUILDER content. It is subdivided into lists according to an offsets array, which specifies the starting and stopping index of each list.

The offsets must have at least length 1 (corresponding to an empty array).

The offsets values can be 64-bit signed integers int64, 32-bit signed integers int32 or 32-bit unsigned integers uint32.

Template Parameters

PRIMITIVE	The type of offsets buffer.
BUILDER	The type of builder content.

Constructor & Destructor Documentation

ListOffset() [1/2]

template<typename PRIMITIVE, typename BUILDER>

ListOffset ( )

inline

Creates a new ListOffset layout builder by allocating a new offset buffer, using AWKWARD_LAYOUTBUILDER_DEFAULT_OPTIONS for initializing the buffer.

ListOffset() [2/2]

template<typename PRIMITIVE, typename BUILDER>

ListOffset ( const awkward::BuilderOptions & options )

inline

Creates a new ListOffset layout builder by allocating a new offset buffer, taking options from BuilderOptions for initializing the buffer.

Parameters

options

Initial size configuration of a buffer.

Member Function Documentation

begin_list()

template<typename PRIMITIVE, typename BUILDER>

BUILDER & begin_list ( )

inlinenoexcept

Begins a list and returns the reference to the builder content.

buffer_nbytes()

template<typename PRIMITIVE, typename BUILDER>

void buffer_nbytes ( std::map< std::string, size_t > & names_nbytes ) const

inlinenoexcept

Retrieves the names and sizes (in bytes) of the buffers used in the builder and its contents.

clear()

template<typename PRIMITIVE, typename BUILDER>

void clear ( )

inlinenoexcept

Discards the accumulated offsets and clears the builder content.

content()

template<typename PRIMITIVE, typename BUILDER>

BUILDER & content ( )

inlinenoexcept

Returns the reference to the builder content.

end_list()

template<typename PRIMITIVE, typename BUILDER>

void end_list ( )

inlinenoexcept

Ends a list and appends the current length of the list contents in the offsets buffer.

form()

template<typename PRIMITIVE, typename BUILDER>

std::string form ( ) const

inlinenoexcept

Generates a unique description of the builder and its contents in the form of a JSON-like string.

is_valid()

template<typename PRIMITIVE, typename BUILDER>

bool is_valid ( std::string & error ) const

inlinenoexcept

Checks for validity and consistency.

length()

template<typename PRIMITIVE, typename BUILDER>

size_t length ( ) const

inlinenoexcept

Current length of the content.

parameters()

template<typename PRIMITIVE, typename BUILDER>

const std::string & parameters ( ) const

inlinenoexcept

Parameters for the builder form.

set_id()

template<typename PRIMITIVE, typename BUILDER>

void set_id ( size_t & id )

inlinenoexcept

Assigns a unique ID to each node.

set_parameters()

template<typename PRIMITIVE, typename BUILDER>

void set_parameters ( std::string parameter )

inlinenoexcept

Sets the form parameters.

to_buffer()

template<typename PRIMITIVE, typename BUILDER>

void to_buffer ( void * buffer, const char * name ) const

inlinenoexcept

Copies and concatenates the accumulated data in the builder buffer to a user-defined pointer if the given node name matches with the node associated with the builder; otherwise, it searches the builder contents to locate a matching node.

to_buffers()

template<typename PRIMITIVE, typename BUILDER>

void to_buffers ( std::map< std::string, void * > & buffers ) const

inlinenoexcept

Copies and concatenates all the accumulated data in each of the buffers of the builder and its contents to user-defined pointers.

Used to fill the buffers map by allocating it with user-defined pointers using the same names and sizes (in bytes) obtained from buffer_nbytes.

to_char_buffers()

template<typename PRIMITIVE, typename BUILDER>

void to_char_buffers ( std::map< std::string, uint8_t * > & buffers ) const

inlinenoexcept

Copies and concatenates all the accumulated data in the builder to a map of user-allocated buffers.

The map keys and the buffer sizes are obtained from buffer_nbytes

---

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

• /home/runner/work/awkward/awkward/awkward-cpp/header-only/layout-builder/awkward/LayoutBuilder.h