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>
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. |
◆ Tuple()
template<typename... BUILDERS>
Creates a new Tuple layout builder.
◆ 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>
Clears the builder contents.
Discards the accumulated data and the contents at each tuple 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.
◆ index()
template<typename... BUILDERS>
template<std::size_t INDEX>
TupleContentType< INDEX > & index |
( |
| ) |
|
|
inlinenoexcept |
Returns the reference to the builder contents at INDEX
.
◆ is_valid()
template<typename... BUILDERS>
bool is_valid |
( |
std::string & | error | ) |
const |
|
inlinenoexcept |
Checks for validity and consistency.
◆ length()
template<typename... BUILDERS>
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>
Assigns a unique ID to each node.
◆ set_parameters()
template<typename... BUILDERS>
void set_parameters |
( |
std::string | parameter | ) |
|
|
inlinenoexcept |
Sets the form parameters.
◆ 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
◆ contents
template<typename... BUILDERS>
The documentation for this class was generated from the following file: