ti/dsplib/src/DSP_add32/c64P/DSP_add32.h

   1 /* ======================================================================= */
   2 /* DSP_add32.h -- Optimized C source interface header file                 */
   3 /*                                                                         */
   4 /* Rev 0.0.1                                                               */
   5 /*                                                                         */
   6 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */
   7 /*                                                                         */
   8 /*                                                                         */
   9 /*  Redistribution and use in source and binary forms, with or without     */
  10 /*  modification, are permitted provided that the following conditions     */
  11 /*  are met:                                                               */
  12 /*                                                                         */
  13 /*    Redistributions of source code must retain the above copyright       */
  14 /*    notice, this list of conditions and the following disclaimer.        */
  15 /*                                                                         */
  16 /*    Redistributions in binary form must reproduce the above copyright    */
  17 /*    notice, this list of conditions and the following disclaimer in the  */
  18 /*    documentation and/or other materials provided with the               */
  19 /*    distribution.                                                        */
  20 /*                                                                         */
  21 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
  22 /*    its contributors may be used to endorse or promote products derived  */
  23 /*    from this software without specific prior written permission.        */
  24 /*                                                                         */
  25 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
  26 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
  27 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
  28 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
  29 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
  30 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
  31 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
  32 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
  33 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
  34 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
  35 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
  36 /*                                                                         */
  37 /* ======================================================================= */
  38
  39 #ifndef DSP_ADD32_H_
  40 #define DSP_ADD32_H_ 1
  41
  42 #ifndef __TI_COMPILER_VERSION__           // for non TI compiler
  43 #include "assert.h"                       // intrinsics prototypes
  44 #include "C6xSimulator.h"                 // intrinsics prototypes
  45 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
  46 #endif
  47
  48 /** @ingroup MATH */
  49 /* @{ */
  50
  51 /** @defgroup DSP_add32 */
  52 /** @ingroup DSP_add32 */
  53 /* @{ */
  54
  55 /**
  56  *     This program performs a addition on a vector.
  57  *     The result is stored in a vector.
  58  *
  59  *                      @param x = Input data array of int
  60  *                      @param y = Input data array of int
  61  *                      @param r = Output data array of int
  62  *                      @param nx = Number of elements in the arrays
  63  *
  64  * @par Algorithm:
  65  *  DSP_add32_cn.c is the natural C equivalent of the optimized
  66  *  intrinsic C code without restrictions note that the intrinsic
  67  *  C code is optimized and restrictions may apply.
  68  *
  69  * @par Assumptions:
  70  *     Arrays x, y, r do not overlap. <BR>
  71  *     Arrays x, y, r are aligned on double word boundaries. <BR>
  72  *
  73  * @par Implementation notes:
  74  * @b Endian Support: The code supports both big and little endian modes. <BR>
  75  * @b Interruptibility: The code is interruptible. <BR>
  76  *
  77  */
  78
  79  /* }@ */ /* ingroup */
  80  /* }@ */ /* ingroup */
  81
  82 void DSP_add32 (
  83     const int * restrict x,    /* Input array of length nx  */
  84     const int * restrict y,    /* Input array of length nx  */
  85     int       * restrict r,    /* Output array of length nx */
  86     int                  nx    /* Number of elements.       */
  87 );
  88
  89 #endif /* DSP_ADD32_H_ */
  90
  91 /* ======================================================================== */
  92 /*  End of file:  DSP_add32.h                                               */
  93 /* ------------------------------------------------------------------------ */
  94 /*            Copyright (c) 2011 Texas Instruments, Incorporated.           */
  95 /*                           All Rights Reserved.                           */
  96 /* ======================================================================== */
  97