DSPLIB User Guide
Data Structures | Functions
DSPLIB_qrd_inverse

Introduction

Kernel for find the inverse of a matrix from Q and R matrices.

Data Structures

struct  DSPLIB_qrdInvInitArgs
 Structure containing the parameters to initialize the kernel. More...
 

Functions

int32_t DSPLIB_qrd_inverse_getHandleSize (DSPLIB_qrdInvInitArgs *pKerInitArgs)
 This is a query function to calculate the size of internal handle. More...
 
DSPLIB_STATUS DSPLIB_qrd_inverse_init (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsQ, DSPLIB_bufParams2D_t *bufParamsR, DSPLIB_bufParams2D_t *bufParamsInvA, DSPLIB_bufParams2D_t *bufParamsInvAFinal, const DSPLIB_qrdInvInitArgs *pKerInitArgs)
 This function should be called before the DSPLIB_qrd_inverse_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 streaming engine and streaming address generator. The results of these operations are stored in the handle. More...
 
DSPLIB_STATUS DSPLIB_qrd_inverse_init_checkParams (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsQ, DSPLIB_bufParams2D_t *bufParamsR, DSPLIB_bufParams2D_t *bufParamsInvA, DSPLIB_bufParams2D_t *bufParamsInvAFinal, const DSPLIB_qrdInvInitArgs *pKerInitArgs)
 This function checks the validity of the parameters passed to DSPLIB_qrd_inverse_init function. This function is called with the same parameters as the DSPLIB_qrd_inverse_init, and this function must be called before the DSPLIB_qrd_inverse_init is called. More...
 
DSPLIB_STATUS DSPLIB_qrd_inverse_exec_checkParams (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pInvA, void *restrict pInvAScratch, void *restrict pScratch)
 This function checks the validity of the parameters passed to DSPLIB_qrd_inverse_exec function. This function is called with the same parameters as the DSPLIB_qrd_inverse_exec, and this function must be called before the DSPLIB_qrd_inverse_exec is called. More...
 
DSPLIB_STATUS DSPLIB_qrd_inverse_exec (DSPLIB_kernelHandle handle, void *restrict pQ, void *restrict pR, void *restrict pInvA, void *restrict pInvAScratch, void *restrict pScratch)
 This function is the main kernel compute function. More...
 

Function Documentation

◆ DSPLIB_qrd_inverse_getHandleSize()

int32_t DSPLIB_qrd_inverse_getHandleSize ( DSPLIB_qrdInvInitArgs *  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.

Definition at line 25 of file DSPLIB_qrd_inverse.cpp.

◆ DSPLIB_qrd_inverse_init()

DSPLIB_STATUS DSPLIB_qrd_inverse_init ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t *  bufParamsQ,
DSPLIB_bufParams2D_t *  bufParamsR,
DSPLIB_bufParams2D_t *  bufParamsInvA,
DSPLIB_bufParams2D_t *  bufParamsInvAFinal,
const DSPLIB_qrdInvInitArgs *  pKerInitArgs 
)

This function should be called before the DSPLIB_qrd_inverse_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 streaming engine and streaming address generator. The results of these operations are stored in the handle.

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
[out]bufParamsInvA: Pointer to the structure containing dimensional information of A inverse buffer matrix
[out]bufParamsInvAFinal: Pointer to the structure containing dimensional information of final A inverse matrix allocated from MSMC memory for C7100 and C7120
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
Application is expected to provide a valid handle.

Definition at line 100 of file DSPLIB_qrd_inverse.cpp.

◆ DSPLIB_qrd_inverse_init_checkParams()

DSPLIB_STATUS DSPLIB_qrd_inverse_init_checkParams ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t *  bufParamsQ,
DSPLIB_bufParams2D_t *  bufParamsR,
DSPLIB_bufParams2D_t *  bufParamsInvA,
DSPLIB_bufParams2D_t *  bufParamsInvAFinal,
const DSPLIB_qrdInvInitArgs *  pKerInitArgs 
)

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

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
[out]bufParamsInvA: Pointer to the structure containing dimensional information of A inverse buffer matrix
[out]bufParamsInvAFinal: Pointer to the structure containing dimensional information of final A inverse matrix allocated from MSMC memory for C7100 and C7120
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
None

Definition at line 34 of file DSPLIB_qrd_inverse.cpp.

◆ DSPLIB_qrd_inverse_exec_checkParams()

DSPLIB_STATUS DSPLIB_qrd_inverse_exec_checkParams ( DSPLIB_kernelHandle  handle,
void *restrict  pQ,
void *restrict  pR,
void *restrict  pInvA,
void *restrict  pInvAScratch,
void *restrict  pScratch 
)

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

Parameters
[in]handle: Active handle to the kernel
[in]pQ: Pointer to matrix Q[NRows*NRows]
[in]pR: Pointer to upper triangular matrix R[NRows*NCols]
[in]pInvA: Pointer to A inverse buffer matrix
[out]pInvAScratch: Pointer to Scratch buffer
[in]pScratch: Pointer to Scratch buffer
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
None

Definition at line 78 of file DSPLIB_qrd_inverse.cpp.

◆ DSPLIB_qrd_inverse_exec()

DSPLIB_STATUS DSPLIB_qrd_inverse_exec ( DSPLIB_kernelHandle  handle,
void *restrict  pQ,
void *restrict  pR,
void *restrict  pInvA,
void *restrict  pInvAScratch,
void *restrict  pScratch 
)

This function is the main kernel compute function.

Please refer to details under DSPLIB_qrd_inverse_exec

Parameters
[in]handle: Active handle to the kernel
[in]pQ: Pointer to matrix Q
[in]pR: Pointer to upper triangular matrix R
[in]pInvA: Pointer to A inverse buffer matrix
[out]pInvAScratch: Pointer to Scratch buffer
[in]pScratch: Pointer to Scratch buffer
Memory Requirements
Buffer dimY dimX Comments
pQ M M Input Square Matrix
pR M M Input Square Matrix
pInvA M M Output Square Matrix
pInvAScratch M M Scratch buffer to store intermediate matrix operations
pScratch 1 M Scratch buffer to store inverse factor
Returns
Status value indicating success or failure. Refer to DSPLIB_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
  • Ensure that the starting point of adjacent rows in a 2-D matrix are allocated from different banks in L2 memory with the help of memory padding.
Remarks
Before calling this function, application is expected to call DSPLIB_qrd_inverse_init and DSPLIB_qrd_inverse_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 157 of file DSPLIB_qrd_inverse.cpp.