DSPLIB User Guide
DSPLIB_qrd_solver_priv.h File Reference

Introduction

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

Definition in file DSPLIB_qrd_solver_priv.h.

Go to the source code of this file.

Data Structures

struct  DSPLIB_qrd_solver_PrivArgs
 Structure that is reserved for internal use by the kernel. More...
 

Macros

#define DSPLIB_QRD_SOLVER_IXX_IXX_OXX_PBLOCK_SIZE   (9 * SE_PARAM_SIZE)
 Macro to define the size of bufPblock array of DSPLIB_qrd_solver_PrivArgs structure. More...
 

Typedefs

typedef DSPLIB_STATUS(* pFxnDSPLIB_qrd_solver_exec) (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pB, void *restrict pY, void *restrict pX, void *restrict pD, void *restrict pR1)
 This is a function pointer type that conforms to the declaration of DSPLIB_qrd_solver_exec_ci and DSPLIB_qrd_solver_exec_cn. More...
 

Functions

template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_init_ci (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsQ, DSPLIB_bufParams2D_t *bufParamsR, DSPLIB_bufParams1D_t *bufParamsB, DSPLIB_bufParams1D_t *bufParamsY, DSPLIB_bufParams1D_t *bufParamsX, const DSPLIB_qrdSolverInitArgs *pKerInitArgs)
 This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_qrd_solver_init. More...
 
template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_exec_ci (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pB, void *restrict pY, void *restrict pX, void *restrict pD, void *restrict pR1)
 This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_qrd_solver_exec. More...
 
template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_init_cn (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsQ, DSPLIB_bufParams2D_t *bufParamsR, DSPLIB_bufParams1D_t *bufParamsB, DSPLIB_bufParams1D_t *bufParamsY, DSPLIB_bufParams1D_t *bufParamsX, const DSPLIB_qrdSolverInitArgs *pKerInitArgs)
 This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_qrd_solver_init. More...
 
template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_exec_cn (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pB, void *restrict pY, void *restrict pX, void *restrict pD, void *restrict pR1)
 This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_qrd_solver_exec. More...
 

Macro Definition Documentation

◆ DSPLIB_QRD_SOLVER_IXX_IXX_OXX_PBLOCK_SIZE

#define DSPLIB_QRD_SOLVER_IXX_IXX_OXX_PBLOCK_SIZE   (9 * SE_PARAM_SIZE)

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

Definition at line 39 of file DSPLIB_qrd_solver_priv.h.

Typedef Documentation

◆ pFxnDSPLIB_qrd_solver_exec

typedef DSPLIB_STATUS(* pFxnDSPLIB_qrd_solver_exec) (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pB, void *restrict pY, void *restrict pX, void *restrict pD, void *restrict pR1)

This is a function pointer type that conforms to the declaration of DSPLIB_qrd_solver_exec_ci and DSPLIB_qrd_solver_exec_cn.

Definition at line 46 of file DSPLIB_qrd_solver_priv.h.

Function Documentation

◆ DSPLIB_qrd_solver_init_ci()

template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_init_ci ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t bufParamsQ,
DSPLIB_bufParams2D_t bufParamsR,
DSPLIB_bufParams1D_t bufParamsB,
DSPLIB_bufParams1D_t bufParamsY,
DSPLIB_bufParams1D_t bufParamsX,
const DSPLIB_qrdSolverInitArgs pKerInitArgs 
)

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

This function determines the configuration for the streaming engine resources based on the function call parameters, and the configuration is saved in bufPBlock array. In the kernel call sequence, DSPLIB_qrd_solver_exec_ci would be called later independently by the application. When DSPLIB_qrd_solver_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_qrd_solver_exec_ci does not lose cycles to determine the hardware configuration.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsQ: Pointer to the structure containing dimensional information of Q matrix
[in]bufParamsR: Pointer to the structure containing dimensional information of R matrix
[in]bufParamsB: Pointer to the structure containing dimensional information of input vector B
[in]bufParamsY: Pointer to the structure containing dimensional information of temporary vector Y
[out]bufParamsX: Pointer to the structure containing dimensional information of ouput vector X
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 604 of file DSPLIB_qrd_solver_ci.cpp.

◆ DSPLIB_qrd_solver_exec_ci()

template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_exec_ci ( DSPLIB_kernelHandle  handle,
void *restrict  pQ,
void *restrict  pR,
void *restrict  pB,
void *restrict  pY,
void *restrict  pX,
void *restrict  pD,
void *restrict  pR1 
)

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

The function implements optimized version for DSPLIB_qrd_solver_exec.

Parameters
[in]handle: Active handle to the kernel.
[in]pQ: Pointer to the input matrix Q.
[in]pR: Pointer to the input matrix R.
[in]pB: Pointer to the input vector B.
[in]pY: Pointer to the temporary vector Y.
[out]pX: Pointer to the output vector X.
[in]pD: Pointer to the Scratch buffer D.
[in]pR1: Pointer to the Scratch buffer for transposed matrix of R.
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 652 of file DSPLIB_qrd_solver_ci.cpp.

◆ DSPLIB_qrd_solver_init_cn()

template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_init_cn ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t bufParamsQ,
DSPLIB_bufParams2D_t bufParamsR,
DSPLIB_bufParams1D_t bufParamsB,
DSPLIB_bufParams1D_t bufParamsY,
DSPLIB_bufParams1D_t bufParamsX,
const DSPLIB_qrdSolverInitArgs pKerInitArgs 
)

This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_qrd_solver_init.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsQ: Pointer to the structure containing dimensional information of Q matrix
[in]bufParamsR: Pointer to the structure containing dimensional information of R matrix
[in]bufParamsB: Pointer to the structure containing dimensional information of input vector B
[in]bufParamsY: Pointer to the structure containing dimensional information of temporary vector Y
[out]bufParamsX: Pointer to the structure containing dimensional information of ouput vector X
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 31 of file DSPLIB_qrd_solver_cn.cpp.

◆ DSPLIB_qrd_solver_exec_cn()

template<typename dataType >
DSPLIB_STATUS DSPLIB_qrd_solver_exec_cn ( DSPLIB_kernelHandle  handle,
void *restrict  pQ,
void *restrict  pR,
void *restrict  pB,
void *restrict  pY,
void *restrict  pX,
void *restrict  pD,
void *restrict  pR1 
)

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

Parameters
[in]handle: Active handle to the kernel.
[in]pQ: Pointer to the input matrix Q.
[in]pR: Pointer to the input matrix R.
[in]pB: Pointer to the input vector B.
[in]pY: Pointer to the temporary vector Y.
[out]pX: Pointer to the output vector X.
[in]pD: Pointer to the Scratch buffer D.
[in]pR1: Pointer to the Scratch buffer for transposed matrix of R.
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 60 of file DSPLIB_qrd_solver_cn.cpp.