andrewm@379: /*
andrewm@379:  *  Copyright 2011-15 ARM Limited and Contributors.
andrewm@379:  *  All rights reserved.
andrewm@379:  *
andrewm@379:  *  Redistribution and use in source and binary forms, with or without
andrewm@379:  *  modification, are permitted provided that the following conditions are met:
andrewm@379:  *    * Redistributions of source code must retain the above copyright
andrewm@379:  *      notice, this list of conditions and the following disclaimer.
andrewm@379:  *    * Redistributions in binary form must reproduce the above copyright
andrewm@379:  *      notice, this list of conditions and the following disclaimer in the
andrewm@379:  *      documentation and/or other materials provided with the distribution.
andrewm@379:  *    * Neither the name of ARM Limited nor the
andrewm@379:  *      names of its contributors may be used to endorse or promote products
andrewm@379:  *      derived from this software without specific prior written permission.
andrewm@379:  *
andrewm@379:  *  THIS SOFTWARE IS PROVIDED BY ARM LIMITED AND CONTRIBUTORS "AS IS" AND
andrewm@379:  *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
andrewm@379:  *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
andrewm@379:  *  DISCLAIMED. IN NO EVENT SHALL ARM LIMITED AND CONTRIBUTORS BE LIABLE FOR ANY
andrewm@379:  *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
andrewm@379:  *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
andrewm@379:  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
andrewm@379:  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
andrewm@379:  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
andrewm@379:  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
andrewm@379:  */
andrewm@379: 
andrewm@379: /*
andrewm@379:  * NE10 Library : inc/NE10.h
andrewm@379:  */
andrewm@379: 
andrewm@379: /**
andrewm@379:    \mainpage Welcome to Ne10 Documentation!
andrewm@379:    *
andrewm@379:    *
andrewm@379:    *\par Introduction
andrewm@379:    *
andrewm@379:    * Ne10 (http://projectne10.github.com/Ne10/) is a library of the most commonly used functions that have been heavily
andrewm@379:    * optimized for ARM-based CPUs with NEON. These functions provide a consistent
andrewm@379:    * well tested behavior that can be easily incorporated into applications enabling
andrewm@379:    * developers to get the most out of the ARM V7/NEON without arduous assembly coding.
andrewm@379:    * Ne10 is usable as a 'drop and go' pre-built library or as a set of modular functions
andrewm@379:    * that can be incorporated in a more modular "pick and mix" form where binary size might
andrewm@379:    * be an issue.
andrewm@379:    *
andrewm@379:    * The following figure illustrates the basic concepts of "What's Ne10"
andrewm@379:    *\image html ne10_library.png "Ne10 Library Description"
andrewm@379:    *
andrewm@379:    *\par Top-Level Overview
andrewm@379:    * When you checkout Ne10, you will notice a number of directories. These directories are as follows:
andrewm@379:    * <pre>
andrewm@379:    * ├── android
andrewm@379:    * │   └── Android reference files
andrewm@379:    * ├── build
andrewm@379:    * │   └── directory for build-related files
andrewm@379:    * ├── common
andrewm@379:    * │   └── directory for common header, table and macro definition files
andrewm@379:    * ├── doc
andrewm@379:    * │   └── directory for documentations
andrewm@379:    * ├── inc
andrewm@379:    * │   └── directory for functions'heaeder files
andrewm@379:    * ├── modules
andrewm@379:    * │   ├── dsp
andrewm@379:    * │   │   ├── @link groupDSPs dsp module@endlink that provides a set of signal processing functions, such as complex/real FFT/IFFT, FIR and IIR
andrewm@379:    * │   │   └── test
andrewm@379:    * │   │       └──  directory for test files
andrewm@379:    * │   ├── imgproc
andrewm@379:    * │   │   ├── @link groupIMGPROCs imgproc module@endlink that provides a set of image processing functions, such as image resize, image rotate
andrewm@379:    * │   │   └── test
andrewm@379:    * │   │       └──  directory for test files
andrewm@379:    * │   ├── math
andrewm@379:    * │   │   ├── @link groupMaths math module@endlink that provides a set of vector/matrix algebra functions
andrewm@379:    * │   │   └── test
andrewm@379:    * │   │       └──  directory for test files
andrewm@379:    * │   ├── physics
andrewm@379:    * │   │   ├── @link groupPhysics physics module@endlink that provides a set of collision detection functions
andrewm@379:    * │   │   └── test
andrewm@379:    * │   │       └──  directory for test files
andrewm@379:    * ├── samples
andrewm@379:    * │   └── @link groupSamples sample code@endlink
andrewm@379:    * ├── test
andrewm@379:    * │   ├── directory for test framework
andrewm@379:    * ├── tools
andrewm@379:    * │   ├── directory for tools such as Cformatter, doxygen, etc
andrewm@379:    * </pre>
andrewm@379:    *
andrewm@379:    *\par Modules Description
andrewm@379:    * Ne10 has a modular structure, which means that the package includes several shared or static libraries.
andrewm@379:    * Currently, the following modules are available or in plan:
andrewm@379:    *
andrewm@379:    * - @link groupMaths Math Functions@endlink
andrewm@379:    * - @link groupDSPs Signal Processing Functions@endlink
andrewm@379:    * - @link groupIMGPROCs Image Processing Functions@endlink
andrewm@379:    * - @link groupPhysics Physics Functions@endlink
andrewm@379:    * - Others
andrewm@379:    *
andrewm@379:    *\par Usage
andrewm@379:    *
andrewm@379:    * Ne10 library provides directly and indirectly function call. you could check the @link groupSamples sample code@endlink for details
andrewm@379:    *
andrewm@379:    *\par Build
andrewm@379:    *
andrewm@379:    * See CMakeBuilding.txt file in the "doc" folder
andrewm@379:    *
andrewm@379:    *\par Code formatter
andrewm@379:    *
andrewm@379:    * See Formatter.txt file in the "doc" folder
andrewm@379:    *
andrewm@379:    *\par License
andrewm@379:    *
andrewm@379:    * The Ne10 is provided free of charge by ARM Limited and Contributors, and licensed under both New BSD License
andrewm@379:    * (http://opensource.org/licenses/BSD-3-Clause) and Apache 2.0 (http://www.apache.org/licenses/LICENSE-2.0).
andrewm@379:    * You could also check the LICENSE file in "doc" directory
andrewm@379:    */
andrewm@379: 
andrewm@379: 
andrewm@379: /**
andrewm@379:  * @defgroup groupMaths Math Functions
andrewm@379:  *
andrewm@379:  *
andrewm@379:  * This set of functions provide vector/matrix algebra functions that include
andrewm@379:  * add, sub, multiply, div and so on. Currently, only the float (single precision)
andrewm@379:  * data type is supported.
andrewm@379:  */
andrewm@379: 
andrewm@379: /**
andrewm@379:  * @defgroup groupDSPs Signal Processing Functions
andrewm@379:  *
andrewm@379:  *
andrewm@379:  * This set of functions provide some commonly used functions in signal processing,
andrewm@379:  * such as complex/real FFT/IFFT, FIR and IIR. Currently, only the float (single precision)
andrewm@379:  * data type is supported.
andrewm@379:  */
andrewm@379: 
andrewm@379: /**
andrewm@379:  * @defgroup groupIMGPROCs Image Processing Functions
andrewm@379:  *
andrewm@379:  *
andrewm@379:  * This set of functions provide some commonly used functions in image processing,
andrewm@379:  * such as image scale, image rotate.
andrewm@379:  */
andrewm@379: 
andrewm@379: /**
andrewm@379:  * @defgroup groupPhysics Physics Functions
andrewm@379:  *
andrewm@379:  *
andrewm@379:  * This set of functions provide some APIs used for collision detection,
andrewm@379:  * such as compute AABB, caculate relative velocity and apply contact impulse.
andrewm@379:  */
andrewm@379: 
andrewm@379: /**
andrewm@379:  * @defgroup groupSamples Sample Functions
andrewm@379:  *
andrewm@379:  *
andrewm@379:  * This set of functions provide some sample functions.
andrewm@379:  */
andrewm@379: 
andrewm@379: 
andrewm@379: #ifndef NE10_H
andrewm@379: #define NE10_H
andrewm@379: 
andrewm@379: #ifdef __cplusplus
andrewm@379: extern "C" {
andrewm@379: #endif
andrewm@379: 
andrewm@379: #include <stdio.h>
andrewm@379: #include <stdlib.h>
andrewm@379: #include <math.h>
andrewm@379: #include <string.h>
andrewm@379: 
andrewm@379: #include "NE10_types.h"
andrewm@379: #include "NE10_macros.h"
andrewm@379: #include "NE10_init.h"
andrewm@379: #include "NE10_math.h"
andrewm@379: #include "NE10_dsp.h"
andrewm@379: #include "NE10_imgproc.h"
andrewm@379: #include "NE10_physics.h"
andrewm@379: 
andrewm@379: #ifdef __cplusplus
andrewm@379: }
andrewm@379: #endif
andrewm@379: 
andrewm@379: #endif