DSPLIB User Guide
DSPLIB_cholesky_inplace_priv.h
Go to the documentation of this file.
1 /******************************************************************************
2  * *
3  * module name :DSPLIB *
4  * *
5  * module descripton :Digital Signal Processing Library module for C7x+MMA *
6  * *
7  * Copyright (C) 2017-2018 Texas Instruments Incorporated - https://www.ti.com/ *
8  * ALL RIGHTS RESERVED *
9  * *
10  ******************************************************************************/
11 
12 /********************************************************************************
13  * @file DSPLIB_cholesky_inplace_priv.h
14  *
15  * @brief File to hold private parameters of function DSPLIB_cholesky_inplace
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PRIV_H_
23 
24 // #include "../../common/DSPLIB_utility.h"
25 #include "../common/DSPLIB_inlines.h"
26 #include "../common/DSPLIB_utility.h"
27 
28 #include "DSPLIB_cholesky_common.h"
29 #include "DSPLIB_cholesky_inplace.h"
30 
43 #define DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PBLOCK_SIZE (7 * SE_PARAM_SIZE)
44 
50 typedef DSPLIB_STATUS (*pFxnDSPLIB_cholesky_inplace_exec)(DSPLIB_kernelHandle handle,
51  void *restrict pA,
52  void *restrict pMul);
53 
80 template <typename dataType>
81 extern DSPLIB_STATUS DSPLIB_cholesky_inplace_init_ci(DSPLIB_kernelHandle handle,
82  DSPLIB_bufParams2D_t *bufParamsA,
83  DSPLIB_bufParams1D_t *bufParamsMul,
84  const DSPLIB_cholesky_inplace_InitArgs *pKerInitArgs);
85 
107 template <typename dataType>
108 extern DSPLIB_STATUS
109 DSPLIB_cholesky_inplace_exec_ci(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pMul);
110 
125 template <typename dataType>
126 extern DSPLIB_STATUS
127 DSPLIB_cholesky_inplace_exec_cn(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pMul);
128 
132 typedef struct {
136  pFxnDSPLIB_cholesky_inplace_exec execute;
140  int32_t order; // Order of input A
141  int32_t stride; // stride to go from one row to the other
142  int32_t enableTest; // flag to check if input matrix is positive definite
143  int32_t shiftForVecLenDiv;
144  uint8_t bufPblock[DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PBLOCK_SIZE];
145 } DSPLIB_cholesky_inplace_PrivArgs;
146 
147 #endif /* DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PRIV_H_ */
148 
149 /* ======================================================================== */
150 /* End of file: DSPLIB_cholesky_inplace_priv.h */
151 /* ======================================================================== */
DSPLIB_cholesky_common.h
DSPLIB_cholesky_inplace.h
pFxnDSPLIB_cholesky_inplace_exec
DSPLIB_STATUS(* pFxnDSPLIB_cholesky_inplace_exec)(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pMul)
This is a function pointer type that conforms to the declaration of DSPLIB_cholesky_inplace_exec_ci a...
Definition: DSPLIB_cholesky_inplace_priv.h:50
DSPLIB_cholesky_inplace_init_ci
DSPLIB_STATUS DSPLIB_cholesky_inplace_init_ci(DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsA, DSPLIB_bufParams1D_t *bufParamsMul, const DSPLIB_cholesky_inplace_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_cholesky_inplace_ci.cpp:160
DSPLIB_cholesky_inplace_exec_cn
DSPLIB_STATUS DSPLIB_cholesky_inplace_exec_cn(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pMul)
This function is the main execution function for the natural C implementation of the kernel....
Definition: DSPLIB_cholesky_inplace_cn.cpp:107
DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_CHOLESKY_INPLACE_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_cholesky_inplace_PrivArgs structure.
Definition: DSPLIB_cholesky_inplace_priv.h:43
DSPLIB_cholesky_inplace_exec_ci
DSPLIB_STATUS DSPLIB_cholesky_inplace_exec_ci(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pMul)
This function is the main execution function for the C7x implementation of the kernel....
Definition: DSPLIB_cholesky_inplace_ci.cpp:769
DSPLIB_STATUS
DSPLIB_STATUS_NAME DSPLIB_STATUS
Return value for DSPLIB functions.
Definition: DSPLIB_types.h:170
DSPLIB_STATUS_NAME
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
DSPLIB_kernelHandle
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
DSPLIB_bufParams1D_t
A structure for a 1 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:70
DSPLIB_bufParams2D_t
A structure for a 2 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:78
DSPLIB_cholesky_inplace_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_cholesky_inplace.h:113
DSPLIB_cholesky_inplace_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_cholesky_inplace_priv.h:132
DSPLIB_cholesky_inplace_PrivArgs::order
int32_t order
Order of input buffer for different batches DSPLIB_cholesky_inplace_init that will be retrieved and u...
Definition: DSPLIB_cholesky_inplace_priv.h:140
DSPLIB_cholesky_inplace_PrivArgs::execute
pFxnDSPLIB_cholesky_inplace_exec execute
Function pointer to point to the right execution variant between DSPLIB_cholesky_inplace_exec_cn and ...
Definition: DSPLIB_cholesky_inplace_priv.h:136
DSPLIB_cholesky_inplace_PrivArgs::enableTest
int32_t enableTest
Definition: DSPLIB_cholesky_inplace_priv.h:142
DSPLIB_cholesky_inplace_PrivArgs::shiftForVecLenDiv
int32_t shiftForVecLenDiv
Definition: DSPLIB_cholesky_inplace_priv.h:143
DSPLIB_cholesky_inplace_PrivArgs::stride
int32_t stride
Definition: DSPLIB_cholesky_inplace_priv.h:141