Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | List of all members
arrow::compute::FunctionContext Class Reference

Container for variables and options used by function evaluation. More...

#include <arrow/compute/context.h>

Public Member Functions

 FunctionContext (MemoryPool *pool ARROW_MEMORY_POOL_DEFAULT)
 
MemoryPoolmemory_pool () const
 
Status Allocate (const int64_t nbytes, std::shared_ptr< Buffer > *out)
 Allocate buffer from the context's memory pool. More...
 
void SetStatus (const Status &status)
 Indicate that an error has occurred, to be checked by a parent caller. More...
 
void ResetStatus ()
 Clear any error status. More...
 
bool HasError () const
 Return true if an error has occurred. More...
 
const Statusstatus () const
 Return the current status of the context. More...
 

Detailed Description

Container for variables and options used by function evaluation.

Constructor & Destructor Documentation

◆ FunctionContext()

arrow::compute::FunctionContext::FunctionContext ( MemoryPool *pool  ARROW_MEMORY_POOL_DEFAULT)
explicit

Member Function Documentation

◆ Allocate()

Status arrow::compute::FunctionContext::Allocate ( const int64_t  nbytes,
std::shared_ptr< Buffer > *  out 
)

Allocate buffer from the context's memory pool.

◆ HasError()

bool arrow::compute::FunctionContext::HasError ( ) const
inline

Return true if an error has occurred.

◆ memory_pool()

MemoryPool* arrow::compute::FunctionContext::memory_pool ( ) const

◆ ResetStatus()

void arrow::compute::FunctionContext::ResetStatus ( )

Clear any error status.

◆ SetStatus()

void arrow::compute::FunctionContext::SetStatus ( const Status status)

Indicate that an error has occurred, to be checked by a parent caller.

Parameters
[in]statusa Status instance
Note
Will not overwrite a prior set Status, so we will have the first error that occurred until FunctionContext::ResetStatus is called

◆ status()

const Status& arrow::compute::FunctionContext::status ( ) const
inline

Return the current status of the context.


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