Introduction

Kernel for transpose of input matrix.

This function solves the system of linear equations \(A \times x = b\) for \(x\) using the inputs produced via LU decomposition i.e. \(A \times x = P^{T} \times L \times U \times x = b\). The following procedure is performed.

Modify b using permutation matrix: \(b_{mod} = LUx = Pb\)
Use forward substitution to solve for \(y\): \(y = Ux = L^{-1}b_{mod} \)
Use backward substitution for solve for \(x\): \(x = U^{-1}y\)

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

Functions
int32_t	DSPLIB_lud_sol_getHandleSize (DSPLIB_lud_solInitArgs *pKerInitArgs)
	This is a query function to calculate the size of internal handle. More...

DSPLIB_STATUS	DSPLIB_lud_sol_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t bufParamsP, const DSPLIB_bufParams2D_t bufParamsL, const DSPLIB_bufParams2D_t bufParamsU, const DSPLIB_bufParams1D_t bufParamsB, const DSPLIB_bufParams1D_t bufParamsX, const DSPLIB_bufParams2D_t bufParamsVecScratch, const DSPLIB_bufParams2D_t bufParamsScratchTrans, const DSPLIB_lud_solInitArgs pKerInitArgs)
	This function checks the validity of the parameters passed to DSPLIB_lud_sol_init function. This function is called with the same parameters as the DSPLIB_lud_sol_init, and this function must be called before the DSPLIB_lud_sol_init is called. More...

DSPLIB_STATUS	DSPLIB_lud_sol_init (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t bufParamsP, const DSPLIB_bufParams2D_t bufParamsL, const DSPLIB_bufParams2D_t bufParamsU, const DSPLIB_bufParams1D_t bufParamsB, const DSPLIB_bufParams1D_t bufParamsX, const DSPLIB_bufParams2D_t bufParamsVecScratch, const DSPLIB_bufParams2D_t bufParamsScratchTrans, const DSPLIB_lud_solInitArgs pKerInitArgs)
	This function should be called before the DSPLIB_lud_sol_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_sol_exec_checkParams (DSPLIB_kernelHandle handle, void restrict pP, void restrict pL, void restrict pU, void restrict pB, void restrict pX, void restrict pVecScratch, void *restrict pScratchTrans)
	This function checks the validity of the parameters passed to DSPLIB_lud_sol_exec function. This function is called with the same parameters as the DSPLIB_lud_sol_exec, and this function must be called before the DSPLIB_lud_sol_exec is called. More...

DSPLIB_STATUS	DSPLIB_lud_sol_exec (DSPLIB_kernelHandle handle, void restrict pP, void restrict pL, void restrict pU, void restrict pB, void restrict pX, void restrict pVecScratch, void *restrict pScratchTrans)
	This function is the main kernel compute function. More...

Function Documentation

◆ DSPLIB_lud_sol_getHandleSize()

int32_t DSPLIB_lud_sol_getHandleSize ( DSPLIB_lud_solInitArgs * 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_sol.cpp.

◆ DSPLIB_lud_sol_init_checkParams()

DSPLIB_STATUS DSPLIB_lud_sol_init_checkParams	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams1D_t *	bufParamsB,
		const DSPLIB_bufParams1D_t *	bufParamsX,
		const DSPLIB_bufParams2D_t *	bufParamsVecScratch,
		const DSPLIB_bufParams2D_t *	bufParamsScratchTrans,
		const DSPLIB_lud_solInitArgs *	pKerInitArgs
	)

This function checks the validity of the parameters passed to DSPLIB_lud_sol_init function. This function is called with the same parameters as the DSPLIB_lud_sol_init, and this function must be called before the DSPLIB_lud_sol_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
[in]	bufParamsB	: Pointer to the structure containing dimensional information of input buffer B
[out]	bufParamsX	: Pointer to the structure containing dimensional information of ouput buffer X
[in]	bufParamsVecScratch	: Pointer to the structure containing dimensional information of intermediate buffer
[in]	bufParamsScratchTrans	: Pointer to the structure containing dimensional information of scratch buffer pScratchTrans
[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_sol.cpp.

◆ DSPLIB_lud_sol_init()

DSPLIB_STATUS DSPLIB_lud_sol_init	(	DSPLIB_kernelHandle	handle,
		const DSPLIB_bufParams2D_t *	bufParamsP,
		const DSPLIB_bufParams2D_t *	bufParamsL,
		const DSPLIB_bufParams2D_t *	bufParamsU,
		const DSPLIB_bufParams1D_t *	bufParamsB,
		const DSPLIB_bufParams1D_t *	bufParamsX,
		const DSPLIB_bufParams2D_t *	bufParamsVecScratch,
		const DSPLIB_bufParams2D_t *	bufParamsScratchTrans,
		const DSPLIB_lud_solInitArgs *	pKerInitArgs
	)

This function should be called before the DSPLIB_lud_sol_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
[in]	bufParamsB	: Pointer to the structure containing dimensional information of input buffer B
[out]	bufParamsX	: Pointer to the structure containing dimensional information of ouput buffer X
[in]	bufParamsVecScratch	: Pointer to the structure containing dimensional information of intermediate buffer
[in]	bufParamsScratchTrans	: Pointer to the structure containing dimensional information of scratch buffer pScratchTrans
[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 105 of file DSPLIB_lud_sol.cpp.

◆ DSPLIB_lud_sol_exec_checkParams()

DSPLIB_STATUS DSPLIB_lud_sol_exec_checkParams	(	DSPLIB_kernelHandle	handle,
		void *restrict	pP,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pB,
		void *restrict	pX,
		void *restrict	pVecScratch,
		void *restrict	pScratchTrans
	)

This function checks the validity of the parameters passed to DSPLIB_lud_sol_exec function. This function is called with the same parameters as the DSPLIB_lud_sol_exec, and this function must be called before the DSPLIB_lud_sol_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
[in]	pB	: Pointer to vector b
[out]	pX	: Pointer to final solver output vector x
[in]	pVecScratch	: Pointer to intermediate buffer
[in]	pScratchTrans	: Pointer to scratch buffer for transpose

Returns: Status value indicating success or failure. Refer to DSPLIB_STATUS.

Remarks: None

Definition at line 79 of file DSPLIB_lud_sol.cpp.

◆ DSPLIB_lud_sol_exec()

DSPLIB_STATUS DSPLIB_lud_sol_exec	(	DSPLIB_kernelHandle	handle,
		void *restrict	pP,
		void *restrict	pL,
		void *restrict	pU,
		void *restrict	pB,
		void *restrict	pX,
		void *restrict	pVecScratch,
		void *restrict	pScratchTrans
	)

This function is the main kernel compute function.

Please refer to details under DSPLIB_lud_sol_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
[in]	pB	: Pointer to vector b
[out]	pX	: Pointer to final solver output vector x
[in]	pVecScratch	: Pointer to intermediate buffer
[in]	pScratchTrans	: Pointer to scratch buffer for transpose

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
pB	1	M	Input vector
pX	1	M	Output vector
pVecScratch	3	M	Scratch buffer to store intermediate values
pScratchTrans	M	M	Scratch buffer to store transpose of input matrices

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_sol_init and DSPLIB_lud_sol_exec_checkParams functions. This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 163 of file DSPLIB_lud_sol.cpp.

Introduction

Data Structures

Functions

Function Documentation

◆ DSPLIB_lud_sol_getHandleSize()

◆ DSPLIB_lud_sol_init_checkParams()

◆ DSPLIB_lud_sol_init()

◆ DSPLIB_lud_sol_exec_checkParams()

◆ DSPLIB_lud_sol_exec()