fix CI

Document and simplify some methods.

.github/workflows/swift.yml

@@ -1,30 +0,0 @@
-name: Swift CI
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
-
-jobs:
-  test:
-    name: Run Unit Tests on macOS and Linux
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [macos-latest, ubuntu-latest]
-        swift: ["5.9", "5.10", "6.0"]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Swift ${{ matrix.swift }}
-        uses: NeedleInAJayStack/setup-swift@feat/swift-6
-        with:
-          swift-version: ${{ matrix.swift }}
-
-      - name: Build and Run Tests
-        run: |
-          swift build --enable-test-discovery
-          swift test

.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: test
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test-linux:
+    name: Tests Linux
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ toJSON(matrix) }}
+      cancel-in-progress: true
+    strategy:
+      fail-fast: false
+      matrix:
+        swift: ["5.9", "5.10", "6.0"]
+
+    runs-on: ubuntu-latest
+    container: swift:${{ matrix.swift }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build
+        run: swift build
+
+      - name: Run tests
+        run: swift test
+
+  test-macos:
+    name: Tests MacOS
+    runs-on: macos-14
+
+    steps:
+      - name: Select toolchain
+        uses: maxim-lobanov/setup-xcode@v1
+        with: { xcode-version: latest-stable }
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build
+        run: swift build
+
+      - name: Run tests
+        run: swift test

.sourcekit-lsp/config.json

@@ -0,0 +1,5 @@
+{
+    "swiftPM": {
+        "cCompilerFlags:" ["-DPFFFT_SCALVEC_ENABLED=1", "-DPFFFT_ENABLE_NEON", "_USE_MATH_DEFINES", "NDEBUG"],
+    }
+}

LICENSE

@@ -0,0 +1,32 @@
+BSD 3-Clause License
+
+Copyright (c) 2024  John K. Luebs
+Copyright (c) 2020  Dario Mambro (dario.mambro@gmail.com)
+Copyright (c) 2019  Hayati Ayguen (h_ayguen@web.de)
+Copyright (c) 2013  Julien Pommier (pommier@modartt.com)
+Copyright (c) 2004 the University Corporation for Atmospheric Research ("UCAR"). All rights reserved. Developed by NCAR's Computational and Information Systems Laboratory, UCAR, www.cisl.ucar.edu.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDERS 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

LICENSE.txt

@@ -1,18 +0,0 @@
-Copyright (c) 2024  John K. Luebs
-Copyright (c) 2020  Dario Mambro (dario.mambro@gmail.com)
-Copyright (c) 2019  Hayati Ayguen (h_ayguen@web.de)
-Copyright (c) 2013  Julien Pommier (pommier@modartt.com)
-Copyright (c) 2004 the University Corporation for Atmospheric
-Research ("UCAR"). All rights reserved. Developed by NCAR's
-Computational and Information Systems Laboratory, UCAR,
-www.cisl.ucar.edu.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. 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.
-
-3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDERS 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

README.md

@@ -1,4 +1,6 @@
 [![CI](https://github.com/jkl1337/SwiftPFFFT/actions/workflows/swift.yml/badge.svg)](https://github.com/jkl1337/SwiftPFFFT/actions/workflows/swift.yml)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fjkl1337%2FSwiftPFFFT%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/jkl1337/SwiftPFFFT)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fjkl1337%2FSwiftPFFFT%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/jkl1337/SwiftPFFFT)
 
 # SwiftPFFFT
 
@@ -23,7 +25,7 @@ performance with much simpler usage and a permissive 3 clause BSD license.
 let fft = try FFT<Complex<Float>>(n: 16)
 let signal = fft.makeSignalBuffer()
 
-signal.mapInPlace { (i, v) in
+signal.enumerateInPlace { (i, v) in
     v = Complex(Float(i) + 1.0, Float(i) - 2.0)
 }
 

Sources/PFFFT/Buffer.swift

@@ -3,6 +3,10 @@ import RealModule
 
 let bufferAlignment = 32
 
+/// Thin wrapper around `UnsafeMutableBufferPointer` providing correct alignment.
+/// PFFFT internally assumes all buffers passed are aligned to 16 or 32 bytes
+/// depending on the platform. Thie type provides correctly aligned buffers
+/// and provides some in place mutating methods.
 @frozen
 public struct Buffer<T>: ~Copyable {
     public let buffer: UnsafeMutableBufferPointer<T>
@@ -32,13 +36,21 @@ public struct Buffer<T>: ~Copyable {
         try body(UnsafeMutableRawBufferPointer(buffer))
     }
 
+    /// Return an array with results of mapping given closure over buffer elements.
+    /// - Parameter transform: A mapping closure. `transform` accepts an element of the buffer
+    ///   as its parameter and returns a transformed value of any type.
+    /// - Returns: An array containing the transformed elements of the buffer.
     @inlinable public func map<U>(_ transform: (T) throws -> U) rethrows -> [U] {
         try buffer.map(transform)
     }
 
-    @inlinable public func mapInPlace(_ body: (Int, inout T) throws -> Void) rethrows {
+    /// Calls the given closure on each element in the buffer for mutation in place.
+    /// - Parameter body: A closure that accepts a zero-based enumeration index.
+    ///   and must return a new value for the element at that index.
+    ///   `body` may throw and the error will be propagated to the caller.
+    @inlinable public func mapInPlace(_ body: (Int) throws -> T) rethrows {
         for i in 0 ..< buffer.count {
-            try body(i, &buffer[i])
+            try buffer[i] = body(i)
         }
     }
 }
@@ -52,9 +64,23 @@ public protocol ComplexType {
 extension Complex: ComplexType {}
 
 public extension Buffer where T: ComplexType {
-    @inlinable func mapInPlaceSwapLast(_ body: (Int, inout T) throws -> Void) rethrows {
+    /// Calls the given closure on each space in the buffer for mutation in place with
+    /// Nyquist replacement at the end.
+    ///
+    /// When operating on Complex->Real transforms PFFFT internally uses a slightly more compact
+    /// but less common encoding of the DC (0) and Nyquist (n/2) components. Since these two
+    /// spectral components are always real, PFFFT places the DC (0) component
+    /// in the real part of the 0th element as expected, but places the Nyquist `(n/2)` component
+    /// in the imaginary part of the 0th element.
+    /// This enumerator works like `mapInPlace` but at the end places the real part of the
+    /// n/2 component into the imaginary part of the 0th element. In normal use it is expected
+    /// that a spectral buffer of 1 extra element is created such that `count == (n/2 + 1)`.
+    /// - Parameter body: A closure that accepts a zero-based enumeration index.
+    ///   and must return a new value for the element at that index.
+    ///   `body` may throw and the error will be propagated to the caller.
+    @inlinable func mapInPlaceSwapLast(_ body: (Int) throws -> T) rethrows {
         for i in 0 ..< buffer.count {
-            try body(i, &buffer[i])
+            try buffer[i] = body(i)
         }
         buffer[0].imaginary = buffer[buffer.count - 1].real
     }

Sources/PFFFT/FFT.swift

@@ -310,7 +310,7 @@ public struct FFT<T: FFTElement>: ~Copyable {
             fatalError("signal buffer too small")
         }
         guard output.count >= n else {
-            fatalError("outputbuffer too small")
+            fatalError("output buffer too small")
         }
         ScalarType.pffftZreorder(ptr, spectrum.baseAddress, rebind(output), .forward)
     }

Sources/PFFFTLib/pffft_priv_impl.h

@@ -1061,12 +1061,14 @@ SETUP_STRUCT *FUNC_NEW_SETUP(int N, pffft_transform_t transform) {
   if (transform == PFFFT_REAL)    { if ((N%(2*SIMD_SZ*SIMD_SZ)) || N<=0) return s; }
   if (transform == PFFFT_COMPLEX) { if ((N%(  SIMD_SZ*SIMD_SZ)) || N<=0) return s; }
   s = (SETUP_STRUCT*)malloc(sizeof(SETUP_STRUCT));
+  if (!s) return s;
   /* assert((N % 32) == 0); */
   s->N = N;
   s->transform = transform;  
   /* nb of complex simd vectors */
   s->Ncvec = (transform == PFFFT_REAL ? N/2 : N)/SIMD_SZ;
   s->data = (v4sf*)FUNC_ALIGNED_MALLOC(2*s->Ncvec * sizeof(v4sf));
+  if (!s->data) { free(s); return 0; }
   s->e = (float*)s->data;
   s->twiddle = (float*)(s->data + (2*s->Ncvec*(SIMD_SZ-1))/SIMD_SZ);  
 

Tests/PFFFTTests/PFFFTTests.swift

@@ -3,14 +3,12 @@ import ComplexModule
 import XCTest
 
 final class FFTTests: XCTestCase {
-    func testFftFloat() throws {
+    func testFftComplexFloat() throws {
         let fft = try FFT<Complex<Float>>(n: 16)
         let signal = fft.makeSignalBuffer()
         let spectrum = fft.makeSpectrumBuffer()
 
-        signal.mapInPlace { i, v in
-            v = Complex(Float(i) + 1.0, Float(i) - 2.0)
-        }
+        signal.mapInPlace { Complex(Float($0) + 1.0, Float($0) - 2.0) }
 
         fft.forward(signal: signal, spectrum: spectrum)