DSPLIB_svd_small_priv.h

Go to the documentation of this file.

/******************************************************************************
 *                                                                             *
 * module name       :DSPLIB                                                   *
 *                                                                             *
 * module descripton :Digital Signal Processing Library module for C7x+MMA   *
 *                                                                             *
 * Copyright (C) 2017-2018 Texas Instruments Incorporated - https://www.ti.com/ *
 * ALL RIGHTS RESERVED                                                         *
 *                                                                             *
 ******************************************************************************/
 
/********************************************************************************
 *  @file     DSPLIB_svd_small_priv.h
 *
 *  @brief    File to hold private parameter of function DSPLIB_svd
 *
 *  @version  0.1 - Jun 2023 : Initial Version
 *
 ********************************************************************************/
 
#ifndef DSPLIB_SVD_SMALL_IXX_IXX_OXX_PRIV_H_
#define DSPLIB_SVD_SMALL_IXX_IXX_OXX_PRIV_H_
 
// #include "../DSPLIB_matTrans/DSPLIB_matTrans_priv.h"
#include "../common/DSPLIB_inlines.h"
#include "../common/DSPLIB_utility.h"
#include "DSPLIB_svd_small.h"
 
#define DSPLIB_SVD_SMALL_IXX_IXX_OXX_PBLOCK_SIZE (0 * SE_PARAM_SIZE)
 
typedef DSPLIB_STATUS (*pFxnDSPLIB_svd_small_exec)(DSPLIB_kernelHandle handle,
                                                   void *restrict pA,
                                                   void *restrict pU,
                                                   void *restrict pV,
                                                   void *restrict pDiag,
                                                   void *restrict pSuperDiag,
                                                   void *restrict pU1);
 
template <typename dataType>
extern DSPLIB_STATUS DSPLIB_svd_small_init_ci(DSPLIB_kernelHandle         handle,
                                              const DSPLIB_bufParams2D_t *bufParamsIn,
                                              const DSPLIB_bufParams2D_t *bufParamsU,
                                              const DSPLIB_bufParams2D_t *bufParamsV,
                                              const DSPLIB_bufParams1D_t *bufParamsDiag,
                                              const DSPLIB_bufParams1D_t *bufParamsSuperDiag,
                                              const DSPLIB_svd_small_InitArgs   *pKerInitArgs);
 
template <typename dataType>
extern DSPLIB_STATUS DSPLIB_svd_small_exec_ci(DSPLIB_kernelHandle handle,
                                              void *restrict pA,
                                              void *restrict pU,
                                              void *restrict pV,
                                              void *restrict pDiag,
                                              void *restrict pSuperDiag,
                                              void *restrict pU1);
 
DSPLIB_STATUS DSPLIB_svd_small_init_cn(DSPLIB_kernelHandle         handle,
                                       const DSPLIB_bufParams2D_t *bufParamsIn,
                                       const DSPLIB_bufParams2D_t *bufParamsU,
                                       const DSPLIB_bufParams2D_t *bufParamsV,
                                       const DSPLIB_bufParams1D_t *bufParamsDiag,
                                       const DSPLIB_bufParams1D_t *bufParamsSuperDiag,
                                       const DSPLIB_svd_small_InitArgs   *pKerInitArgs);
 
template <typename dataType>
extern DSPLIB_STATUS DSPLIB_svd_small_exec_cn(DSPLIB_kernelHandle handle,
                                              void *restrict pA,
                                              void *restrict pU,
                                              void *restrict pV,
                                              void *restrict pDiag,
                                              void *restrict pSuperDiag,
                                              void *restrict pU1);
 
typedef struct {
   pFxnDSPLIB_svd_small_exec execute;
   uint32_t widthIn;
   uint32_t heightIn;
   int32_t strideIn;
   uint32_t strideU;
   uint32_t strideV;
   uint32_t strideURows;
   uint32_t strideVRows;
   uint32_t enableReducedForm;
   uint32_t data_type;
   uint8_t bufPblock[DSPLIB_SVD_SMALL_IXX_IXX_OXX_PBLOCK_SIZE];
} DSPLIB_svd_small_PrivArgs;
 
/* *****************************************************************************
 *
 * COMMON UTILITY FUNCTIONS
 *
 ***************************************************************************** */
 
/* Common function to calculate reciprocal value */
template <typename dataType> inline dataType getRecip(dataType value)
{
   dataType TwoP0 = 2.0;
 
   dataType yy1 = __recip(value);
 
   yy1 = yy1 * (TwoP0 - value * yy1);
   yy1 = yy1 * (TwoP0 - value * yy1);
#if defined(ENABLE_LDRA_COVERAGE) 
/* Higher precision calculations to enter the rotation_check path. We only use this 
   as a coverage component. We do not include these operations for normal execution
   considering the PERFORMANCE */
   yy1 = yy1 * (TwoP0 - value * yy1);
   yy1 = yy1 * (TwoP0 - value * yy1);
#endif
 
   return yy1;
}
template float  getRecip(float value);
template double getRecip(double value);
 
template <typename dataType> inline dataType getSqrt(dataType a)
{
   const dataType Half  = 0.5f;
   const dataType OneP5 = 1.5f;
   dataType       x, y;
   //  int         i;
 
   x = __recip_sqrt(a); /* compute square root reciprocal */
 
   // #pragma UNROLL(1) /* PRAGMA: do not unroll this loop */
   //    for (i = 0; i < 2; i++)
   {
      x = x * (OneP5 - (a * x * x * Half));
      x = x * (OneP5 - (a * x * x * Half));
      // x = x * (OneP5 - (a * x * x * Half));
      // x = x * (OneP5 - (a * x * x * Half));
   }
   y = a * x;
 
   return (y);
}
template float           getSqrt<float>(float a);
template double          getSqrt<double>(double a);
template c7x::double_vec getSqrt<c7x::double_vec>(c7x::double_vec a);
 
template <typename dataType> inline dataType getRecipSqrt(dataType a)
{
   const dataType Half  = 0.5f;
   const dataType OneP5 = 1.5f;
   dataType       x;
   // int i;
 
   x = __recip_sqrt(a); // compute square root reciprocal
 
   // PRAGMA: do not unroll this loop
   // #pragma UNROLL(1)
   // for (i = 0; i < 2; i++)
   {
      x = x * (OneP5 - (a * x * x * Half));
      x = x * (OneP5 - (a * x * x * Half));
   }
 
   return x;
}
template float  getRecipSqrt<float>(float a);
template double getRecipSqrt<double>(double a);
 
#endif /* DSPLIB_SVD_SMALL_IXX_IXX_OXX_PRIV_H_ */
 
/* ======================================================================== */
/*  End of file:  DSPLIB_svd_small_priv.h          */
/* ======================================================================== */