IndexedOption< PRIMITIVE, BUILDER > Class Template Reference

Builds an IndexedOptionArray which consists of an index buffer. The negative values in the index are interpreted as missing. More...

#include <LayoutBuilder.h>

Public Member Functions
	IndexedOption ()
	Creates a new IndexedOption layout builder by allocating a new index buffer, using AWKWARD_LAYOUTBUILDER_DEFAULT_OPTIONS for initializing the buffer.
	IndexedOption (const awkward::BuilderOptions &options)
	Creates a new IndexedOption layout builder by allocating a new index buffer, taking options from BuilderOptions for initializing the buffer.
BUILDER &	content () noexcept
	Returns the reference to the builder content.
BUILDER &	append_valid () noexcept
	Inserts the last valid index in the index buffer and returns the reference to the builder content.
BUILDER &	append_valid (size_t i) noexcept
	Inserts an explicit value in the index buffer and returns the reference to the builder content.
BUILDER &	extend_valid (size_t size) noexcept
	Inserts size number of valid index in the index buffer and returns the reference to the builder content.
void	append_invalid () noexcept
	Inserts -1 in the index buffer.
void	extend_invalid (size_t size) noexcept
	Inserts -1 in the index buffer size number of times.
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 index and clears the content of the builder. Also, last valid returns to -1.
size_t	length () const noexcept
	Current length of the index buffer.
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::IndexedOption< PRIMITIVE, BUILDER >

Builds an IndexedOptionArray which consists of an index buffer. The negative values in the index are interpreted as missing.

The index values can be 64-bit signed integers int64, 32-bit signed integers int32.

Template Parameters

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

Constructor & Destructor Documentation

IndexedOption() [1/2]

template<typename PRIMITIVE , typename BUILDER >

IndexedOption ( )

inline

Creates a new IndexedOption layout builder by allocating a new index buffer, using AWKWARD_LAYOUTBUILDER_DEFAULT_OPTIONS for initializing the buffer.

IndexedOption() [2/2]

template<typename PRIMITIVE , typename BUILDER >

IndexedOption ( const awkward::BuilderOptions & options )

inline

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

Parameters

options

Initial size configuration of a buffer.

Member Function Documentation

append_invalid()

template<typename PRIMITIVE , typename BUILDER >

void append_invalid ( )

inlinenoexcept

Inserts -1 in the index buffer.

append_valid() [1/2]

template<typename PRIMITIVE , typename BUILDER >

BUILDER & append_valid ( )

inlinenoexcept

Inserts the last valid index in the index buffer and returns the reference to the builder content.

append_valid() [2/2]

template<typename PRIMITIVE , typename BUILDER >

BUILDER & append_valid ( size_t i )

inlinenoexcept

Inserts an explicit value in the index buffer 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 index and clears the content of the builder. Also, last valid returns to -1.

content()

template<typename PRIMITIVE , typename BUILDER >

BUILDER & content ( )

inlinenoexcept

Returns the reference to the builder content.

extend_invalid()

template<typename PRIMITIVE , typename BUILDER >

void extend_invalid ( size_t size )

inlinenoexcept

Inserts -1 in the index buffer size number of times.

Just an interface; not actually faster than calling append many times.

extend_valid()

template<typename PRIMITIVE , typename BUILDER >

BUILDER & extend_valid ( size_t size )

inlinenoexcept

Inserts size number of valid index in the index buffer and returns the reference to the builder content.

Just an interface; not actually faster than calling append many times.

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 index buffer.

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