Update to v2.1.0

Update to v2.1.0

.github/scripts/build_legacy.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+
+pwd
+
+pushd test/legacy_build
+
+xmake

.github/workflows/ci.yml

@@ -106,3 +106,32 @@ jobs:
       - name: "Run Tests: dct_tests"
         working-directory: ~
         run: ./build.x86/test/dct_tests/dct_tests -v
+
+# Ultimately checks that module_build_info is correct enough to build (with xmake) a trivial app 
+# which uses this library.
+  build_legacy_app:
+    name: Build App (xmake)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Pull builder container
+        run: |
+          docker pull ghcr.io/xmos/sdk_app_builder:develop 
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install numpy
+
+      - name: Build
+        run: |
+          docker run --rm -w /lib_xcore_math -v ${{ github.workspace }}:/lib_xcore_math ghcr.io/xmos/sdk_app_builder:develop bash -l .github/scripts/build_legacy.sh

.github/workflows/docs.yml

@@ -36,11 +36,11 @@ jobs:
 
       - name: Pull doc_builder container
         run: |
-          docker pull ghcr.io/xmos/doc_builder:main 
+          docker pull ghcr.io/xmos/doc_builder:latest 
       
       - name: Build documentation
         run: |
-          docker run --rm -t -u "$(id -u):$(id -g)" -v ${{ github.workspace }}:/build -e REPO:/build -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc ghcr.io/xmos/doc_builder:main
+          docker run --rm -t -u "$(id -u):$(id -g)" -v ${{ github.workspace }}:/build -e REPO:/build -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc ghcr.io/xmos/doc_builder:latest
           
       - name: Save documentation artifacts
         uses: actions/upload-artifact@v2

CHANGELOG.rst

@@ -1,6 +1,13 @@
 lib_xcore_math change log
 =========================
 
+2.1.0
+-----
+
+* Adds several new operations for IEEE float vectors.
+* Corrects `module_build_info` for legacy build tools.
+* Fixes potential issue with include paths.
+
 2.0.2
 -----
 

doc/Makefile

@@ -27,7 +27,7 @@ doxy:
 	doxygen
 
 $(DOXYGEN_OUTPUT_DIR)/index.xml: Doxyfile
-	mkdir -p $(DOXYGEN_OUTPUT)
+	cmake -E make_directory $(DOXYGEN_OUTPUT)
 	doxygen
 
 # Catch-all target: route all unknown targets to Sphinx using the new

doc/README.rst

@@ -27,7 +27,7 @@ Pull the docker container:
 
 .. code-block:: console
 
-    $ docker pull ghcr.io/xmos/doc_builder:main
+    docker pull ghcr.io/xmos/doc_builder:main
 
 ========
 Building
@@ -37,7 +37,7 @@ Build documentation:
 
 .. code-block:: console
 
-    $ docker run --rm -t -u "$(id -u):$(id -g)" -v $(pwd)/lib_xcore_math:/build -e REPO:/build -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc ghcr.io/xmos/doc_builder:main
+    docker run --rm -t -u "$(id -u):$(id -g)" -v $(pwd):/build -e REPO:/build -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc ghcr.io/xmos/doc_builder:latest
 
 ********************
 Without Using Docker
@@ -53,7 +53,7 @@ Install the required Python packages:
 
 .. code-block:: console
 
-    $ pip install -r requirements.txt
+    pip install -r requirements.txt
 
 ========
 Building
@@ -63,22 +63,22 @@ Build documentation:
 
 .. code-block:: console
 
-    $ make html
+    make html
 
 Launch sphinx-autobuild server:
 
 .. code-block:: console
 
-    $ make livehtml
+    make livehtml
 
 Clean documentation:
 
 .. code-block:: console
 
-    $ make clean
+    make clean
 
 Clean and build documentation with link check:
 
 .. code-block:: console
     
-    $ make clean html linkcheck SPHINXOPTS="-W --keep-going"
+    make clean html linkcheck SPHINXOPTS="-W --keep-going"

doc/conf.py

@@ -22,11 +22,11 @@
 # -- Project information -----------------------------------------------------
 
 project = u"lib_xcore_math"
-copyright = u"2021, XMOS"
+copyright = u"2022, XMOS"
 author = "XMOS"
 
 # The full version, including alpha/beta/rc tags
-release = "1.0.x"
+release = "2.1.0"
 
 # -- General configuration ---------------------------------------------------
 
@@ -82,8 +82,6 @@
     "sidebar_hide_name": True,
 }
 
-html_css_files = ['custom_style.css']
-
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

doc/src/reference/vect/index.rst

@@ -461,6 +461,9 @@ the operation takes two vector inputs and a scalar input, and the output is a ve
 | :c:func:`vect_f32_dot()`                        |     | :math:`(\mathbb{V \times V})`            |
 |                                                 |     | :math:`\to \mathbb{s}`                   |
 +-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_f32_add()`                        |  x  | :math:`\mathbb{V \times V}`              |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
 | :c:func:`vect_float_s32_log_base()`             |  x  | :math:`(\mathbb{V \times s})`            |
 |                                                 |     | :math:`\to \mathbb{V}`                   |
 +-------------------------------------------------+-----+------------------------------------------+
@@ -476,6 +479,21 @@ the operation takes two vector inputs and a scalar input, and the output is a ve
 | :c:func:`chunk_float_s32_log()`                 |  x  | :math:`\mathbb{V}`                       |
 |                                                 |     | :math:`\to \mathbb{V}`                   |
 +-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_complex_f32_add()`                |  x  | :math:`\mathbb{V \times V}`              |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_complex_f32_mul()`                |  x  | :math:`\mathbb{V \times V}`              |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_complex_f32_conj_mul()`           |  x  | :math:`\mathbb{V \times V}`              |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_complex_f32_macc()`               |  x  | :math:`\mathbb{V \times V \times V}`     |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
+| :c:func:`vect_complex_f32_conj_macc()`          |  x  | :math:`\mathbb{V \times V \times V}`     |
+|                                                 |     | :math:`\to \mathbb{V}`                   |
++-------------------------------------------------+-----+------------------------------------------+
 
 
 .. _vect_other_api:

lib_xcore_math/api/xmath/api.h

@@ -1,6 +1,5 @@
 // Copyright 2021-2022 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
-// XMOS Public License: Version 1
 
 #pragma once
 

lib_xcore_math/api/xmath/bfp/bfp.h

@@ -3,8 +3,8 @@
 
 #pragma once
 
-#include "bfp_s16.h"
-#include "bfp_s32.h"
-#include "bfp_complex_s16.h"
-#include "bfp_complex_s32.h"
-#include "bfp_misc.h"
+#include "xmath/bfp/bfp_s16.h"
+#include "xmath/bfp/bfp_s32.h"
+#include "xmath/bfp/bfp_complex_s16.h"
+#include "xmath/bfp/bfp_complex_s32.h"
+#include "xmath/bfp/bfp_misc.h"

lib_xcore_math/api/xmath/bfp/bfp_complex_s16.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 /**
  * @defgroup bfp_complex_s16_api    Complex 16-bit Block Floating-Point API

lib_xcore_math/api/xmath/bfp/bfp_complex_s32.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 /**
  * @defgroup bfp_complex_s32_api    Complex 32-bit Block Floating-Point API

lib_xcore_math/api/xmath/bfp/bfp_misc.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 
 

lib_xcore_math/api/xmath/bfp/bfp_s16.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 /**
  * @defgroup bfp_s16_api    16-bit Block Floating-Point API

lib_xcore_math/api/xmath/bfp/bfp_s32.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 /**
  * @defgroup bfp_s32_api    32-bit Block Floating-Point API

lib_xcore_math/api/xmath/dct.h

@@ -4,7 +4,7 @@
 #pragma once
 
 #include "xmath/types.h"
-#include "_support/dct_impl.h"
+#include "xmath/_support/dct_impl.h"
 
 /**
  * @defgroup dct_api  XMath DCT API

lib_xcore_math/api/xmath/fft.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "_support/fft_impl.h"
+#include "xmath/_support/fft_impl.h"
 
 /**
  * @defgroup fft_api  XMath FFT API

lib_xcore_math/api/xmath/q_format.h

@@ -1,6 +1,5 @@
 // Copyright 2022 XMOS LIMITED.
 // This Software is subject to the terms of the XMOS Public Licence: Version 1.
-// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 #pragma once
 
 /**

lib_xcore_math/api/xmath/scalar/f32.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/float_complex_s16.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/float_complex_s32.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/float_s32.h

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "../types.h"
+#include "xmath/types.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/s16.h

@@ -3,8 +3,8 @@
 
 #pragma once
 
-#include "../types.h"
-#include "../xs3/vpu_info.h"
+#include "xmath/types.h"
+#include "xmath/xs3/vpu_info.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/s32.h

@@ -3,8 +3,8 @@
 
 #pragma once
 
-#include "../types.h"
-#include "../xs3/vpu_info.h"
+#include "xmath/types.h"
+#include "xmath/xs3/vpu_info.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/scalar/scalar.h

@@ -4,10 +4,10 @@
 #pragma once
 
 
-#include "f32.h"
-#include "float_complex_s16.h"
-#include "float_complex_s32.h"
-#include "float_s32.h"
-#include "s16.h"
-#include "s32.h"
-#include "scalar_misc.h"
+#include "xmath/scalar/f32.h"
+#include "xmath/scalar/float_complex_s16.h"
+#include "xmath/scalar/float_complex_s32.h"
+#include "xmath/scalar/float_s32.h"
+#include "xmath/scalar/s16.h"
+#include "xmath/scalar/s32.h"
+#include "xmath/scalar/scalar_misc.h"

lib_xcore_math/api/xmath/scalar/scalar_misc.h

@@ -3,8 +3,8 @@
 
 #pragma once
 
-#include "../types.h"
-#include "../xs3/vpu_info.h"
+#include "xmath/types.h"
+#include "xmath/xs3/vpu_info.h"
 
 #include <stdio.h>
 #include <assert.h>

lib_xcore_math/api/xmath/types.h

@@ -5,7 +5,7 @@
 
 #include <stdint.h>
 
-#include "api.h"
+#include "xmath/api.h"
 
 #ifdef __XC__
 extern "C" {