Tuple< BUILDERS > Class Template Reference

Builds a RecordArray which represents an array of tuples which can be of same or different types without field names, indexed only by their order. More...

#include <LayoutBuilder.h>

Public Member Functions
	Tuple ()
	Creates a new Tuple layout builder.
template<std::size_t INDEX>
TupleContentType< INDEX > &	content () noexcept
	Returns the reference to the builder contents at INDEX.
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
	Clears the builder contents.
size_t	length () const noexcept
	Current number of records in the first index of the tuple.
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 buffers of the builder contents to user-defined pointers if the given node name matches with the node associated with that builder.
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.

Public Attributes
TupleContents	contents
	The contents of the RecordArray without fields.

Detailed Description

template<typename... BUILDERS>
class awkward::LayoutBuilder::Tuple< BUILDERS >

Builds a RecordArray which represents an array of tuples which can be of same or different types without field names, indexed only by their order.

Template Parameters

BUILDERS

The types of builder contents.

Constructor & Destructor Documentation

Tuple()

template<typename... BUILDERS>

Tuple ( )

inline

Creates a new Tuple layout builder.

Member Function Documentation

buffer_nbytes()

template<typename... BUILDERS>

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... BUILDERS>

void clear ( )

inlinenoexcept

Clears the builder contents.

Discards the accumulated data and the contents at each tuple index.

content()

template<typename... BUILDERS>

template<std::size_t INDEX>

TupleContentType< INDEX > & content ( )

inlinenoexcept

Returns the reference to the builder contents at INDEX.

form()

template<typename... BUILDERS>

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... BUILDERS>

bool is_valid ( std::string & error ) const

inlinenoexcept

Checks for validity and consistency.

length()

template<typename... BUILDERS>

size_t length ( ) const

inlinenoexcept

Current number of records in the first index of the tuple.

parameters()

template<typename... BUILDERS>

const std::string & parameters ( ) const

inlinenoexcept

Parameters for the builder form.

set_id()

template<typename... BUILDERS>

void set_id ( size_t & id )

inlinenoexcept

Assigns a unique ID to each node.

set_parameters()

template<typename... BUILDERS>

void set_parameters ( std::string parameter )

inlinenoexcept

Sets the form parameters.

to_buffer()

template<typename... BUILDERS>

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

inlinenoexcept

Copies and concatenates the accumulated data in the buffers of the builder contents to user-defined pointers if the given node name matches with the node associated with that builder.

to_buffers()

template<typename... BUILDERS>

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... BUILDERS>

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

Member Data Documentation

contents

template<typename... BUILDERS>

TupleContents contents

The contents of the RecordArray without fields.

---

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