init

lib_xcore_math/README.rst

@@ -0,0 +1,70 @@
+:orphan:
+
+####################################
+lib_xcore_math: xcore optimised math
+####################################
+
+:vendor: XMOS
+:version: 2.4.0
+:scope: General Use
+:description: VPU-optimized math for the xcore architecture
+:category: General Purpose
+:keywords: arithmetic, DSP, VPU, math
+:devices: xcore.ai
+
+*******
+Summary
+*******
+
+``lib_xcore_math`` is an arithmetic and DSP library which leverages the Vector Processing Unit
+(VPU) of XS3/`xcore.ai` based devices in order to accelerate costly operations on vectors of 16-
+or 32-bit data.  Included are functions for block floating-point arithmetic, fast Fourier
+transforms, discrete cosine transforms, linear filtering and more.
+
+********
+Features
+********
+
+  * Block Floating-Point Vector API
+  * Vector/Array API
+  * Scalar API
+  * Linear Filtering API
+  * Fast Fourier Transform API
+  * Discrete Cosine Transform API
+
+************
+Known issues
+************
+
+  * None
+
+****************
+Development repo
+****************
+
+  * `lib_xcore_math <https://www.github.com/xmos/lib_xcore_math>`_
+
+**************
+Required tools
+**************
+
+  * XMOS XTC Tools: 15.3.0
+
+*********************************
+Required libraries (dependencies)
+*********************************
+
+  * None
+
+*************************
+Related application notes
+*************************
+
+  * None
+
+*******
+Support
+*******
+
+This package is supported by XMOS Ltd. Issues can be raised against the software at www.xmos.com/support
+