MATHLIB_tan

Introduction

Kernel for computing vector tangent floating point values.

• The kernel support computation of tangent of a batch of several inputs in one kernel call.
• The buffer used for providing input data may be required to be bigger than data size itself. The actual size required to be allocated for the input buffer

Data Structures
struct	MATHLIB_tan_InitArgs
	Structure containing the parameters to initialize the kernel. More...

Functions
int32_t	MATHLIB_tan_getHandleSize (MATHLIB_tan_InitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...
MATHLIB_STATUS	MATHLIB_tan_init (MATHLIB_kernelHandle handle, MATHLIB_bufParams1D_t *bufParamsIn, MATHLIB_bufParams1D_t *bufParamsOut, const MATHLIB_tan_InitArgs *pKerInitArgs)
	This function should be called before the MATHLIB_tan_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the MMA accelerator and the streaming engine. The results of these operations are stored in the handle. More...
MATHLIB_STATUS	MATHLIB_tan_init_checkParams (MATHLIB_kernelHandle handle, const MATHLIB_bufParams2D_t *bufParamsIn, const MATHLIB_bufParams2D_t *bufParamsOut, const MATHLIB_tan_InitArgs *pKerInitArgs)
	This function checks the validity of the parameters passed to MATHLIB_tan_init function. This function is called with the same parameters as the MATHLIB_tan_init, and this function must be called before the MATHLIB_tan_init is called. More...
MATHLIB_STATUS	MATHLIB_tan_exec (MATHLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
	This function is the main kernel compute function. More...
MATHLIB_STATUS	MATHLIB_tan_exec_checkParams (MATHLIB_kernelHandle handle, const void *restrict pIn, const void *restrict pOut)
	This function checks the validity of the parameters passed to MATHLIB_tan_exec function. This function is called with the same parameters as the MATHLIB_tan_exec, and this function must be called before the MATHLIB_tan_exec is called. More...
void	MATHLIB_tan_perfEst (MATHLIB_kernelHandle handle, const MATHLIB_bufParams2D_t *bufParamsIn, const MATHLIB_bufParams1D_t *bufParamsFilterCoeff, const MATHLIB_bufParams2D_t *bufParamsFilterVar, const MATHLIB_bufParams2D_t *bufParamsOut, uint64_t *archCycles, uint64_t *estCycles)
	This is a utility function that gives an estimate of the cycles consumed for the kernel execution. More...

Function Documentation

MATHLIB_tan_getHandleSize()

int32_t MATHLIB_tan_getHandleSize

(

MATHLIB_tan_InitArgs *

pKerInitArgs

)

This is a query function to calculate the size of internal handle.

Parameters

[in]

pKerInitArgs

: Pointer to structure holding init parameters

Returns

Size of the buffer in bytes

Remarks

Application is expected to allocate buffer of the requested size and provide it as input to other functions requiring it.

MATHLIB_tan_init()

MATHLIB_STATUS MATHLIB_tan_init	(	MATHLIB_kernelHandle	handle,
		MATHLIB_bufParams1D_t *	bufParamsIn,
		MATHLIB_bufParams1D_t *	bufParamsOut,
		const MATHLIB_tan_InitArgs *	pKerInitArgs
	)

This function should be called before the MATHLIB_tan_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the MMA accelerator and the streaming engine. The results of these operations are stored in the handle.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of filter buffer
[out]	bufParamsOut	: Pointer to the structure containing dimensional information of ouput buffer
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to MATHLIB_STATUS.

Remarks

Application is expected to provide a valid handle.

MATHLIB_tan_init_checkParams()

MATHLIB_STATUS MATHLIB_tan_init_checkParams	(	MATHLIB_kernelHandle	handle,
		const MATHLIB_bufParams2D_t *	bufParamsIn,
		const MATHLIB_bufParams2D_t *	bufParamsOut,
		const MATHLIB_tan_InitArgs *	pKerInitArgs
	)

This function checks the validity of the parameters passed to MATHLIB_tan_init function. This function is called with the same parameters as the MATHLIB_tan_init, and this function must be called before the MATHLIB_tan_init is called.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of input buffer
[out]	bufParamsOut	: Pointer to the structure containing dimensional information of output buffer
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to MATHLIB_STATUS.

Remarks

None

MATHLIB_tan_exec()

MATHLIB_STATUS MATHLIB_tan_exec	(	MATHLIB_kernelHandle	handle,
		void *restrict	pIn,
		void *restrict	pOut
	)

This function is the main kernel compute function.

Please refer to details under MATHLIB_tan_exec

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn	: Pointer to buffer holding the input data
[out]	pOut	: Pointer to buffer holding the output data

Returns

Status value indicating success or failure. Refer to MATHLIB_STATUS.

Assumptions:

• None

Performance Considerations:

For best performance,

• the input and output data buffers are expected to be in L2 memory
• the buffer pointers are assumed to be 64-byte aligned

Remarks

Before calling this function, application is expected to call MATHLIB_tan_init and MATHLIB_tan_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

MATHLIB_tan_exec_checkParams()

MATHLIB_STATUS MATHLIB_tan_exec_checkParams	(	MATHLIB_kernelHandle	handle,
		const void *restrict	pIn,
		const void *restrict	pOut
	)

This function checks the validity of the parameters passed to MATHLIB_tan_exec function. This function is called with the same parameters as the MATHLIB_tan_exec, and this function must be called before the MATHLIB_tan_exec is called.

Parameters

[in]	handle	: Active handle to the kernel
[in]	pIn	: Pointer to buffer holding the input data
[in]	pFilter	: Pointer to buffer holding the input data
[out]	pOut	: Pointer to buffer holding the output matrix

Returns

Status value indicating success or failure. Refer to MATHLIB_STATUS.

Remarks

None

MATHLIB_tan_perfEst()

void MATHLIB_tan_perfEst	(	MATHLIB_kernelHandle	handle,
		const MATHLIB_bufParams2D_t *	bufParamsIn,
		const MATHLIB_bufParams1D_t *	bufParamsFilterCoeff,
		const MATHLIB_bufParams2D_t *	bufParamsFilterVar,
		const MATHLIB_bufParams2D_t *	bufParamsOut,
		uint64_t *	archCycles,
		uint64_t *	estCycles
	)

This is a utility function that gives an estimate of the cycles consumed for the kernel execution.

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsIn	: Pointer to the structure containing dimensional information of the input buffer
[in]	bufParamsFilter	: Pointer to the structure containing dimensional information of the filter buffer
[in]	bufParamsOut	: Pointer to the structure containing dimensional information of the output buffer
[out]	archCycles	: Cycles estimated for the compute, startup and teardown
[out]	estCycles	: Cycles estimated for the compute, startup, teardown and any associated overhead

Remarks

None