API reference#

This page provides an auto-generated summary of RBC’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation and check the Notebooks folder in the main repository.

Top-level functions#

`ctools`
`external`	Low-level intrinsics to expose external functions
`errors`	rbc-specific errors and warnings.
`libfuncs`	Collections of library function names.
`heavydb`
`remotejit`	RemoteJIT client/server config functions
`structure_type`
`targetinfo`	TargetInfo class specific
`typesystem`	Provides Type structures.
`utils`	Collection of helper functions

Array API#

`stdlib.constants`	Array API specification for creation functions.
`stdlib.creation_functions`	Array API specification for creation functions.
`stdlib.datatypes`	Array API specification for data types.
`stdlib.data_type_functions`	Array API specification for data type functions.
`stdlib.elementwise_functions`	Array API specification for element-wise functions.
`stdlib.linear_algebra_functions`	Array API specification for linear algebra functions.
`stdlib.manipulation_functions`	Array API specification for manipulation functions.
`stdlib.searching_functions`	Array API specification for searching functions.
`stdlib.set_functions`	Array API specification for set functions.
`stdlib.sorting_functions`	Array API specification for sorting functions.
`stdlib.statistical_functions`	Array API specification for statistical functions.
`stdlib.utility_functions`	Array API specification for utility functions.

Externals#

`externals.cmath`	https://en.cppreference.com/w/c/numeric/math
`externals.libdevice`	https://docs.nvidia.com/cuda/libdevice-users-guide/index.html
`externals.macros`	This module provides the following tools:
`externals.heavydb`	External functions defined by the HeavyDB server
`externals.stdio`	https://en.cppreference.com/w/c/io

HeavyDB Backend#

The table below contains the data structures available for the HeavyDB backend. It should be noticed that the following types are not regular Python types but Numba types.

The set of types below are only materialize inside the HeavyDB SQL Engine. Thus, one cannot create and use them inside the REPL, for instance.

RBC design principles

rbc.ctools