ti/dsplib/src/DSPF_dp_mat_mul_gemm/c66/DSPF_dp_mat_mul_gemm.h

   1 /* ======================================================================= */
   2 /* DSPF_sp_mat_mul.h -- Matrix Multiply "y = a*x1*x2+y"                    */
   3 /*              Optimized C Implementation (w/ Intrinsics)                 */
   4 /*                                                                         */
   5 /* Rev 0.0.1                                                               */
   6 /*                                                                         */
   7 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */
   8 /*                                                                         */
   9 /*                                                                         */
  10 /*  Redistribution and use in source and binary forms, with or without     */
  11 /*  modification, are permitted provided that the following conditions     */
  12 /*  are met:                                                               */
  13 /*                                                                         */
  14 /*    Redistributions of source code must retain the above copyright       */
  15 /*    notice, this list of conditions and the following disclaimer.        */
  16 /*                                                                         */
  17 /*    Redistributions in binary form must reproduce the above copyright    */
  18 /*    notice, this list of conditions and the following disclaimer in the  */
  19 /*    documentation and/or other materials provided with the               */
  20 /*    distribution.                                                        */
  21 /*                                                                         */
  22 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
  23 /*    its contributors may be used to endorse or promote products derived  */
  24 /*    from this software without specific prior written permission.        */
  25 /*                                                                         */
  26 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
  27 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
  28 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
  29 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
  30 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
  31 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
  32 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
  33 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
  34 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
  35 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
  36 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
  37 /*                                                                         */
  38 /* ======================================================================= */
  39
  40 #ifndef DSPF_DP_MAT_MUL_GEMM_H_
  41 #define DSPF_DP_MAT_MUL_GEMM_H_
  42
  43 #ifndef __TI_COMPILER_VERSION__           // for non TI compiler
  44 #include "assert.h"                       // intrinsics prototypes
  45 #include "C6xSimulator.h"                 // intrinsics prototypes
  46 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
  47 #endif
  48
  49 /** @ingroup MATRIX */
  50 /* @{ */
  51
  52 /** @defgroup  DSPF_dp_mat_mul_gemm */
  53 /** @ingroup DSPF_dp_mat_mul_gemm */
  54 /* @{ */
  55
  56 /**
  57  *      This function computes the expression y = a*x1*x2+y. The column
  58  *      dimension of x1 must match the row dimension of x2.
  59  *      The values stored in the matrices are assumed to be double-precision
  60  *      floating-point values. This code is suitable for
  61  *      dense matrices. No optimizations are made for sparse matrices.
  62  *
  63  *     @param  x1  = Pointer to r1 by c1 input matrix.
  64  *     @param  a   = Scalar value.
  65  *     @param  r1  = Number of rows in x1.
  66  *     @param  c1  = Number of columns in x1. Also number of rows in x2.
  67  *     @param  x2  = Pointer to c1 by c2 input matrix.
  68  *     @param  c2  = Number of columns in x2.
  69  *     @param  y   = Pointer to r1 by c2 output matrix.
  70  *
  71  * @par Algorithm:
  72  * DSPF_dp_mat_mul_gemm.c is the natural C equivalent of the optimized intrinsic
  73  * C code withoutrestrictions. Note that the intrinsic C code is optimized
  74  * and restrictions may apply.
  75  *
  76  * @par Assumptions:
  77  *  The arrays x1, x2 and y are stored in distinct arrays. In-place processing is not allowed. <BR>
  78  *  r1, c1 and c2 are assumed to be even. <BR>
  79  *
  80  * @par Implementation Notes:
  81  * @b Interruptibility : The code is interruptible.  <BR>
  82  * @b Endian support   : supports both Little and Big endian modes.  <BR>
  83  *
  84  */
  85
  86 void DSPF_dp_mat_mul_gemm(double *x1, double const a, const int r1, const int c1,
  87     double *x2, const int c2, double *restrict y);
  88
  89 #endif /* DSPF_DP_MAT_MUL_GEMM_H_ */
  90
  91 /* ======================================================================= */
  92 /*  End of file:  DSPF_dp_mat_mul_gemm.h                                   */
  93 /* ----------------------------------------------------------------------- */
  94 /*            Copyright (c) 2011 Texas Instruments, Incorporated.          */
  95 /*                           All Rights Reserved.                          */
  96 /* ======================================================================= */
  97