DSPLIB User Guide
DSPLIB_svd.h
Go to the documentation of this file.
1 /*******************************************************************************
2 **+--------------------------------------------------------------------------+**
3 **| **** |**
4 **| **** |**
5 **| ******o*** |**
6 **| ********_///_**** |**
7 **| ***** /_//_/ **** |**
8 **| ** ** (__/ **** |**
9 **| ********* |**
10 **| **** |**
11 **| *** |**
12 **| |**
13 **| Copyright (c) 2016 Texas Instruments Incorporated |**
14 **| |**
15 **| All rights reserved not granted herein. |**
16 **| |**
17 **| Limited License. |**
18 **| |**
19 **| Texas Instruments Incorporated grants a world-wide, royalty-free, |**
20 **| non-exclusive license under copyrights and patents it now or |**
21 **| hereafter owns or controls to make, have made, use, import, offer to |**
22 **| sell and sell ("Utilize") this software subject to the terms herein. |**
23 **| With respect to the foregoing patent license, such license is granted |**
24 **| solely to the extent that any such patent is necessary to Utilize the |**
25 **| software alone. The patent license shall not apply to any |**
26 **| combinations which include this software, other than combinations |**
27 **| with devices manufactured by or for TI ("TI Devices"). No hardware |**
28 **| patent is licensed hereunder. |**
29 **| |**
30 **| Redistributions must preserve existing copyright notices and |**
31 **| reproduce this license (including the above copyright notice and the |**
32 **| disclaimer and (if applicable) source code license limitations below) |**
33 **| in the documentation and/or other materials provided with the |**
34 **| distribution |**
35 **| |**
36 **| Redistribution and use in binary form, without modification, are |**
37 **| permitted provided that the following conditions are met: |**
38 **| |**
39 **| * No reverse engineering, decompilation, or disassembly of this |**
40 **| software is permitted with respect to any software provided in binary |**
41 **| form. |**
42 **| |**
43 **| * any redistribution and use are licensed by TI for use only with |**
44 **| TI Devices. |**
45 **| |**
46 **| * Nothing shall obligate TI to provide you with source code for |**
47 **| the software licensed and provided to you in object code. |**
48 **| |**
49 **| If software source code is provided to you, modification and |**
50 **| redistribution of the source code are permitted provided that the |**
51 **| following conditions are met: |**
52 **| |**
53 **| * any redistribution and use of the source code, including any |**
54 **| resulting derivative works, are licensed by TI for use only with TI |**
55 **| Devices. |**
56 **| |**
57 **| * any redistribution and use of any object code compiled from the |**
58 **| source code and any resulting derivative works, are licensed by TI |**
59 **| for use only with TI Devices. |**
60 **| |**
61 **| Neither the name of Texas Instruments Incorporated nor the names of |**
62 **| its suppliers may be used to endorse or promote products derived from |**
63 **| this software without specific prior written permission. |**
64 **| |**
65 **| DISCLAIMER. |**
66 **| |**
67 **| THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY |**
68 **| EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |**
69 **| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |**
70 **| PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE |**
71 **| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |**
72 **| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |**
73 **| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |**
74 **| BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |**
75 **| WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |**
76 **| OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |**
77 **| EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |**
78 **+--------------------------------------------------------------------------+**
79 *******************************************************************************/
80 
81 #ifndef DSPLIB_SVD_IXX_IXX_OXX_H_
82 #define DSPLIB_SVD_IXX_IXX_OXX_H_
83 
84 #include "../common/DSPLIB_types.h"
85 
86 #define DSPLIB_CYCLE_CALC 0
87 
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91 
129 typedef struct {
131  int8_t funcStyle;
133  uint32_t dimX;
135  uint32_t dimY;
137  uint32_t enableReducedForm;
139  uint32_t strideURows;
141  uint32_t strideVRows;
142 } DSPLIB_svdInitArgs;
143 
152 int32_t DSPLIB_svd_getHandleSize(DSPLIB_svdInitArgs *pKerInitArgs);
153 
179 DSPLIB_STATUS DSPLIB_svd_init_checkParams(DSPLIB_kernelHandle handle,
180  const DSPLIB_bufParams2D_t *bufParamsA,
181  const DSPLIB_bufParams2D_t *bufParamsU,
182  const DSPLIB_bufParams2D_t *bufParamsV,
183  const DSPLIB_bufParams1D_t *bufParamsDiag,
184  const DSPLIB_bufParams1D_t *bufParamsSuperDiag,
185  const DSPLIB_svdInitArgs *pKerInitArgs);
186 
212 DSPLIB_STATUS DSPLIB_svd_init(DSPLIB_kernelHandle handle,
213  const DSPLIB_bufParams2D_t *bufParamsA,
214  const DSPLIB_bufParams2D_t *bufParamsU,
215  const DSPLIB_bufParams2D_t *bufParamsV,
216  const DSPLIB_bufParams1D_t *bufParamsDiag,
217  const DSPLIB_bufParams1D_t *bufParamsSuperDiag,
218  const DSPLIB_svdInitArgs *pKerInitArgs);
219 
242 DSPLIB_STATUS DSPLIB_svd_exec_checkParams(DSPLIB_kernelHandle handle,
243  const void *restrict pA,
244  const void *restrict pU,
245  const void *restrict pV,
246  const void *restrict pDiag,
247  const void *restrict pSuperDiag,
248  const void *restrict pU1,
249  const void *restrict pV1,
250  const void *restrict pScratch);
251 
297 DSPLIB_STATUS DSPLIB_svd_exec(DSPLIB_kernelHandle handle,
298  void *restrict pA,
299  void *restrict pU,
300  void *restrict pV,
301  void *restrict pDiag,
302  void *restrict pSuperDiag,
303  void *restrict pU1,
304  void *restrict pV1,
305  void *restrict pScratch);
308 #ifdef __cplusplus
309 }
310 #endif
311 
312 #endif /* DSPLIB_SVD_IXX_IXX_OXX_H_ */
313 
314 /* ======================================================================== */
315 /* End of file: DSPLIB_svd.h */
316 /* ======================================================================== */
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_svd_exec
DSPLIB_STATUS DSPLIB_svd_exec(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pU, void *restrict pV, void *restrict pDiag, void *restrict pSuperDiag, void *restrict pU1, void *restrict pV1, void *restrict pScratch)
This function is the main kernel compute function.
Definition: DSPLIB_svd.cpp:164
DSPLIB_svd_exec_checkParams
DSPLIB_STATUS DSPLIB_svd_exec_checkParams(DSPLIB_kernelHandle handle, const void *restrict pA, const void *restrict pU, const void *restrict pV, const void *restrict pDiag, const void *restrict pSuperDiag, const void *restrict pU1, const void *restrict pV1, const void *restrict pScratch)
This function checks the validity of the parameters passed to DSPLIB_svd_exec function....
Definition: DSPLIB_svd.cpp:78
DSPLIB_svd_init_checkParams
DSPLIB_STATUS DSPLIB_svd_init_checkParams(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsV, const DSPLIB_bufParams1D_t *bufParamsDiag, const DSPLIB_bufParams1D_t *bufParamsSuperDiag, const DSPLIB_svdInitArgs *pKerInitArgs)
This function checks the validity of the parameters passed to DSPLIB_svd_init function....
Definition: DSPLIB_svd.cpp:34
DSPLIB_svd_getHandleSize
int32_t DSPLIB_svd_getHandleSize(DSPLIB_svdInitArgs *pKerInitArgs)
This is a query function to calculate the size of internal handle.
Definition: DSPLIB_svd.cpp:25
DSPLIB_svd_init
DSPLIB_STATUS DSPLIB_svd_init(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsV, const DSPLIB_bufParams1D_t *bufParamsDiag, const DSPLIB_bufParams1D_t *bufParamsSuperDiag, const DSPLIB_svdInitArgs *pKerInitArgs)
This function should be called before the DSPLIB_svd_exec function is called. This function takes car...
Definition: DSPLIB_svd.cpp:104
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_svdInitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_svd.h:129
DSPLIB_svdInitArgs::enableReducedForm
uint32_t enableReducedForm
Flag to activate reduced form calculation | 1 => REDUCED FORM | 0 => NON-REDUCED FORM.
Definition: DSPLIB_svd.h:137
DSPLIB_svdInitArgs::dimY
uint32_t dimY
Size of input data dimY => Number of rows.
Definition: DSPLIB_svd.h:135
DSPLIB_svdInitArgs::strideVRows
uint32_t strideVRows
Stride value for V matrix in the transposed form.
Definition: DSPLIB_svd.h:141
DSPLIB_svdInitArgs::strideURows
uint32_t strideURows
Stride value for U matrix in the transposed form.
Definition: DSPLIB_svd.h:139
DSPLIB_svdInitArgs::funcStyle
int8_t funcStyle
Variant of the function refer to DSPLIB_FUNCTION_STYLE
Definition: DSPLIB_svd.h:131
DSPLIB_svdInitArgs::dimX
uint32_t dimX
Size of input data dimX => Number of columns.
Definition: DSPLIB_svd.h:133