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>
|
| | Tuple () |
| | Creates a new Tuple layout builder.
|
| |
| template<std::size_t INDEX> |
| TupleContentType< INDEX > & | index () 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.
|
| |
| const 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_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.
|
| |
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()
Creates a new Tuple layout builder.
◆ 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()
Clears the builder contents.
Discards the accumulated data and the contents at each tuple index.
◆ form()
| std::string form |
( |
| ) |
const |
|
inlinenoexcept |
Generates a unique description of the builder and its contents in the form of a JSON-like string.
◆ index()
| TupleContentType< INDEX > & index |
( |
| ) |
|
|
inlinenoexcept |
Returns the reference to the builder contents at INDEX.
◆ is_valid()
| bool is_valid |
( |
std::string & |
error | ) |
const |
|
inlinenoexcept |
Checks for validity and consistency.
◆ length()
| const size_t length |
( |
| ) |
const |
|
inlinenoexcept |
Current number of records in the first index of the tuple.
◆ 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
◆ contents
The documentation for this class was generated from the following file: