Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Classes | Functions
arrow::compute Namespace Reference

Classes

struct  CastOptions
 
class  FunctionContext
 Container for variables and options used by function evaluation. More...
 
class  OpKernel
 Base class for operator kernels. More...
 
class  UnaryKernel
 An array-valued function of a single input argument. More...
 

Functions

Status GetCastFunction (const DataType &in_type, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::unique_ptr< UnaryKernel > *kernel)
 
Status Cast (FunctionContext *context, const Array &array, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::shared_ptr< Array > *out)
 Cast from one array type to another. More...
 
Status Cast (FunctionContext *context, const ChunkedArray &array, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::shared_ptr< ChunkedArray > *out)
 Cast from one chunked array type to another. More...
 
Status Cast (FunctionContext *context, const Column &array, const std::shared_ptr< DataType > &to_type, const CastOptions &options, std::shared_ptr< Column > *out)
 Cast from one column type to another. More...
 
Status GetUniqueFunction (const DataType &in_type, std::unique_ptr< UnaryKernel > *kernel)
 
Status Unique (FunctionContext *context, const Array &array, std::shared_ptr< Array > *out)
 Unique elements of an array. More...
 
Status Unique (FunctionContext *context, const ChunkedArray &array, std::shared_ptr< Array > *out)
 Unique elements of a chunked array. More...
 
Status Unique (FunctionContext *context, const Column &array, std::shared_ptr< Array > *out)
 Unique elements of a column. More...
 

Function Documentation

◆ Cast() [1/3]

Status arrow::compute::Cast ( FunctionContext context,
const Array array,
const std::shared_ptr< DataType > &  to_type,
const CastOptions options,
std::shared_ptr< Array > *  out 
)

Cast from one array type to another.

Parameters
[in]contextthe FunctionContext
[in]arrayarray to cast
[in]to_typetype to cast to
[in]optionscasting options
[out]outresulting array
Since
0.7.0
Note
API not yet finalized

◆ Cast() [2/3]

Status arrow::compute::Cast ( FunctionContext context,
const ChunkedArray array,
const std::shared_ptr< DataType > &  to_type,
const CastOptions options,
std::shared_ptr< ChunkedArray > *  out 
)

Cast from one chunked array type to another.

Parameters
[in]contextthe FunctionContext
[in]arraychunked array to cast
[in]to_typetype to cast to
[in]optionscasting options
[out]outresulting chunked array
Since
0.8.0
Note
API not yet finalized

◆ Cast() [3/3]

Status arrow::compute::Cast ( FunctionContext context,
const Column array,
const std::shared_ptr< DataType > &  to_type,
const CastOptions options,
std::shared_ptr< Column > *  out 
)

Cast from one column type to another.

Parameters
[in]contextthe FunctionContext
[in]columncolumn to cast
[in]to_typetype to cast to
[in]optionscasting options
[out]outresulting column
Since
0.8.0
Note
API not yet finalized

◆ GetCastFunction()

Status arrow::compute::GetCastFunction ( const DataType in_type,
const std::shared_ptr< DataType > &  to_type,
const CastOptions options,
std::unique_ptr< UnaryKernel > *  kernel 
)
Since
0.7.0
Note
API not yet finalized

◆ GetUniqueFunction()

Status arrow::compute::GetUniqueFunction ( const DataType in_type,
std::unique_ptr< UnaryKernel > *  kernel 
)
Since
0.8.0
Note
API not yet finalized

◆ Unique() [1/3]

Status arrow::compute::Unique ( FunctionContext context,
const Array array,
std::shared_ptr< Array > *  out 
)

Unique elements of an array.

Parameters
[in]contextthe FunctionContext
[in]arrayarray with all possible values
[out]outresulting array
Since
0.8.0
Note
API not yet finalized

◆ Unique() [2/3]

Status arrow::compute::Unique ( FunctionContext context,
const ChunkedArray array,
std::shared_ptr< Array > *  out 
)

Unique elements of a chunked array.

Parameters
[in]contextthe FunctionContext
[in]arraychunked array with all possible value
[out]outresulting array
Since
0.8.0
Note
API not yet finalized

◆ Unique() [3/3]

Status arrow::compute::Unique ( FunctionContext context,
const Column array,
std::shared_ptr< Array > *  out 
)

Unique elements of a column.

Parameters
[in]contextthe FunctionContext
[in]columncolumn with all possible values
[out]outresulting array
Since
0.8.0
Note
API not yet finalized