add functions list to doc
authoryang <yang.zhang@arm.com>
Mon, 10 Dec 2012 03:44:31 +0000 (11:44 +0800)
committeryang <yang.zhang@arm.com>
Mon, 10 Dec 2012 03:44:31 +0000 (11:44 +0800)
doc/FunctionList.txt [new file with mode: 0644]

diff --git a/doc/FunctionList.txt b/doc/FunctionList.txt
new file mode 100644 (file)
index 0000000..c8845d6
--- /dev/null
@@ -0,0 +1,89 @@
+/*
+ *  Copyright 2012 ARM Limited
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *    * Neither the name of ARM Limited nor the
+ *      names of its contributors may be used to endorse or promote products
+ *      derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY ARM LIMITED AND CONTRIBUTORS "AS IS" AND
+ *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ *  DISCLAIMED. IN NO EVENT SHALL ARM LIMITED BE LIABLE FOR ANY
+ *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * NE10 Library : FunctionList.txt
+ */
+
+UPDATE HISTORY
+==============
+----UPDATED ON: 30 / NOV / 2012
+----UPDATED ON: 10 / APR / 2012
+
+Overview
+=========
+
+This file lists currently available functions in Ne10.
+
+math module
+============
+  a) Vector Arithmetic
+
+   abs (float, vec2f, vec3f, vec4f)
+   addc (float, vec2f, vec3f, vec4f)
+   add (float, vec2f, vec3f, vec4f)
+   cross (vec3f)
+   divc (float, vec2f, vec3f, vec4f)
+   div (float, vec2f, vec3f, vec4f)
+   dot (vec2f, vec3f, vec4f)
+   len (vec2f, vec3f, vec4f)
+   mlac (float, vec2f, vec3f, vec4f)
+   mla (float, vec2f, vec3f, vec4f)
+   mulc (float, vec2f, vec3f, vec4f)
+   mul (float, vec2f, vec3f, vec4f)
+   normalize (vec2f, vec3f, vec4f)
+   rsbc (float, vec2f, vec3f, vec4f)
+   setc (float, vec2f, vec3f, vec4f)
+   subc (float, vec2f, vec3f, vec4f)
+   sub (float, vec2f, vec3f, vec4f)
+
+  b) Matrix operations:
+
+   addmat (2x2f, 3x3f, 4x4f)
+   detmat (2x2f, 3x3f, 4x4f)
+   identitymat (2x2f, 3x3f, 4x4f)
+   invmat (2x2f, 3x3f, 4x4f)
+   mulcmatvec (2x2f, 3x3f, 4x4f)
+   mulmat (2x2f, 3x3f, 4x4f)
+   submat (2x2f, 3x3f, 4x4f)
+   transmat (2x2f, 3x3f, 4x4f)
+
+dsp module
+===========
+  a) FFT
+
+   cfft (16, 64, 256, 1024 points)
+   rfft (128, 512 points)
+
+  b) Filter
+
+   fir
+   fir decimate
+   fir interpolat
+   fir lattice
+   fir sparse
+   iir lattice