EmptyRecord< IS_TUPLE > Class Template Reference

Builds an Empty RecordArray which has has zero contents. It still represents a non-empty array. In this case, its length is specified by length. More...

#include <LayoutBuilder.h>

Public Member Functions
	EmptyRecord ()
	Creates a new EmptyRecord layout builder.
void	append () noexcept
	Inserts an empty record.
void	extend (size_t size) noexcept
	Inserts size number of empty records.
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, the length returns to zero.
size_t	length () const noexcept
	Current number of records.
bool	is_valid (std::string &) const noexcept
	Checks for validity and consistency.
void	buffer_nbytes (std::map< std::string, size_t > &) const noexcept
void	to_buffers (std::map< std::string, void * > &) const noexcept
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<bool IS_TUPLE>
class awkward::LayoutBuilder::EmptyRecord< IS_TUPLE >

Builds an Empty RecordArray which has has zero contents. It still represents a non-empty array. In this case, its length is specified by length.

Template Parameters

IS_TUPLE

A boolean value which determines whether the builder contains Tuples or Records.

Constructor & Destructor Documentation

EmptyRecord()

template<bool IS_TUPLE>

EmptyRecord ( )

inline

Creates a new EmptyRecord layout builder.

Member Function Documentation

append()

template<bool IS_TUPLE>

void append ( )

inlinenoexcept

Inserts an empty record.

buffer_nbytes()

template<bool IS_TUPLE>

void buffer_nbytes ( std::map< std::string, size_t > &  ) const

inlinenoexcept

clear()

template<bool IS_TUPLE>

void clear ( )

inlinenoexcept

Clears the builder contents, the length returns to zero.

extend()

template<bool IS_TUPLE>

void extend ( size_t  size )

inlinenoexcept

Inserts size number of empty records.

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

form()

template<bool IS_TUPLE>

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<bool IS_TUPLE>

bool is_valid ( std::string &  ) const

inlinenoexcept

Checks for validity and consistency.

length()

template<bool IS_TUPLE>

size_t length ( ) const

inlinenoexcept

Current number of records.

parameters()

template<bool IS_TUPLE>

const std::string & parameters ( ) const

inlinenoexcept

Parameters for the builder form.

set_id()

template<bool IS_TUPLE>

void set_id ( size_t &  id )

inlinenoexcept

Assigns a unique ID to each node.

set_parameters()

template<bool IS_TUPLE>

void set_parameters ( std::string  parameter )

inlinenoexcept

Sets the form parameters.

to_buffers()

template<bool IS_TUPLE>

void to_buffers ( std::map< std::string, void * > &  ) const

inlinenoexcept

to_char_buffers()

template<bool IS_TUPLE>

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