Builds a ListArray which generalizes ListOffsetArray. Instead of a single offsets array, ListArray has - starts which is the starting index of each list and stops which is the stopping index of each list. More...
#include <LayoutBuilder.h>
Public Member Functions | |
List () | |
Creates a new List layout builder by allocating new starts and stops buffer, using default_options for initializing the buffer. More... | |
List (const awkward::BuilderOptions &options) | |
Creates a new List layout builder by allocating new starts and stops buffer, taking options from BuilderOptions for initializing the buffer. More... | |
BUILDER & | content () noexcept |
Returns the reference to the builder content. More... | |
BUILDER & | begin_list () noexcept |
Begins a list, appends the current length of the list contents in the starts buffer and returns the reference to the builder content. More... | |
void | end_list () noexcept |
Ends a list and appends the current length of the list contents in the stops buffer. More... | |
const std::string & | parameters () const noexcept |
Parameters for the builder form. More... | |
void | set_parameters (std::string parameter) noexcept |
Sets the form parameters. More... | |
void | set_id (size_t &id) noexcept |
Assigns a unique ID to each node. More... | |
void | clear () noexcept |
Discards the accumulated starts and stops, and clears the builder content. More... | |
size_t | length () const noexcept |
Current length of the content and starts buffer. More... | |
bool | is_valid (std::string &error) const noexcept |
Checks for validity and consistency. More... | |
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. More... | |
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. More... | |
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. More... | |
std::string | form () const noexcept |
Generates a unique description of the builder and its contents in the form of a JSON-like string. More... | |
Builds a ListArray which generalizes ListOffsetArray. Instead of a single offsets array, ListArray has - starts which is the starting index of each list and stops which is the stopping index of each list.
The starts and stops values can be 64-bit signed integers int64
, 32-bit signed integers int32
or 32-bit unsigned integers uint32
.
PRIMITIVE | The type of starts and stops buffer. |
BUILDER | The type of builder content. |
|
inline |
Creates a new List layout builder by allocating new starts
and stops
buffer, using default_options
for initializing the buffer.
|
inline |
Creates a new List layout builder by allocating new starts
and stops
buffer, taking options
from BuilderOptions
for initializing the buffer.
options | Initial size configuration of a buffer. |
|
inlinenoexcept |
Begins a list, appends the current length of the list contents in the starts
buffer and returns the reference to the builder content.
|
inlinenoexcept |
Retrieves the names and sizes (in bytes) of the buffers used in the builder and its contents.
|
inlinenoexcept |
Discards the accumulated starts and stops, and clears the builder content.
|
inlinenoexcept |
Returns the reference to the builder content.
|
inlinenoexcept |
Ends a list and appends the current length of the list contents in the stops
buffer.
|
inlinenoexcept |
Generates a unique description of the builder and its contents in the form of a JSON-like string.
|
inlinenoexcept |
Checks for validity and consistency.
|
inlinenoexcept |
Current length of the content and starts
buffer.
|
inlinenoexcept |
Parameters for the builder form.
|
inlinenoexcept |
Assigns a unique ID to each node.
|
inlinenoexcept |
Sets the form parameters.
|
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.
|
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