DSPLIB_lud_inv

Introduction

Kernel for transpose of input matrix.

• This function processes a permutation matrix \(P\), a lower triangular matrix \(L\), and an upper triangular matrix \(U\) generated using LU decomposition and computes the inverse of the \(A\) matrix where:

  \begin{eqnarray*} A^{-1} = U^{-1} \times L^{-1} \times P \end{eqnarray*}

• The input matrices \(P\), \(L\) and \(U\) are of shape (M, M)
• The ouput matrix \(A^{-1}\) is of shape (M, M)

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

Functions
int32_t	DSPLIB_lud_inv_getHandleSize (DSPLIB_lud_invInitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...
DSPLIB_STATUS	DSPLIB_lud_inv_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsinvA, const DSPLIB_lud_invInitArgs *pKerInitArgs)
	This function checks the validity of the parameters passed to DSPLIB_lud_inv_init function. This function is called with the same parameters as the DSPLIB_lud_inv_init, and this function must be called before the DSPLIB_lud_inv_init is called. More...
DSPLIB_STATUS	DSPLIB_lud_inv_init (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsinvA, const DSPLIB_lud_invInitArgs *pKerInitArgs)
	This function should be called before the DSPLIB_lud_inv_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_lud_inv_exec_checkParams (DSPLIB_kernelHandle handle, void *restrict pP, void *restrict pL, void *restrict pU, void *restrict pinvA, void *restrict pScratch)
	This function checks the validity of the parameters passed to DSPLIB_lud_inv_exec function. This function is called with the same parameters as the DSPLIB_lud_inv_exec, and this function must be called before the DSPLIB_lud_inv_exec is called. More...
DSPLIB_STATUS	DSPLIB_lud_inv_exec (DSPLIB_kernelHandle handle, void *restrict pP, void *restrict pL, void *restrict pU, void *restrict pinvA, void *restrict pScratch)
	This function is the main kernel compute function. More...

Function Documentation

DSPLIB_lud_inv_getHandleSize()

int32_t DSPLIB_lud_inv_getHandleSize

(

DSPLIB_lud_invInitArgs *

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_lud_inv.cpp.

DSPLIB_lud_inv_init_checkParams()

DSPLIB_STATUS DSPLIB_lud_inv_init_checkParams	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams2D_t *	bufParamsinvA,
		const DSPLIB_lud_invInitArgs *	pKerInitArgs
	)

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	bufParamsP	: Pointer to the structure containing dimensional information of input buffer P
[in]	bufParamsL	: Pointer to the structure containing dimensional information of input buffer L
[in]	bufParamsU	: Pointer to the structure containing dimensional information of input buffer U
[out]	bufParamsinvA	: Pointer to the structure containing dimensional information of ouput buffer invA
[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_lud_inv.cpp.

DSPLIB_lud_inv_init()

DSPLIB_STATUS DSPLIB_lud_inv_init	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams2D_t *	bufParamsinvA,
		const DSPLIB_lud_invInitArgs *	pKerInitArgs
	)

This function should be called before the DSPLIB_lud_inv_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]	bufParamsP	: Pointer to the structure containing dimensional information of input buffer P
[in]	bufParamsL	: Pointer to the structure containing dimensional information of input buffer L
[in]	bufParamsU	: Pointer to the structure containing dimensional information of input buffer U
[out]	bufParamsinvA	: Pointer to the structure containing dimensional information of ouput buffer invA
[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 103 of file DSPLIB_lud_inv.cpp.

DSPLIB_lud_inv_exec_checkParams()

DSPLIB_STATUS DSPLIB_lud_inv_exec_checkParams	(	DSPLIB_kernelHandle	handle,
		void *restrict	pP,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pinvA,
		void *restrict	pScratch
	)

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

Parameters

[in]	handle	: Active handle to the kernel
[in]	pP	: Pointer to permutation matrix P
[in]	pL	: Pointer to lower triangular matrix L
[in]	pU	: Pointer to upper triangular matrix U
[out]	pinvA	: Pointer to inverse of A matrix
[out]	pScratch	: Pointer to scratch buffer Scratch

Returns

Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks

None

Definition at line 80 of file DSPLIB_lud_inv.cpp.

DSPLIB_lud_inv_exec()

DSPLIB_STATUS DSPLIB_lud_inv_exec	(	DSPLIB_kernelHandle	handle,
		void *restrict	pP,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pinvA,
		void *restrict	pScratch
	)

This function is the main kernel compute function.

Please refer to details under DSPLIB_lud_inv_exec

Parameters

[in]	handle	: Active handle to the kernel
[in]	pP	: Pointer to permutation matrix P
[in]	pL	: Pointer to lower triangular matrix L
[in]	pU	: Pointer to upper triangular matrix U
[out]	pinvA	: Pointer to inverse of A matrix
[out]	pScratch	: Pointer to scratch buffer Scratch

Memory Requirements

Buffer	dimY	dimX	Comments
pP	M	M	Input Permutation Matrix (Data Type = uint16_t)
pL	M	M	Input Lower Triangular Matrix
pU	M	M	Input Upper Triangular Matrix
pinvA	M	M	Output Square Matrix
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_lud_inv_init and DSPLIB_lud_inv_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 155 of file DSPLIB_lud_inv.cpp.