Project Ne10
An Open Optimized Software Library Project for the ARM Architecture
Welcome to Ne10 Documentation!
Introduction

Ne10 (http://projectne10.github.com/Ne10/) is a library of the most commonly used functions that have been heavily optimized for ARM-based CPUs with NEON. These functions provide a consistent well tested behavior that can be easily incorporated into applications enabling developers to get the most out of the ARM V7/NEON without arduous assembly coding. Ne10 is usable as a 'drop and go' pre-built library or as a set of modular functions that can be incorporated in a more modular "pick and mix" form where binary size might be an issue.

The following figure illustrates the basic concepts of "What's Ne10"

Ne10 Library Description
Top-Level Overview
When you checkout Ne10, you will notice a number of directories. These directories are as follows:
  ├── android
  │   └── Android reference files
  ├── build
  │   └── directory for build-related files
  ├── common
  │   └── directory for common header, table and macro definition files
  ├── doc
  │   └── directory for documentations
  ├── inc
  │   └── directory for functions'heaeder files
  ├── modules
  │   ├── dsp
  │   │   ├──  dsp module that provides a set of signal processing functions, such as complex/real FFT/IFFT, FIR and IIR
  │   │   └── test
  │   │       └──  directory for test files
  │   ├── imgproc
  │   │   ├──  imgproc module that provides a set of image processing functions, such as image resize, image rotate
  │   │   └── test
  │   │       └──  directory for test files
  │   ├── math
  │   │   ├──  math module that provides a set of vector/matrix algebra functions
  │   │   └── test
  │   │       └──  directory for test files
  │   ├── physics
  │   │   ├──  physics module that provides a set of collision detection functions
  │   │   └── test
  │   │       └──  directory for test files
  ├── samples
  │   └──  sample code
  ├── test
  │   ├── directory for test framework
  ├── tools
  │   ├── directory for tools such as Cformatter, doxygen, etc
  
Modules Description
Ne10 has a modular structure, which means that the package includes several shared or static libraries. Currently, the following modules are available or in plan:
Usage

Ne10 library provides directly and indirectly function call. you could check the sample code for details

Build

See CMakeBuilding.txt file in the "doc" folder

Code formatter

See Formatter.txt file in the "doc" folder

License

The Ne10 is provided free of charge by ARM Limited and Contributors, and licensed under New BSD License (http://opensource.org/licenses/BSD-3-Clause). You could also check the LICENSE file in "doc" directory