Provide partial WebAssembly support (#55)

* Enable coverage reports and add ci step for the wasm build. The build should fail because the code is still not modified

* Update workflow toolchain version

* Add test step

* Fix iOS CI, update WASM CI for testing we will need later and provide some documentation + scripts

* Update CI and swift version

* Update CI

* Enable shared memory

* Do not use number formatter for wasm

* Make mfarray compatible with wasm by disabling coreml features

* Make mfadata compatible with wasm

* Get mftype compatible with wasm

* Provide now a mftype fallback types we when accelerate is not available

* Get order now compatible with XP

* Get a fallback implementaiton if accelerate is not availbe in types.swift

* Get some extra wrappers for libraries we don't support

* Get now method folder compatible with wasm

* Get fallback implementation for static folder

* Get library and wrapper compatible with WASM

* Add support for complex testing scenarios

* Disable complex tests

* Improve import usage

* Use the right param names

* Add fallback implementations with fatal errors until we are able to implement this part

* Disable performance tests temporally

* Update random tests to reduce memory pressure

* Fix import

* Update wrong import

* Disable some other performance tests

* Enable back wasm fallback tests and revert a change made by mistake

* Update clapack pacakge and add some guards to our code to prevent tentative errors

* Use https for dependency instead of ssh

* Disable some perf tests temporally for WASM

* Fix CI by forcing the toolchain version we have to use

Author: pedrovgs

.github/workflows/swift.yml

@@ -12,10 +12,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: swift-actions/setup-swift@v1
+    - uses: swift-actions/setup-swift@v2
       with:
-        swift-version: "5.9.2"
-    - name: Build
-      run: swift build -v
-    - name: Run tests
-      run: swift test -v
+        swift-version: "6.1"
+    - name: Build and Test
+      run: ./scripts/build-and-test-ios.sh

.github/workflows/wasm.yml

@@ -0,0 +1,55 @@
+name: wasm
+
+on:
+  push:
+
+env:
+  # Required Swift toolchain version for WASM builds
+  # Must match REQUIRED_TOOLCHAIN_VERSION in scripts/build-and-test-wasm.sh
+  SWIFT_TOOLCHAIN_VERSION: "DEVELOPMENT-SNAPSHOT-2025-11-03-a"
+  # Checksum for the WASM SDK (from SwiftWasm release page)
+  SWIFT_WASM_SDK_CHECKSUM: "879c08f24c36e20e0b3d1fadc37f4c34c089c72caa018aec726d9e0bf84ea6ff"
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      # Install the specific Swift development snapshot required for WASM builds
+      # Toolchain comes from swift.org, SDK comes from SwiftWasm
+      - name: Install Swift Toolchain
+        run: |
+          SWIFT_URL="https://download.swift.org/development/ubuntu2404/swift-${SWIFT_TOOLCHAIN_VERSION}/swift-${SWIFT_TOOLCHAIN_VERSION}-ubuntu24.04.tar.gz"
+          echo "Downloading Swift toolchain from: $SWIFT_URL"
+          mkdir -p /opt/swift
+          curl -sL "$SWIFT_URL" | tar xz --strip-components=1 -C /opt/swift
+          echo "/opt/swift/usr/bin" >> $GITHUB_PATH
+
+      - name: Verify Swift Installation
+        run: swift --version
+
+      # Install the matching WASM SDK from SwiftWasm
+      - name: Install WASM SDK
+        run: |
+          SDK_URL="https://github.com/swiftwasm/swift/releases/download/swift-wasm-${SWIFT_TOOLCHAIN_VERSION}/swift-wasm-${SWIFT_TOOLCHAIN_VERSION}-wasm32-unknown-wasip1-threads.artifactbundle.zip"
+          echo "Installing WASM SDK from: $SDK_URL"
+          swift sdk install "$SDK_URL" --checksum "$SWIFT_WASM_SDK_CHECKSUM"
+          echo "Installed SDKs:"
+          swift sdk list
+
+      # Set environment variable to signal the correct toolchain is installed
+      - name: Set Toolchain Environment
+        run: echo "SWIFT_WASM_TOOLCHAIN_VERIFIED=1" >> $GITHUB_ENV
+
+      # Wasmtime is required because `swift test` doesn't work for WebAssembly targets.
+      # For WASM, we must build tests separately and run them with a WASM runtime.
+      # See: https://book.swiftwasm.org/getting-started/testing.html
+      - name: Install Wasmtime
+        uses: bytecodealliance/actions/wasmtime/setup@v1
+        with:
+          version: "40.0.2"
+          github_token: ${{ github.token }}
+
+      - name: Build and Test
+        run: ./scripts/build-and-test-wasm.sh

.swiftpm/xcode/xcshareddata/xcschemes/Matft.xcscheme

@@ -54,7 +54,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">

Package.resolved

@@ -1,38 +1,35 @@
-// swift-tools-version:5.1
+// swift-tools-version:5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "Matft",
     products: [
-        // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "Matft",
             targets: ["Matft"]),
-        //.library(name: "ReleaseTest", targets: ["Matft "])
     ],
     dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-collections", from: "1.0.0"),
-
+        .package(url: "https://github.com/goodnotes/CLAPACK", branch: "eigen-support"),
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .target(
             name: "pocketFFT"
             ),
         .target(
             name: "Matft",
-            dependencies: ["Collections", "pocketFFT"]),
+            dependencies: [
+                .product(name: "Collections", package: "swift-collections"),
+                "pocketFFT",
+                .product(name: "CLAPACK", package: "CLAPACK", condition: .when(platforms: [.wasi])),
+            ]),
         .testTarget(
             name: "MatftTests",
             dependencies: ["Matft"]),
         .testTarget(
             name: "PerformanceTests",
             dependencies: ["Matft"]),
     ]
-    //cxxLanguageStandard: .gnucxx1z
 )

Package.swift

@@ -27,6 +27,9 @@ INFO: Support Complex!!
     + [SwiftPM](#swiftpm)
     + [Carthage](#carthage)
     + [CocoaPods](#cocoapods)
+  * [Build Scripts](#-build-scripts)
+    + [iOS/macOS Build & Test](#-iosmacos-build--test)
+    + [WebAssembly Build & Test](#-webassembly-build--test)
   * [Contact](#contact)
 
 <strike>
@@ -858,6 +861,43 @@ So, a pull request is very welcome!!
   pod install
   ```
 
+## 🛠️ Build Scripts
+
+Matft provides convenient bash scripts for building and testing the project locally.
+
+### 🍎 iOS/macOS Build & Test
+
+To build and test Matft for iOS/macOS platforms:
+
+```bash
+./scripts/build-and-test-ios.sh
+```
+
+This script will:
+- Build the project using `swift build`
+- Run all tests using `swift test`
+
+### 🌐 WebAssembly Build & Test
+
+To build and test Matft for WebAssembly:
+
+```bash
+./scripts/build-and-test-wasm.sh
+```
+
+This script will:
+- 📦 Check and install the Swift WASM SDK if needed
+- 🔧 Check and install wasmtime runtime if needed
+- 🔨 Build the project for WebAssembly
+- 🧪 Build and run tests using wasmtime
+
+**Note:** The WASM script automatically handles SDK and runtime installation, so you can run it on a fresh machine without any prior setup!
+
+### Requirements
+
+- **iOS/macOS:** Swift 6.1 or later
+- **WebAssembly:** Swift 6.1 or later (SDK will be automatically installed)
+
 ## Contact
 
 Feel free to ask this project or anything via <junnosuke.kado.git@gmail.com>

README.md

@@ -24,9 +24,22 @@ extension MfArray: CustomStringConvertible{
         var shape = self.shape
         var strides = self.strides
 
+        #if os(WASI)
+        let formatter: NumberFormatter? = nil
+        #else
         let formatter = NumberFormatter()
         formatter.positivePrefix = formatter.plusSign
         formatter.maximumFractionDigits = self.storedType == .Float ? 7 : 14
+        #endif
+
+        func imagString(_ value: Any) -> String{
+            #if os(WASI)
+            // Avoid NumberFormatter on WASI (Foundation formatter crashes in wasm)
+            return "\(value)"
+            #else
+            return formatter.string(for: value) ?? "\(value)"
+            #endif
+        }
 
         if self.size > 1000{//if size > 1000, some elements left out will be viewed
             let flattenLOIndSeq = FlattenLOIndSequence(storedSize: self.storedSize, shape: &shape, strides: &strides)
@@ -39,7 +52,7 @@ extension MfArray: CustomStringConvertible{
                         desc += "\t\(flattenData[flattenIndex + self.offsetIndex]),\t"
                     }
                     else{
-                        desc += "\t\(flattenData[flattenIndex + self.offsetIndex]) \(formatter.string(for: flattenImagData![flattenIndex + self.offsetIndex]) ?? "")j,\t"
+                        desc += "\t\(flattenData[flattenIndex + self.offsetIndex]) \(imagString(flattenImagData![flattenIndex + self.offsetIndex]))j,\t"
                     }
 
                     if indices.last! == shape.last! - 1{
@@ -81,7 +94,7 @@ extension MfArray: CustomStringConvertible{
                     desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]),\t"
                 }
                 else{
-                    desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]) \(formatter.string(for: flattenImagData![ret.flattenIndex + self.offsetIndex]) ?? "")j,\t"
+                    desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]) \(imagString(flattenImagData![ret.flattenIndex + self.offsetIndex]))j,\t"
                 }
 
                 if ret.indices.last! == shape.last! - 1{

Sources/Matft/core/general/print.swift

@@ -7,8 +7,9 @@
 //
 
 import Foundation
-import Accelerate
+#if canImport(CoreML)
 import CoreML
+#endif
 
 open class MfArray: MfArrayProtocol{
     public typealias MFDATA = MfData
@@ -111,6 +112,7 @@ open class MfArray: MfArrayProtocol{
         self.mfstructure = mfstructure//mfstructure will be copied because mfstructure is struct
     }
 
+    #if canImport(CoreML)
     /// Create a VIEW or Copy mfarray from MLShapedArray
     /// - Parameters:
     ///    - base: A base MLShapedArray
@@ -126,6 +128,7 @@ open class MfArray: MfArrayProtocol{
         self.mfdata = mfdata
         self.mfstructure = MfStructure(shape: base.shape.map{ Int(truncating: $0) }, strides: base.strides.map{ Int(truncating: $0) })
     }
+    #endif
 
     deinit {
         self.base = nil

Sources/Matft/core/object/mfarray.swift

@@ -7,7 +7,6 @@
 //
 
 import Foundation
-import Accelerate
 
 internal enum MfDataSource{
     case mfdata
@@ -72,7 +71,7 @@ public class MfData: MfDataProtocol{
         case .Double:
             // dynamic allocation
             self.data_real = allocate_doubledata_from_flattenArray(&flatten_realArray, toBool: mftype == .Bool)
-            self.data_imag = allocate_floatdata_from_flattenArray(&flatten_imagArray, toBool: mftype == .Bool)
+            self.data_imag = allocate_doubledata_from_flattenArray(&flatten_imagArray, toBool: mftype == .Bool)
         }
         self.storedSize = flatten_realArray.count
         self.mftype = mftype
@@ -106,18 +105,18 @@ public class MfData: MfDataProtocol{
 
                 if let data_imag_ptr = data_imag_ptr{
                     self.data_imag = allocate_unsafeMRPtr(type: Float.self, count: storedSize)
-                    memcpy(self.data_imag, data_imag_ptr, self.storedByteSize)
+                    memcpy(self.data_imag!, data_imag_ptr, self.storedByteSize)
                 }
                 else{
                     self.data_imag = nil
                 }
             case .Double:
                 self.data_real = allocate_unsafeMRPtr(type: Double.self, count: storedSize)
                 memcpy(self.data_real, data_real_ptr, self.storedByteSize)
-                
+
                 if let data_imag_ptr = data_imag_ptr{
                     self.data_imag = allocate_unsafeMRPtr(type: Double.self, count: storedSize)
-                    memcpy(self.data_imag, data_imag_ptr, self.storedByteSize)
+                    memcpy(self.data_imag!, data_imag_ptr, self.storedByteSize)
                 }
                 else{
                     self.data_imag = nil

Sources/Matft/core/object/mfdata.swift

@@ -73,8 +73,12 @@ internal func shape2size(_ shape: inout [Int]) -> Int{
 ///   - mforder: Order
 /// - Returns: A strides array
 internal func shape2strides(_ shape: inout [Int], mforder: MfOrder) -> [Int]{
+    guard !shape.isEmpty else {
+        return []
+    }
+
     var ret = Array<Int>(repeating: 0, count: shape.count)
-    
+
     switch mforder {
     case .Row://, .None:
         var prevAxisNum = shape2size(&shape)