:orphan:

####################################
lib_xcore_math: xcore optimised math
####################################

:vendor: XMOS
:version: 3.0.0
:scope: General Use
:description: VPU-optimized math for the xcore architecture
:category: General Purpose
:keywords: DSP, VPU
: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
************

* Native build only supports xs3a VPU emulation

****************
Development repo
****************

* `lib_xcore_math <https://www.github.com/xmos/lib_xcore_math>`_ (https://www.github.com/xmos/lib_xcore_math)

**************
Required tools
**************

* XMOS XTC Tools: 15.3.1

*********************************
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 <https://www.xmos.com/support>`_ or using GitHub `issues <https://github.com/xmos/lib_xcore_math/issues>`_.
