Awkward Array: BuffersContainer Class Reference

Loading...
Searching...
No Matches
Public Member Functions | List of all members
BuffersContainer Class Referenceabstract

Abstract class to represent the output of ak.to_buffers. In Python, this would be a dict of NumPy arrays. More...

`#include <Builder.h>`

## Public Member Functions
virtual void | copy_buffer (const std::string &name, const void *source, int64_t num_bytes)=0
| Copy data at `source` with `num_bytes` into the BuffersContainer with `name`.
virtual void | full_buffer (const std::string &name, int64_t length, int64_t value, const std::string &dtype)=0
| Create an array initialized to a given fill value.
virtual void * | empty_buffer (const std::string &name, int64_t num_bytes)=0

## Detailed Description

Abstract class to represent the output of ak.to_buffers. In Python, this would be a dict of NumPy arrays.

## Member Function Documentation

## ◆ copy_buffer()

virtual void copy_buffer | ( | const std::string & | name,
|  | const void * | source,
|  | int64_t | num_bytes
| ) |  |
| pure virtual

Copy data at `source` with `num_bytes` into the BuffersContainer with `name`.

In Python, this allocates a NumPy array and copies data into it.

## ◆ empty_buffer()

virtual void * empty_buffer | ( | const std::string & | name,
|  | int64_t | num_bytes
| ) |  |
| pure virtual

## ◆ full_buffer()

virtual void full_buffer | ( | const std::string & | name,
|  | int64_t | length,
|  | int64_t | value,
|  | const std::string & | dtype
| ) |  |
| pure virtual

Create an array initialized to a given fill value.

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

- include/awkward/builder/Builder.h