Adding Jenkins

.gitignore

@@ -26,3 +26,4 @@ lib_xcore_math/lib/
 
 # test cruft
 test/deps
+*.csv

CHANGELOG.rst

@@ -6,6 +6,8 @@ lib_xcore_math change log
 
 * Fixes bug (issue #147) in `s16_to_s32()`.
 * Fixes bug (issue #146) in `bfp_s32_macc()` and `bfp_s32_nmacc()`.
+* Fixes bug with the `vect_s32_prepare_api` not appearing in the documentation.
+* Fixes bug in `bfp_s32_mean()` and `bfp_s16_mean()` when hitting a corner case scenario.
 
 2.1.2
 -----

Jenkinsfile

@@ -0,0 +1,135 @@
+@Library('[email protected]')
+
+def runningOn(machine) {
+  println "Stage running on:"
+  println machine
+}
+
+getApproval()
+pipeline {
+  agent none
+
+  parameters {
+    string(
+      name: 'TOOLS_VERSION',
+      defaultValue: '15.2.1',
+      description: 'The XTC tools version'
+    )
+    booleanParam(
+      name: 'XMATH_SMOKE_TEST',
+      defaultValue: true,
+      description: 'Enable smoke run'
+    )
+  } // parameters
+  options {
+    skipDefaultCheckout()
+    timestamps()
+    buildDiscarder(xmosDiscardBuildSettings())
+  } // options
+
+  stages {
+    stage('Bullds and tests') {
+      parallel {
+        stage('Linux builds and tests') {
+          agent {
+            label 'xcore.ai'
+          }
+          stages {
+            stage('Build') {
+              steps {
+                runningOn(env.NODE_NAME)
+                dir('lib_xcore_math') {
+                  checkout scm
+                  // fetch submodules
+                  sh 'git submodule update --init --recursive --jobs 4'
+                  withTools(params.TOOLS_VERSION) {
+                    // xs3a build
+                    sh "cmake -B build_xs3a -DXMATH_SMOKE_TEST=${params.XMATH_SMOKE_TEST} --toolchain=etc/xmos_cmake_toolchain/xs3a.cmake"
+                    sh 'make -C build_xs3a -j4'
+                    // x86 build
+                    sh "cmake -B build_x86 -DXMATH_SMOKE_TEST=${params.XMATH_SMOKE_TEST}"
+                    sh 'make -C build_x86 -j4'
+                    // xmake build
+                    dir('test/legacy_build') {
+                      sh 'xmake -j4'
+                      sh 'xrun --io --id 0 bin/legacy_build.xe'
+                    }
+                  }
+                }
+              }
+            } // Build
+
+            stage('Unit tests xs3a') {
+              steps {
+                dir('lib_xcore_math/build_xs3a/test') {
+                  withTools(params.TOOLS_VERSION) {
+                    sh 'xrun --xscope --id 0 --args bfp_tests/bfp_tests.xe        -v'
+                    sh 'xrun --xscope --id 0 --args dct_tests/dct_tests.xe        -v'
+                    sh 'xrun --xscope --id 0 --args fft_tests/fft_tests.xe        -v'
+                    sh 'xrun --xscope --id 0 --args filter_tests/filter_tests.xe  -v'
+                    sh 'xrun --xscope --id 0 --args scalar_tests/scalar_tests.xe  -v'
+                    sh 'xrun --xscope --id 0 --args vect_tests/vect_tests.xe      -v'
+                    sh 'xrun --xscope --id 0 --args xs3_tests/xs3_tests.xe        -v'
+                  }
+                }
+              }
+            } // Unit tests xs3a
+
+            stage('Unit tests x86') {
+              steps {
+                dir('lib_xcore_math/build_x86/test') {
+                  sh './bfp_tests/bfp_tests        -v'
+                  sh './dct_tests/dct_tests        -v'
+                  sh './fft_tests/fft_tests        -v'
+                  sh './filter_tests/filter_tests  -v'
+                  sh './scalar_tests/scalar_tests  -v'
+                  sh './vect_tests/vect_tests      -v'
+                  sh './xs3_tests/xs3_tests        -v'
+                }
+              }
+            } // Unit tests x86
+          } // stages
+          post {
+            cleanup {
+              xcoreCleanSandbox()
+            }
+          }
+        } // Linux builds and tests
+
+        stage ('Build Documentation') {
+          agent {
+            label 'docker'
+          }
+          environment {
+            XMOSDOC_VERSION = "v3.0.0"
+          }
+          stages {
+            stage('Build Docs') {
+              steps {
+                runningOn(env.NODE_NAME)
+                checkout scm
+                sh "docker pull ghcr.io/xmos/doc_builder:${XMOSDOC_VERSION}"
+                sh """docker run --user "\$(id -u):\$(id -g)" \
+                        --rm \
+                        -v ${WORKSPACE}:/build \
+                        -e EXCLUDE_PATTERNS="/build/doc/doc_excludes.txt" \
+                        -e DOXYGEN=1 -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc \
+                        -e PDF=1 \
+                        ghcr.io/xmos/doc_builder:${XMOSDOC_VERSION} \
+                        || echo "PDF build is badly broken, ignoring for now till it's fixed." """
+
+                archiveArtifacts artifacts: "doc/_build/**", allowEmptyArchive: true
+              } // steps
+            } // Build Docs
+          } // stages
+          post {
+            cleanup {
+              xcoreCleanSandbox()
+            }
+          }
+        } // Build Documentation
+
+      } // parallel
+    } // Bullds and tests
+  } // stages
+} // pipeline

etc/build_options.cmake

@@ -10,7 +10,7 @@ include(CMakeDependentOption)
 set(DEV_LIB_XCORE_MATH OFF CACHE BOOL "Include unit tests and examples as CMake Targets." )
 
 ## If enabled, the unit tests will be run fewer repetitions of each test to speed up execution time
-option(XCORE_MATH_SMOKE_TEST "Build unit tests in 'smoke test' mode. This mostly just reduces the number of repetitions to reduce simulation time." OFF)
+option(XMATH_SMOKE_TEST "Build unit tests in 'smoke test' mode. This mostly just reduces the number of repetitions to reduce simulation time." OFF)
 
 ## If enabled, the FFT look-up tables will be auto-generated at build time (requires Python 3 and numpy)
 set( XCORE_MATH_GEN_FFT_LUT  OFF CACHE BOOL "Auto-generate FFT look-up tables." )