Awkward Array: awkward Namespace Reference

Loading...
Searching...
No Matches
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
awkward Namespace Reference

## Namespaces
namespace | dlpack
namespace | kernel
namespace | LayoutBuilder
namespace | util

## Classes
class | ArrayBuilder
| User interface to the Builder system: the ArrayBuilder is a fixed reference while the Builder subclass instances change in response to accumulating data. More...
class | ArrayCache
| Abstract superclass of cache for VirtualArray, defining the interface. More...
class | ArrayGenerator
| Abstract superclass to generate arrays for VirtualArray, defining the interface. More...
class | ArrayType
| Describes the high level type of a user-facing array, i.e. `ak.Array` in Python, as opposed to Content. The length of the array is part of its type. More...
class | BitMaskedArray
| Represents potentially missing data by overlaying a bit mask over its content. More...
class | BitMaskedArrayBuilder
| BitMaskedArray builder from a Bit Masked JSON Form. More...
class | BitMaskedForm
| Form describing BitMaskedArray. More...
class | BoolBuilder
| Builder node that accumulates boolean values. More...
class | BuffersContainer
| Abstract class to represent the output of ak.to_buffers. In Python, this would be a dict of NumPy arrays. More...
class | Builder
| Abstract base class for nodes within an ArrayBuilder that cumulatively discover an array's type and fill it. More...
class | ByteMaskedArray
| Represents potentially missing data by overlaying a byte mask over its content. More...
class | ByteMaskedArrayBuilder
class | ByteMaskedForm
| Form describing ByteMaskedArray. More...
class | Complex128Builder
| Builder node that accumulates real numbers (`double`). More...
class | Content
| Abstract superclass of all array node types (flat hierarchy). Any Content can be nested within any other Content. More...
class | CppBuffers
class | DatetimeBuilder
| Builder node that accumulates integers (`int64_t`). More...
class | EmptyArray
| Represents an array with length zero and (perhaps as a consequence) UnknownType. More...
class | EmptyArrayBuilder
class | EmptyForm
| Form describing EmptyArray. More...
class | FileLikeObject
| Abstract class to represent a file-like object, something with a `read(num_bytes)` method. Satisfies RapidJSON's Stream interface. More...
class | Float64Builder
| Builder node that accumulates real numbers (`double`). More...
class | Form
| Abstract superclass of all array node forms, which expresses the nesting structure without any large `Index` or data buffers. More...
class | FormBuilder
| Abstract base class for nodes within a LayoutBuilder Every builder will have an output buffer based on the key_format="part{partition}-{form_key}-{attribute}". More...
class | ForthInputBuffer
| HERE. More...
class | ForthMachineOf
class | ForthOutputBuffer
| HERE. More...
class | ForthOutputBufferOf
class | FromJsonObjectSchema
class | GrowableBuffer
| Discontiguous, one-dimensional buffer (which consists of multiple contiguous, one-dimensional panels) that can grow indefinitely by calling append. More...
class | Identities
| A contiguous, two-dimensional array of integers and a list of strings used to represent a path from the root of an array structure to each item in an array. More...
class | IdentitiesOf
| A contiguous, two-dimensional array of integers and a list of strings used to represent a path from the root of an array structure to each item in an array. More...
class | Index
| A contiguous, one-dimensional array of integers used to represent data structures, rather than numerical data in the arrays themselves. More...
class | IndexedArrayBuilder
class | IndexedArrayOf
| Filters, rearranges, and/or duplicates items in its content through an index, which has the same effect as lazily-applied carry. More...
class | IndexedForm
| Form describing IndexedArray (with `OPTION = false`). More...
class | IndexedOptionArrayBuilder
class | IndexedOptionForm
| Form describing IndexedOptionArray. More...
class | IndexOf
| A contiguous, one-dimensional array of integers used to represent data structures, rather than numerical data in the arrays themselves. More...
class | Int64Builder
| Builder node that accumulates integers (`int64_t`). More...
class | IrregularlyPartitionedArray
| PartitionedArray of arbitrary length partitions. More...
struct | is_specialization
struct | is_specialization< Ref< Args... >, Ref >
class | Iterator
| Represents the current state of iteration over a Content array. More...
class | LayoutBuilder
| User interface to the FormBuilder system: the LayoutBuilder is a fixed reference while the FormBuilder subclass instances change in response to accumulating data. More...
class | ListArrayBuilder
class | ListArrayOf
| Represents an array of nested lists that can have different lengths using two indexes named starts and stops. More...
class | ListBuilder
| Builder node that accumulates lists. More...
class | ListForm
| Form describing ListArray. More...
class | ListOffsetArrayBuilder
class | ListOffsetArrayOf
| Represents an array of nested lists that can have different lengths using one index named offsets. More...
class | ListOffsetForm
| Form describing ListOffsetArray. More...
class | ListType
| Describes the high level type of lists of variable length, as opposed to RegularType. More...
class | None
| Represents a scalar missing value, which is `None` in Python. More...
class | NumpyArray
| Represents a rectilinear numerical array that can be converted to and from NumPy without loss of information or copying the underlying buffer. More...
class | NumpyArrayBuilder
class | NumpyForm
| Form describing NumpyArray. More...
class | OptionBuilder
| Builder node that accumulates data with missing values (`None`). More...
class | Options
| Container for all configuration options needed by ArrayBuilder, GrowableBuffer, LayoutBuilder and the Builder subclasses. More...
class | OptionType
| Describes the high level type of data with possible missing values, represented by `None` in python. More...
class | Panel
class | PartitionedArray
| Abstract superclass of all PartitionedArray node types. PartitionedArrays contain a list of Content, but Content cannot contain PartitionedArrays. More...
class | PrimitiveType
| Describes the high level type of an array that contains fixed-size items, such as numbers or booleans. More...
class | Record
| Represents a tuple or record, a scalar value from RecordArray. More...
class | RecordArray
| Represents an array of tuples or records, in which a tuple has a fixed number of differently typed fields and a record has a named set of differently typed fields. More...
class | RecordArrayBuilder
class | RecordBuilder
| Builder node for accumulated records. More...
class | RecordForm
| Form describing RecordArray (not a Record). More...
class | RecordType
| Describes the high level type of data containing tuples or records. More...
class | Reducer
| Abstract class for all reducer algorithms. More...
class | ReducerAll
| Reducer algorithm that returns `true` if all values are `true`, `false` otherwise. The identity is `true`. More...
class | ReducerAny
| Reducer algorithm that returns `true` if any values are `true`, `false` otherwise. The identity is `false`. More...
class | ReducerArgmax
| Reducer algorithm that returns the position of the maximum value. The identity is meaningless and should be covered using `mask = true`. More...
class | ReducerArgmin
| Reducer algorithm that returns the position of the minimum value. The identity is meaningless and should be covered using `mask = true`. More...
class | ReducerCount
| Reducer algorithm that simply counts items. The identity is `0`. More...
class | ReducerCountNonzero
| Reducer algorithm that counts non-zero items. The identity is `0`. More...
class | ReducerMax
| Reducer algorithm that returns the maximum value. The identity is minus infinity or the smallest possible value. More...
class | ReducerMin
| Reducer algorithm that returns the minimum value. The identity is infinity or the largest possible value. More...
class | ReducerProd
| Reducer algorithm that multiplies items. The identity is `1`. More...
class | ReducerSum
| Reducer algorithm that adds up items. The identity is `0`. More...
class | RegularArray
| Represents an array of nested lists that all have the same length using a scalar size, rather than an index. More...
class | RegularArrayBuilder
class | RegularForm
| Form describing RegularArray. More...
class | RegularType
| Describes the high level type of lists of a given length, as opposed to ListType. More...
class | Slice
| A sequence of SliceItem objects representing a tuple passed to Python's `__getitem__`. More...
class | SliceArrayOf
| Represents an array of integers in a slice (possibly converted from an array of booleans). More...
class | SliceAt
| Represents an integer in a tuple of slices passed to `__getitem__` in Python. More...
class | SliceEllipsis
| Represents a Python `Ellipsis` object (usual syntax: `array[...]`). More...
class | SliceField
| Represents a single string in a slice tuple, indicating that a RecordArray should be replaced by one of its fields. More...
class | SliceFields
class | SliceGenerator
| Generator for lazy slicing. Used to avoid materializing a VirtualArray before its content is needed (in case its content is never needed). More...
class | SliceItem
| Abstract class for slice items, which are elements of a tuple passed to an array's `__getitem__` in Python. More...
class | SliceJaggedOf
| Represents an array of nested lists, where the content may be SliceArrayOf, SliceMissingOf, or SliceJaggedOf (no equivalent in NumPy). More...
class | SliceMissingOf
| Represents a SliceArrayOf, SliceMissingOf, or SliceJaggedOf with missing values: `None` (no equivalent in NumPy). More...
class | SliceNewAxis
| Represents NumPy's newaxis marker (a.k.a. `None`), which prompts `__getitem__` to insert a length-1 regular dimension (RegularArray) at some point in the slice tuple. More...
class | SliceRange
| Represents a Python `slice` object (usual syntax: `array[start:stop:step]`). More...
class | StringBuilder
| Builder node that accumulates strings. More...
class | ToJson
class | ToJsonFile
| Produces a JSON-formatted file. More...
class | ToJsonPrettyFile
| Produces a pretty JSON-formatted file. More...
class | ToJsonPrettyString
| Produces a pretty JSON-formatted string. More...
class | ToJsonString
| Produces a JSON-formatted string. More...
class | TupleBuilder
| Builder node for accumulated tuples. More...
class | Type
| Abstract superclass of all high level types (flat hierarchy). More...
class | UnionArrayBuilder
class | UnionArrayOf
| Represents heterogeneous data by interleaving several contents, indicating which is relevant at a given position with tags and where to find each item in the contents with an interleaved index. More...
class | UnionBuilder
| Builder node for accumulated heterogeneous data. More...
class | UnionForm
| Form describing UnionArray. More...
class | UnionType
| Describes the high level type of heterogeneous data. More...
class | UnknownBuilder
| Builder node for accumulated data whose type is not yet known. More...
class | UnknownType
| Describes the high level type of data with whose type is not known, usually because an ArrayBuilder did not have any instances to sample. More...
class | UnmaskedArray
| Converts content of any type into an OptionType in which all values happen to be valid. More...
class | UnmaskedArrayBuilder
class | UnmaskedForm
| Form describing UnmaskedArray. More...
class | VirtualArray
| Represents an array that can be generated on demand. More...
class | VirtualForm
| Form describing VirtualArray. More...
class | visit_impl
| Class to index tuple at runtime. More...
struct | visit_impl< 0 >
| `INDEX` reached `0`, which means the runtime index did not exist in the tuple. More...
struct | voider

## Typedefs
using | IndexedArray32 = IndexedArrayOf< int32_t, false >
using | IndexedArrayU32 = IndexedArrayOf< uint32_t, false >
using | IndexedArray64 = IndexedArrayOf< int64_t, false >
using | IndexedOptionArray32 = IndexedArrayOf< int32_t, true >
using | IndexedOptionArray64 = IndexedArrayOf< int64_t, true >
using | ListArray32 = ListArrayOf< int32_t >
using | ListArrayU32 = ListArrayOf< uint32_t >
using | ListArray64 = ListArrayOf< int64_t >
using | ListOffsetArray32 = ListOffsetArrayOf< int32_t >
using | ListOffsetArrayU32 = ListOffsetArrayOf< uint32_t >
using | ListOffsetArray64 = ListOffsetArrayOf< int64_t >
using | UnionArray8_32 = UnionArrayOf< int8_t, int32_t >
using | UnionArray8_U32 = UnionArrayOf< int8_t, uint32_t >
using | UnionArray8_64 = UnionArrayOf< int8_t, int64_t >
using | BuilderPtr = std::shared_ptr< Builder >
using | ContentPtr = std::shared_ptr< Content >
using | ContentPtrVec = std::vector< std::shared_ptr< Content > >
using | FormPtr = std::shared_ptr< Form >
using | FormKey = std::shared_ptr< std::string >
using | ArrayCachePtr = std::shared_ptr< ArrayCache >
using | TypePtr = std::shared_ptr< Type >
using | ForthMachine32 = ForthMachineOf< int32_t, int32_t >
using | ForthMachine64 = ForthMachineOf< int64_t, int32_t >
using | IdentitiesPtr = std::shared_ptr< Identities >
using | Identities32 = IdentitiesOf< int32_t >
using | Identities64 = IdentitiesOf< int64_t >
using | Index8 = IndexOf< int8_t >
using | IndexU8 = IndexOf< uint8_t >
using | Index32 = IndexOf< int32_t >
using | IndexU32 = IndexOf< uint32_t >
using | Index64 = IndexOf< int64_t >
using | ForthOutputBufferMap = std::map< std::string, std::shared_ptr< ForthOutputBuffer > >
template<typename T , typename I >
using | LayoutBuilderPtr = LayoutBuilder< T, I > *
template<typename T , typename I >
using | FormBuilderPtr = std::shared_ptr< FormBuilder< T, I > >
using | utype = std::underlying_type< state >::type
using | LayoutBuilder32 = LayoutBuilder< int32_t, int32_t >
using | LayoutBuilder64 = LayoutBuilder< int64_t, int32_t >
using | PartitionedArrayPtr = std::shared_ptr< PartitionedArray >
using | SliceItemPtr = std::shared_ptr< SliceItem >
using | SliceArray64 = SliceArrayOf< int64_t >
using | SliceMissing64 = SliceMissingOf< int64_t >
using | SliceJagged64 = SliceJaggedOf< int64_t >
using | ArrayGeneratorPtr = std::shared_ptr< ArrayGenerator >
using | BuilderOptions = Options< int64_t, double >
template<typename... T>
using | void_t = typename voider< T... >::type

## Enumerations
enum class | state : std::int32_t { int64 = 0 , float64 = 1 , begin_list = 2 , end_list = 3 , boolean = 4 , int8 = 5 , int16 = 6 , int32 = 7 , uint8 = 8 , uint16 = 9 , uint32 = 10 , uint64 = 11 , float16 = 12 , float32 = 13 , float128 = 14 , complex64 = 15 , complex128 = 16 , complex256 = 17 , null = 18 , index = 19 , tag = 20 , datetime64 = 21 , timedelta64 = 22 }

## Functions
template<typename T >
void | byteswap16 (int64_t num_items, T &value)
| HERE. More...
template<typename T >
void | byteswap32 (int64_t num_items, T &value)
| HERE. More...
template<typename T >
void | byteswap64 (int64_t num_items, T &value)
| HERE. More...
template<typename T >
void | byteswap_intp (int64_t num_items, T &value)
| HERE. More...
LIBAWKWARD_EXPORT_SYMBOL int64_t | FromJsonString (const char *source, ArrayBuilder &builder, const char *nan_string=nullptr, const char *infinity_string=nullptr, const char *minus_infinity_string=nullptr)
| Parses a JSON-encoded string using an ArrayBuilder. More...
LIBAWKWARD_EXPORT_SYMBOL int64_t | FromJsonFile (FILE *source, ArrayBuilder &builder, int64_t buffersize, const char *nan_string=nullptr, const char *infinity_string=nullptr, const char *minus_infinity_string=nullptr)
| Parses a JSON-encoded file using an ArrayBuilder. More...
LIBAWKWARD_EXPORT_SYMBOL void | fromjsonobject (FileLikeObject *source, ArrayBuilder &builder, int64_t buffersize, bool read_one, const char *nan_string=nullptr, const char *posinf_string=nullptr, const char *neginf_string=nullptr)
| Parses a JSON-encoded file-like object using an ArrayBuilder. More...
LIBAWKWARD_EXPORT_SYMBOL const ContentPtr | uproot_issue_90 (const Form &form, const NumpyArray &data, const Index32 &byte_offsets)
const std::string | index_form_to_name (const std::string &form_index)
const std::string | index_form_to_vm_format (const std::string &form_index)
const std::string | primitive_to_state (const std::string &name)
const std::string | primitive_to_vm_format (const std::string &name)
template<typename T >
const std::string | type_to_name ()
| Returns the name of a primitive type as a string. More...
template<>
const std::string | type_to_name< bool > ()
| Returns `bool` string when the primitive type is boolean. More...
template<>
const std::string | type_to_name< int8_t > ()
| Returns `int8` string when the primitive type is an 8-bit signed integer. More...
template<>
const std::string | type_to_name< int16_t > ()
| Returns `int16` string when the primitive type is a 16-bit signed integer. More...
template<>
const std::string | type_to_name< int32_t > ()
| Returns `int32` string when the primitive type is a 32-bit signed integer. More...
template<>
const std::string | type_to_name< int64_t > ()
| Returns `int64` string when the primitive type is a 64-bit signed integer. More...
template<>
const std::string | type_to_name< uint8_t > ()
| Returns `uint8` string when the primitive type is an 8-bit unsigned integer. More...
template<>
const std::string | type_to_name< uint16_t > ()
| Returns `uint16` string when the primitive type is a 16-bit unsigned integer. More...
template<>
const std::string | type_to_name< uint32_t > ()
| Returns `uint32` string when the primitive type is a 32-bit unsigned integer. More...
template<>
const std::string | type_to_name< uint64_t > ()
| Returns `uint64` string when the primitive type is a 64-bit unsigned integer. More...
template<>
const std::string | type_to_name< float > ()
| Returns `float32` string when the primitive type is a floating point. More...
template<>
const std::string | type_to_name< double > ()
| Returns `float32` string when the primitive type is a double floating point. More...
template<>
const std::string | type_to_name< char > ()
| Returns `char` string when the primitive type is a character. More...
template<>
const std::string | type_to_name< std::complex< float > > ()
| Returns `complex64` string when the primitive type is a complex number with float32 real and float32 imaginary parts. More...
template<>
const std::string | type_to_name< std::complex< double > > ()
| Returns `complex128` string when the primitive type is a complex number with float64 real and float64 imaginary parts. More...
template<typename T >
const std::string | type_to_numpy_like ()
| Returns `char` string when the primitive type is a character. More...
template<>
const std::string | type_to_numpy_like< uint8_t > ()
| Returns numpy-like character code of a primitive type as a string. More...
template<>
const std::string | type_to_numpy_like< int8_t > ()
| Returns numpy-like character code `i8`, when the primitive type is an 8-bit signed integer. More...
template<>
const std::string | type_to_numpy_like< uint32_t > ()
| Returns numpy-like character code `u32`, when the primitive type is a 32-bit unsigned integer. More...
template<>
const std::string | type_to_numpy_like< int32_t > ()
| Returns numpy-like character code `i32`, when the primitive type is a 32-bit signed integer. More...
template<>
const std::string | type_to_numpy_like< int64_t > ()
| Returns numpy-like character code `i64`, when the primitive type is a 64-bit signed integer. More...
template<typename T >
std::string | type_to_form (int64_t form_key_id)
| Generates a Form, which is a unique description of the Layout Builder and its contents in the form of a JSON-like string. More...
template<typename T >
bool | is_awkward_type ()
| Check if an RDataFrame column is an Awkward Array. More...
template<typename FUNCTION , typename... CONTENTs>
void | visit_at (std::tuple< CONTENTs... > const &contents, size_t index, FUNCTION fun)
| Visits the tuple contents at `index`. More...
template<typename FUNCTION , typename... CONTENTs>
void | visit_at (std::tuple< CONTENTs... > &contents, size_t index, FUNCTION fun)
| Visits the tuple contents at `index`. More...

## Variables
const ContentPtr | none
| A constant value with type None. More...
template<typename , typename = void>
constexpr bool | is_iterable {}

## Typedef Documentation

## ◆ ArrayCachePtr

typedef std::shared_ptr< ArrayCache > ArrayCachePtr

## ◆ ArrayGeneratorPtr

using ArrayGeneratorPtr = std::shared_ptr<ArrayGenerator>

## ◆ BuilderOptions

using BuilderOptions = Options<int64_t, double>

## ◆ BuilderPtr

typedef std::shared_ptr< Builder > BuilderPtr

## ◆ ContentPtr

typedef std::shared_ptr< Content > ContentPtr

## ◆ ContentPtrVec

using ContentPtrVec = std::vector<std::shared_ptr<Content> >

## ◆ FormBuilderPtr

using FormBuilderPtr = std::shared_ptr<FormBuilder<T, I> >

## ◆ FormKey

using FormKey = std::shared_ptr<std::string>

## ◆ FormPtr

using FormPtr = std::shared_ptr<Form>

## ◆ ForthMachine32

using ForthMachine32 = ForthMachineOf<int32_t, int32_t>

## ◆ ForthMachine64

using ForthMachine64 = ForthMachineOf<int64_t, int32_t>

## ◆ ForthOutputBufferMap

typedef std::map< std::string, std::shared_ptr< ForthOutputBuffer > > ForthOutputBufferMap

## ◆ Identities32

using Identities32 = IdentitiesOf<int32_t>

## ◆ Identities64

using Identities64 = IdentitiesOf<int64_t>

## ◆ IdentitiesPtr

using IdentitiesPtr = std::shared_ptr<Identities>

## ◆ Index32

using Index32 = IndexOf<int32_t>

## ◆ Index64

using Index64 = IndexOf<int64_t>

## ◆ Index8

using Index8 = IndexOf<int8_t>

## ◆ IndexedArray32

using IndexedArray32 = IndexedArrayOf<int32_t, false>

## ◆ IndexedArray64

using IndexedArray64 = IndexedArrayOf<int64_t, false>

## ◆ IndexedArrayU32

using IndexedArrayU32 = IndexedArrayOf<uint32_t, false>

## ◆ IndexedOptionArray32

using IndexedOptionArray32 = IndexedArrayOf<int32_t, true>

## ◆ IndexedOptionArray64

using IndexedOptionArray64 = IndexedArrayOf<int64_t, true>

## ◆ IndexU32

using IndexU32 = IndexOf<uint32_t>

## ◆ IndexU8

using IndexU8 = IndexOf<uint8_t>

## ◆ LayoutBuilder32

using LayoutBuilder32 = LayoutBuilder<int32_t, int32_t>

## ◆ LayoutBuilder64

using LayoutBuilder64 = LayoutBuilder<int64_t, int32_t>

## ◆ LayoutBuilderPtr

using LayoutBuilderPtr = LayoutBuilder<T, I>*

## ◆ ListArray32

using ListArray32 = ListArrayOf<int32_t>

## ◆ ListArray64

using ListArray64 = ListArrayOf<int64_t>

## ◆ ListArrayU32

using ListArrayU32 = ListArrayOf<uint32_t>

## ◆ ListOffsetArray32

using ListOffsetArray32 = ListOffsetArrayOf<int32_t>

## ◆ ListOffsetArray64

using ListOffsetArray64 = ListOffsetArrayOf<int64_t>

## ◆ ListOffsetArrayU32

using ListOffsetArrayU32 = ListOffsetArrayOf<uint32_t>

## ◆ PartitionedArrayPtr

using PartitionedArrayPtr = std::shared_ptr<PartitionedArray>

## ◆ SliceArray64

using SliceArray64 = SliceArrayOf<int64_t>

## ◆ SliceItemPtr

using SliceItemPtr = std::shared_ptr<SliceItem>

## ◆ SliceJagged64

using SliceJagged64 = SliceJaggedOf<int64_t>

## ◆ SliceMissing64

using SliceMissing64 = SliceMissingOf<int64_t>

## ◆ TypePtr

typedef std::shared_ptr< Type > TypePtr

## ◆ UnionArray8_32

using UnionArray8_32 = UnionArrayOf<int8_t, int32_t>

## ◆ UnionArray8_64

using UnionArray8_64 = UnionArrayOf<int8_t, int64_t>

## ◆ UnionArray8_U32

using UnionArray8_U32 = UnionArrayOf<int8_t, uint32_t>

## ◆ utype

using utype = std::underlying_type<state>::type

## ◆ void_t

using void_t = typename voider<T...>::type

## Enumeration Type Documentation

## ◆ state

enum class state : std::int32_t
| strong

Enumerator
int64 |
float64 |
begin_list |
end_list |
boolean |
int8 |
int16 |
int32 |
uint8 |
uint16 |
uint32 |
uint64 |
float16 |
float32 |
float128 |
complex64 |
complex128 |
complex256 |
null |
index |
tag |
datetime64 |
timedelta64 |

## Function Documentation

## ◆ byteswap16()

void byteswap16 | ( | int64_t | num_items,
|  | T & | value
| ) |  |

HERE.

## ◆ byteswap32()

void byteswap32 | ( | int64_t | num_items,
|  | T & | value
| ) |  |

HERE.

## ◆ byteswap64()

void byteswap64 | ( | int64_t | num_items,
|  | T & | value
| ) |  |

HERE.

## ◆ byteswap_intp()

void byteswap_intp | ( | int64_t | num_items,
|  | T & | value
| ) |  |

HERE.

## ◆ FromJsonFile()

LIBAWKWARD_EXPORT_SYMBOL int64_t FromJsonFile | ( | FILE * | source,
|  | ArrayBuilder & | builder,
|  | int64_t | buffersize,
|  | const char * | nan_string = `nullptr`,
|  | const char * | infinity_string = `nullptr`,
|  | const char * | minus_infinity_string = `nullptr`
| ) |  |

Parses a JSON-encoded file using an ArrayBuilder.

Parameters

  source | C file handle to a file containing any valid JSON data.
  builder | To build the array.
  buffersize | Number of bytes for an intermediate buffer.
  nan_string | User-defined string for a not-a-number (NaN) value representation in JSON format.
  infinity_string | User-defined string for a positive infinity representation in JSON format.
  minus_infinity_string | User-defined string for a negative infinity representation in JSON format.

## ◆ fromjsonobject()

LIBAWKWARD_EXPORT_SYMBOL void fromjsonobject | ( | FileLikeObject * | source,
|  | ArrayBuilder & | builder,
|  | int64_t | buffersize,
|  | bool | read_one,
|  | const char * | nan_string = `nullptr`,
|  | const char * | posinf_string = `nullptr`,
|  | const char * | neginf_string = `nullptr`
| ) |  |

Parses a JSON-encoded file-like object using an ArrayBuilder.

Parameters

  source | File-like object wrapped with the FileLikeObject abstraction (borrowed reference).
  builder | To build the array.
  buffersize | Number of bytes for an intermediate buffer.
  read_one | If true, read only one JSON object (with an error if there's more); otherwise, read a stream of concatenated objects (may be separated by newlines, but we don't check).
  nan_string | User-defined string for a not-a-number (NaN) value representation in JSON format.
  infinity_string | User-defined string for a positive infinity representation in JSON format.
  minus_infinity_string | User-defined string for a negative infinity representation in JSON format.

## ◆ FromJsonString()

LIBAWKWARD_EXPORT_SYMBOL int64_t FromJsonString | ( | const char * | source,
|  | ArrayBuilder & | builder,
|  | const char * | nan_string = `nullptr`,
|  | const char * | infinity_string = `nullptr`,
|  | const char * | minus_infinity_string = `nullptr`
| ) |  |

Parses a JSON-encoded string using an ArrayBuilder.

Parameters

  source | Null-terminated string containing any valid JSON data.
  builder | To build the array.
  nan_string | User-defined string for a not-a-number (NaN) value representation in JSON format.
  infinity_string | User-defined string for a positive infinity representation in JSON format.
  minus_infinity_string | User-defined string for a negative infinity representation in JSON format.

## ◆ index_form_to_name()

const std::string index_form_to_name | ( | const std::string & | form_index | ) |

## ◆ index_form_to_vm_format()

const std::string index_form_to_vm_format | ( | const std::string & | form_index | ) |

## ◆ is_awkward_type()

bool is_awkward_type | ( |  | ) |

Check if an RDataFrame column is an Awkward Array.

## ◆ primitive_to_state()

const std::string primitive_to_state | ( | const std::string & | name | ) |

## ◆ primitive_to_vm_format()

const std::string primitive_to_vm_format | ( | const std::string & | name | ) |

## ◆ type_to_form()

std::string type_to_form | ( | int64_t | form_key_id | ) |

Generates a Form, which is a unique description of the Layout Builder and its contents in the form of a JSON-like string.

Used in RDataFrame to generate the form of the Numpy Layout Builder and ListOffset Layout Builder.

## ◆ type_to_name()

const std::string type_to_name | ( |  | ) |

Returns the name of a primitive type as a string.

## ◆ type_to_name< bool >()

const std::string type_to_name< bool > | ( |  | ) |

Returns `bool` string when the primitive type is boolean.

## ◆ type_to_name< char >()

const std::string type_to_name< char > | ( |  | ) |

Returns `char` string when the primitive type is a character.

## ◆ type_to_name< double >()

const std::string type_to_name< double > | ( |  | ) |

Returns `float32` string when the primitive type is a double floating point.

## ◆ type_to_name< float >()

const std::string type_to_name< float > | ( |  | ) |

Returns `float32` string when the primitive type is a floating point.

## ◆ type_to_name< int16_t >()

const std::string type_to_name< int16_t > | ( |  | ) |

Returns `int16` string when the primitive type is a 16-bit signed integer.

## ◆ type_to_name< int32_t >()

const std::string type_to_name< int32_t > | ( |  | ) |

Returns `int32` string when the primitive type is a 32-bit signed integer.

## ◆ type_to_name< int64_t >()

const std::string type_to_name< int64_t > | ( |  | ) |

Returns `int64` string when the primitive type is a 64-bit signed integer.

## ◆ type_to_name< int8_t >()

const std::string type_to_name< int8_t > | ( |  | ) |

Returns `int8` string when the primitive type is an 8-bit signed integer.

## ◆ type_to_name< std::complex< double > >()

const std::string type_to_name< std::complex< double > > | ( |  | ) |

Returns `complex128` string when the primitive type is a complex number with float64 real and float64 imaginary parts.

## ◆ type_to_name< std::complex< float > >()

const std::string type_to_name< std::complex< float > > | ( |  | ) |

Returns `complex64` string when the primitive type is a complex number with float32 real and float32 imaginary parts.

## ◆ type_to_name< uint16_t >()

const std::string type_to_name< uint16_t > | ( |  | ) |

Returns `uint16` string when the primitive type is a 16-bit unsigned integer.

## ◆ type_to_name< uint32_t >()

const std::string type_to_name< uint32_t > | ( |  | ) |

Returns `uint32` string when the primitive type is a 32-bit unsigned integer.

## ◆ type_to_name< uint64_t >()

const std::string type_to_name< uint64_t > | ( |  | ) |

Returns `uint64` string when the primitive type is a 64-bit unsigned integer.

## ◆ type_to_name< uint8_t >()

const std::string type_to_name< uint8_t > | ( |  | ) |

Returns `uint8` string when the primitive type is an 8-bit unsigned integer.

## ◆ type_to_numpy_like()

const std::string type_to_numpy_like | ( |  | ) |

Returns `char` string when the primitive type is a character.

## ◆ type_to_numpy_like< int32_t >()

const std::string type_to_numpy_like< int32_t > | ( |  | ) |

Returns numpy-like character code `i32`, when the primitive type is a 32-bit signed integer.

## ◆ type_to_numpy_like< int64_t >()

const std::string type_to_numpy_like< int64_t > | ( |  | ) |

Returns numpy-like character code `i64`, when the primitive type is a 64-bit signed integer.

## ◆ type_to_numpy_like< int8_t >()

const std::string type_to_numpy_like< int8_t > | ( |  | ) |

Returns numpy-like character code `i8`, when the primitive type is an 8-bit signed integer.

## ◆ type_to_numpy_like< uint32_t >()

const std::string type_to_numpy_like< uint32_t > | ( |  | ) |

Returns numpy-like character code `u32`, when the primitive type is a 32-bit unsigned integer.

## ◆ type_to_numpy_like< uint8_t >()

const std::string type_to_numpy_like< uint8_t > | ( |  | ) |

Returns numpy-like character code of a primitive type as a string.

## ◆ uproot_issue_90()

LIBAWKWARD_EXPORT_SYMBOL const ContentPtr uproot_issue_90 | ( | const Form & | form,
|  | const NumpyArray & | data,
|  | const Index32 & | byte_offsets
| ) |  |

## ◆ visit_at() [1/2]

void visit_at | ( | std::tuple< CONTENTs... > & | contents,
|  | size_t | index,
|  | FUNCTION | fun
| ) |  |

Visits the tuple contents at `index`.

## ◆ visit_at() [2/2]

void visit_at | ( | std::tuple< CONTENTs... > const & | contents,
|  | size_t | index,
|  | FUNCTION | fun
| ) |  |

Visits the tuple contents at `index`.

## Variable Documentation

## ◆ is_iterable

constexpr bool is_iterable {}
| constexpr

## ◆ none

const ContentPtr none
| extern

A constant value with type None.