Options< OPTIONS > Class Template Reference

Container for all configuration options needed by ArrayBuilder, GrowableBuffer, LayoutBuilder and the Builder subclasses. More...

#include <BuilderOptions.h>

Public Types
using	OptionsPack = typename std::tuple<OPTIONS...>
template<std::size_t INDEX>
using	OptionType = std::tuple_element_t<INDEX, OptionsPack>

Public Member Functions
	Options (OPTIONS... options)
	Creates an Options tuple from a full set of parameters.
int64_t	initial () const noexcept
	The initial number of reserved entries for a GrowableBuffer.
double	resize () const noexcept
	The factor with which a GrowableBuffer is resized when its length reaches its reserved.
template<std::size_t INDEX>
const OptionType< INDEX > &	option () const noexcept
	Access to all other options.

Public Attributes
OptionsPack	pars

Static Public Attributes
static constexpr std::size_t	value = sizeof...(OPTIONS)

Detailed Description

template<typename... OPTIONS>
class awkward::Options< OPTIONS >

Container for all configuration options needed by ArrayBuilder, GrowableBuffer, LayoutBuilder and the Builder subclasses.

Member Typedef Documentation

OptionsPack

template<typename... OPTIONS>

using OptionsPack = typename std::tuple<OPTIONS...>

OptionType

template<typename... OPTIONS>

template<std::size_t INDEX>

using OptionType = std::tuple_element_t<INDEX, OptionsPack>

Constructor & Destructor Documentation

Options()

template<typename... OPTIONS>

Options ( OPTIONS... options )

inline

Creates an Options tuple from a full set of parameters.

Member Function Documentation

initial()

template<typename... OPTIONS>

int64_t initial ( ) const

inlinenoexcept

The initial number of reserved entries for a GrowableBuffer.

option()

template<typename... OPTIONS>

template<std::size_t INDEX>

const OptionType< INDEX > & option ( ) const

inlinenoexcept

Access to all other options.

resize()

template<typename... OPTIONS>

double resize ( ) const

inlinenoexcept

The factor with which a GrowableBuffer is resized when its length reaches its reserved.

Member Data Documentation

pars

template<typename... OPTIONS>

OptionsPack pars

value

template<typename... OPTIONS>

constexpr std::size_t value = sizeof...(OPTIONS)

staticconstexpr

---

The documentation for this class was generated from the following file:

• /home/runner/work/awkward/awkward/awkward-cpp/header-only/builder-options/awkward/BuilderOptions.h