\mainpage Ne10 Software Library
*
*
- * <b>Introduction</b>
+ *\par Introduction
*
* 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
*
* The Ne10 components are:
*
- * - math functions
- * - DSP functions
+ * - @link groupMaths Math Functions@endlink
+ * - @link groupDSPs Signal Processing Functions@endlink
* - Physics functions
* - Image Processing functions
* - Others
+ *\par
+ *\image html ne10_library.png "Ne10 Library Description"
*
- *
- * <b>License</b>
+ *\par License
*
* The Ne10 is provided free of charge by ARM Limited and licensed under New BSD license.
*/
+
+/**
+ * @defgroup groupMaths Math Functions
+ *
+ *\par Introduction
+ *
+ * This set of functions provide vector/matrix algebra functions that include
+ * add, sub, multiply, div and so on. Currently, only the float (single precision)
+ * data type is supported.
+ */
+
+/**
+ * @defgroup groupDSPs Signal Processing Functions
+ *
+ *\par Introduction
+ *
+ * This set of functions provide some commonly used functions in signal processing,
+ * such as complex/real FFT/IFFT, FIR and IIR. Currently, only the float (single precision)
+ * data type is supported.
+ */
+
+
#ifndef NE10_H
#define NE10_H
* NE10 Library : inc/NE10_math.h
*/
-/*! \file NE10_math.h
- \brief All NE10 math routines declarations.
-
- The routines that are provided by this library are all declared in this header file.
- */
#include <NE10_types.h>
#include "NE10_types.h"
/**
- * @ingroup groupFilters
+ * @ingroup groupDSPs
*/
/**
#include "NE10_types.h"
/**
- * @ingroup groupFilters
+ * @ingroup groupDSPs
*/
/**
* Set the values in the state buffer to zeros and then manually initialize the instance structure as follows:
* <pre>
*arm_iir_lattice_instance_f32 S = {numStages, pState, pkCoeffs, pvCoeffs};
- *arm_iir_lattice_instance_q31 S = {numStages, pState, pkCoeffs, pvCoeffs};
- *arm_iir_lattice_instance_q15 S = {numStages, pState, pkCoeffs, pvCoeffs};
* </pre>
* \par
* where <code>numStages</code> is the number of stages in the filter; <code>pState</code> points to the state buffer array;
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory.
-PROJECT_LOGO = ./image/ne10_logo.png
+PROJECT_LOGO = ./image/ne10_logo.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY =
+OUTPUT_DIRECTORY =
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output