kuzu::function::ScalarFunction Struct Reference

#include <scalar_function.h>

Inheritance diagram for kuzu::function::ScalarFunction:

Public Member Functions
	ScalarFunction ()=default
	ScalarFunction (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID)
	ScalarFunction (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID, scalar_func_exec_t execFunc)
	ScalarFunction (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID, scalar_func_exec_t execFunc, scalar_func_select_t selectFunc)
virtual std::unique_ptr< ScalarFunction >	copy () const
Public Member Functions inherited from kuzu::function::ScalarOrAggregateFunction
	ScalarOrAggregateFunction ()
	ScalarOrAggregateFunction (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID)
	ScalarOrAggregateFunction (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID, scalar_bind_func bindFunc)
std::string	signatureToString () const override
Public Member Functions inherited from kuzu::function::Function
	Function ()
	Function (std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs)
	Function (const Function &)=default
virtual	~Function ()=default
template<class TARGET>
const TARGET *	constPtrCast () const
template<class TARGET>
TARGET *	ptrCast ()

Static Public Member Functions
template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>
static void	TernaryExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr=nullptr)
template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>
static void	TernaryStringExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr=nullptr)
template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>
static void	TernaryRegexExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>
static void	TernaryExecListStructFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr=nullptr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>
static void	BinaryExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *=nullptr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>
static void	BinaryStringExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr=nullptr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>
static void	BinaryExecListStructFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr=nullptr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>
static void	BinaryExecWithBindData (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename FUNC>
static bool	BinarySelectFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, common::SelectionVector &selVector, void *dataPtr)
template<typename LEFT_TYPE, typename RIGHT_TYPE, typename FUNC>
static bool	BinarySelectWithBindData (const std::vector< std::shared_ptr< common::ValueVector > > &params, common::SelectionVector &selVector, void *dataPtr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>
static void	UnaryExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>
static void	UnarySequenceExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>
static void	UnaryStringExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *=nullptr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>
static void	UnaryCastStringExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>
static void	UnaryCastExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>
static void	UnaryExecNestedTypeFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *=nullptr)
template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>
static void	UnaryExecStructFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)
template<typename RESULT_TYPE, typename FUNC>
static void	NullaryExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *=nullptr)
template<typename RESULT_TYPE, typename FUNC>
static void	NullaryAuxilaryExecFunction (const std::vector< std::shared_ptr< common::ValueVector > > &params, const std::vector< common::SelectionVector * > &paramSelVectors, common::ValueVector &result, common::SelectionVector *resultSelVector, void *dataPtr)

Public Attributes
scalar_func_exec_t	execFunc = nullptr
scalar_func_select_t	selectFunc = nullptr
scalar_func_compile_exec_t	compileFunc = nullptr
Public Attributes inherited from kuzu::function::ScalarOrAggregateFunction
common::LogicalTypeID	returnTypeID = common::LogicalTypeID::ANY
scalar_bind_func	bindFunc = nullptr
Public Attributes inherited from kuzu::function::Function
std::string	name
std::vector< common::LogicalTypeID >	parameterTypeIDs
bool	isVarLength = false
bool	isListLambda = false
bool	isReadOnly = true

Constructor & Destructor Documentation

ScalarFunction() [1/4]

kuzu::function::ScalarFunction::ScalarFunction ( )

default

ScalarFunction() [2/4]

kuzu::function::ScalarFunction::ScalarFunction ( std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID )

inline

ScalarFunction() [3/4]

kuzu::function::ScalarFunction::ScalarFunction ( std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID, scalar_func_exec_t execFunc )

inline

ScalarFunction() [4/4]

kuzu::function::ScalarFunction::ScalarFunction ( std::string name, std::vector< common::LogicalTypeID > parameterTypeIDs, common::LogicalTypeID returnTypeID, scalar_func_exec_t execFunc, scalar_func_select_t selectFunc )

inline

Member Function Documentation

BinaryExecFunction()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::BinaryExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * = nullptr )

inlinestatic

BinaryExecListStructFunction()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::BinaryExecListStructFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr = nullptr )

inlinestatic

BinaryExecWithBindData()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::BinaryExecWithBindData ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

BinarySelectFunction()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename FUNC>

static bool kuzu::function::ScalarFunction::BinarySelectFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, common::SelectionVector & selVector, void * dataPtr )

inlinestatic

BinarySelectWithBindData()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename FUNC>

static bool kuzu::function::ScalarFunction::BinarySelectWithBindData ( const std::vector< std::shared_ptr< common::ValueVector > > & params, common::SelectionVector & selVector, void * dataPtr )

inlinestatic

BinaryStringExecFunction()

template<typename LEFT_TYPE, typename RIGHT_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::BinaryStringExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr = nullptr )

inlinestatic

copy()

virtual std::unique_ptr< ScalarFunction > kuzu::function::ScalarFunction::copy ( ) const

inlinevirtual

NullaryAuxilaryExecFunction()

template<typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::NullaryAuxilaryExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

NullaryExecFunction()

template<typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::NullaryExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * = nullptr )

inlinestatic

TernaryExecFunction()

template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::TernaryExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr = nullptr )

inlinestatic

TernaryExecListStructFunction()

template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::TernaryExecListStructFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr = nullptr )

inlinestatic

TernaryRegexExecFunction()

template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::TernaryRegexExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

TernaryStringExecFunction()

template<typename A_TYPE, typename B_TYPE, typename C_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::TernaryStringExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr = nullptr )

inlinestatic

UnaryCastExecFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>

static void kuzu::function::ScalarFunction::UnaryCastExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

UnaryCastStringExecFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>

static void kuzu::function::ScalarFunction::UnaryCastStringExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

UnaryExecFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC, typename EXECUTOR = UnaryFunctionExecutor>

static void kuzu::function::ScalarFunction::UnaryExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

UnaryExecNestedTypeFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::UnaryExecNestedTypeFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * = nullptr )

inlinestatic

UnaryExecStructFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::UnaryExecStructFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

UnarySequenceExecFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::UnarySequenceExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * dataPtr )

inlinestatic

UnaryStringExecFunction()

template<typename OPERAND_TYPE, typename RESULT_TYPE, typename FUNC>

static void kuzu::function::ScalarFunction::UnaryStringExecFunction ( const std::vector< std::shared_ptr< common::ValueVector > > & params, const std::vector< common::SelectionVector * > & paramSelVectors, common::ValueVector & result, common::SelectionVector * resultSelVector, void * = nullptr )

inlinestatic

Member Data Documentation

compileFunc

scalar_func_compile_exec_t kuzu::function::ScalarFunction::compileFunc = nullptr

execFunc

scalar_func_exec_t kuzu::function::ScalarFunction::execFunc = nullptr

selectFunc

scalar_func_select_t kuzu::function::ScalarFunction::selectFunc = nullptr

---

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

• headers/scalar_function.h