All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 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_index () noexcept
 Inserts the last valid index in the index buffer and returns the reference to the builder content.
 
BUILDER & extend_index (size_t size) noexcept
 Inserts size number of valid index in the index buffer and returns the reference to the builder content.
 
void append_null () noexcept
 Inserts -1 in the index buffer.
 
void extend_null (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_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
PRIMITIVEThe type of index buffer.
BUILDERThe type of builder content.

Constructor & Destructor Documentation

◆ IndexedOption() [1/2]

IndexedOption ( )
inline

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

◆ IndexedOption() [2/2]

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
optionsInitial size configuration of a buffer.

Member Function Documentation

◆ append_index()

BUILDER & append_index ( )
inlinenoexcept

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

◆ append_null()

void append_null ( )
inlinenoexcept

Inserts -1 in the index buffer.

◆ buffer_nbytes()

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()

void clear ( )
inlinenoexcept

Discards the accumulated index and clears the content of the builder. Also, last valid returns to -1.

◆ content()

BUILDER & content ( )
inlinenoexcept

Returns the reference to the builder content.

◆ extend_index()

BUILDER & extend_index ( 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.

◆ extend_null()

void extend_null ( 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.

◆ form()

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()

bool is_valid ( std::string &  error) const
inlinenoexcept

Checks for validity and consistency.

◆ length()

size_t length ( ) const
inlinenoexcept

Current length of the index buffer.

◆ parameters()

const std::string & parameters ( ) const
inlinenoexcept

Parameters for the builder form.

◆ set_id()

void set_id ( size_t &  id)
inlinenoexcept

Assigns a unique ID to each node.

◆ set_parameters()

void set_parameters ( std::string  parameter)
inlinenoexcept

Sets the form parameters.

◆ to_buffers()

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()

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: