DSPLIB User Guide
DSPLIB_cholesky_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_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_cholesky
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_CHOLESKY_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_CHOLESKY_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_inlines.h"
25 #include "../common/DSPLIB_utility.h"
26 #include "DSPLIB_cholesky.h"
27 #include "DSPLIB_cholesky_common.h"
28 
40 #define DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE (7 * SE_PARAM_SIZE)
41 
48  void *restrict pInA,
49  void *restrict pOutU,
50  void *restrict multiplierPtr);
51 
76 template <typename dataType>
78  const DSPLIB_bufParams2D_t *bufParamsIn,
79  const DSPLIB_bufParams2D_t *bufParamsOut,
80  const DSPLIB_cholesky_InitArgs *pKerInitArgs);
81 
104 template <typename dataType>
106  void *restrict pInA,
107  void *restrict pOutU,
108  void *restrict multiplierPtr);
109 
124 template <typename dataType>
126  void *restrict pInA,
127  void *restrict pOutU,
128  void *restrict multiplierPtr);
129 
133 typedef struct {
141  int32_t order; // Order of input A
142  int32_t stride; // stride to go from one row to the other
143  int32_t strideCn; // stride to go from one row to the other in cn
144  int32_t enableTest; // Enable the positive definite check
146  uint8_t bufPblock[DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE]; // se init param
148 
149 #endif /* DSPLIB_cholesky_IXX_IXX_OXX_PRIV_H_ */
150 
151 /* ======================================================================== */
152 /* End of file: DSPLIB_cholesky_priv.h */
153 /* ======================================================================== */
DSPLIB_STATUS DSPLIB_cholesky_exec_ci(DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
This function is the main execution function for the C7x implementation of the kernel....
DSPLIB_STATUS(* pFxnDSPLIB_cholesky_exec)(DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
This is a function pointer type that conforms to the declaration of DSPLIB_cholesky_exec_ci and DSPLI...
#define DSPLIB_cholesky_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_cholesky_PrivArgs structure.
DSPLIB_STATUS DSPLIB_cholesky_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsIn, const DSPLIB_bufParams2D_t *bufParamsOut, const DSPLIB_cholesky_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
DSPLIB_STATUS DSPLIB_cholesky_exec_cn(DSPLIB_kernelHandle handle, void *restrict pInA, void *restrict pOutU, void *restrict multiplierPtr)
This function is the main execution function for the natural C implementation of the kernel....
DSPLIB_STATUS_NAME DSPLIB_STATUS
Return value for DSPLIB functions.
Definition: DSPLIB_types.h:170
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
A structure for a 2 dimensional buffer descriptor.
Structure containing the parameters to initialize the kernel.
Structure that is reserved for internal use by the kernel.
int32_t order
Order of input buffer for different batches DSPLIB_cholesky_init that will be retrieved and used by D...
pFxnDSPLIB_cholesky_exec execute
Function pointer to point to the right execution variant between DSPLIB_cholesky_exec_cn and DSPLIB_c...