DSPLIB_cholesky_priv.h File Reference

Introduction

Header file for kernel's internal use. For the kernel's interface, please see DSPLIB_cholesky.

Definition in file DSPLIB_cholesky_priv.h.

Go to the source code of this file.

Data Structures
struct	DSPLIB_cholesky_PrivArgs
	Structure that is reserved for internal use by the kernel. More...

Macros
#define	DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE   (7 * SE_PARAM_SIZE)
	Macro to define the size of bufPblock array of DSPLIB_cholesky_PrivArgs structure. More...

Typedefs
typedef DSPLIB_STATUS(*	pFxnDSPLIB_cholesky_exec) (DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
	This is a function pointer type that conforms to the declaration of DSPLIB_cholesky_exec_ci and DSPLIB_cholesky_exec_cn. More...

Functions
template<typename dataType >
DSPLIB_STATUS	DSPLIB_cholesky_init_ci (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsIn, const DSPLIB_bufParams2D_t *bufParamsOut, const DSPLIB_cholesky_InitArgs *pKerInitArgs)
	This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_init. More...
template<typename dataType >
DSPLIB_STATUS	DSPLIB_cholesky_exec_ci (DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
	This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_exec. More...
template<typename dataType >
DSPLIB_STATUS	DSPLIB_cholesky_exec_cn (DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
	This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_exec. More...

Macro Definition Documentation

DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE

#define DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE   (7 * SE_PARAM_SIZE)

Macro to define the size of bufPblock array of DSPLIB_cholesky_PrivArgs structure.

Definition at line 40 of file DSPLIB_cholesky_priv.h.

Typedef Documentation

pFxnDSPLIB_cholesky_exec

typedef DSPLIB_STATUS(* pFxnDSPLIB_cholesky_exec) (DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)

This is a function pointer type that conforms to the declaration of DSPLIB_cholesky_exec_ci and DSPLIB_cholesky_exec_cn.

Definition at line 47 of file DSPLIB_cholesky_priv.h.

Function Documentation

DSPLIB_cholesky_init_ci()

template<typename dataType >

DSPLIB_STATUS DSPLIB_cholesky_init_ci	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsIn,
		const DSPLIB_bufParams2D_t *	bufParamsOut,
		const DSPLIB_cholesky_InitArgs *	pKerInitArgs
	)

This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_init.

This function determines the configuration for the streaming engine and MMA hardware resources based on the function call parameters, and the configuration is saved in bufPBlock array. In the kernel call sequence, DSPLIB_cholesky_exec_ci would be called later independently by the application. When DSPLIB_cholesky_exec_ci runs, it merely retrieves the configuration from the bufPBlock and uses it to set up the hardware resources. This arrangement is so that DSPLIB_cholesky_exec_ci does not lose cycles to determine the hardware configuration.

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 ouput buffer
[in]	pKerInitArgs	: Pointer to the structure holding init parameters

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 183 of file DSPLIB_cholesky_ci.cpp.

DSPLIB_cholesky_exec_ci()

template<typename dataType >

DSPLIB_STATUS DSPLIB_cholesky_exec_ci	(	DSPLIB_kernelHandle	handle,
		void *restrict	pInA,
		void *restrict	pOutU,
		void *restrict	multiplierPtr
	)

This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_exec.

The function uses the Streaming Engine and Streaming Address generators to vectorize the operations of Cholesky Decomposition. The function process square matrix A[order][order] and stores the result in upper triangular matrix L[order][order].

Parameters

[in]	handle	: Active handle to the kernel
[in]	pInA	: Pointer to buffer holding the input data A[order][order]
[out]	pOutU	: Pointer to buffer holding the temporary output data U[order][order]

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

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

Definition at line 593 of file DSPLIB_cholesky_ci.cpp.

DSPLIB_cholesky_exec_cn()

template<typename dataType >

DSPLIB_STATUS DSPLIB_cholesky_exec_cn	(	DSPLIB_kernelHandle	handle,
		void *restrict	pInA,
		void *restrict	pOutU,
		void *restrict	multiplierPtr
	)

This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_cholesky_exec.

Parameters

[in]	handle	: Active handle to the kernel
[in]	pInA	: Pointer to buffer holding the input data A[order][order]
[out]	pOutU	: Pointer to buffer holding the temporary output data U[order][order]

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 93 of file DSPLIB_cholesky_cn.cpp.