Surge is a Swift library that uses the Accelerate framework to provide high-performance functions for matrix math, digital signal processing, and image manipulation.
Accelerate exposes SIMD instructions available in modern CPUs to significantly improve performance of certain calculations. Because of its relative obscurity and inconvenient APIs, Accelerate is not commonly used by developers, which is a shame, since many applications could benefit from these performance optimizations.
Surge aims to bring Accelerate to the mainstream, making it as easy (and nearly as fast, in most cases) to perform computation over a set of numbers as for a single member.
Though, keep in mind: Accelerate is not a silver bullet. Under certain conditions, such as performing simple calculations over a small data set, Accelerate can be out-performed by conventional algorithms. Always benchmark to determine the performance characteristics of each potential approach.
Curious about the name Surge? Back in the mid 90's, Apple, IBM, and Motorola teamed up to create AltiVec (a.k.a the Velocity Engine), which provided a SIMD instruction set for the PowerPC architecture. When Apple made the switch to Intel CPUs, AltiVec was ported to the x86 architecture and rechristened Accelerate. The derivative of Accelerate (and second derivative of Velocity) is known as either jerk, jolt, surge, or lurch, hence the name of this library.
Initial benchmarks on iOS devices and the iOS simulator indicate significant performance improvements over a conventional Swift implementation.
import Surge let numbers: [Double] = ... var sum: Double = 0.0 // Naïve Swift Implementation sum = reduce(numbers, 0.0, +) // Surge Implementation sum = Surge.sum(numbers)
(Time in milliseconds, Optimization Level
| n | Swift | Surge | Δ | |------------|------------------|---------------|-----------| | 100 | 0.269081 | 0.004453 | ~60x | | 100000 | 251.037254 | 0.028687 | ~9000x | | 100000000 | 239474.689326 | 57.009841 | ~4000x |
Surge's performance characteristics have not yet been thoroughly evaluated, though initial benchmarks show incredible promise. Further investigation is definitely warranted.
The infrastructure and best practices for distributing Swift libraries are currently in flux during this beta period of Swift & Xcode. In the meantime, you can add Surge as a git submodule, drag the
Surge.xcodeproj file into your Xcode project, and add
Surge.framework as a dependency for your target.
Surge uses Swift 4.1. This means that your code has to be written in Swift 4.x due to current binary compatibility limitations.
Swift Package Manager
To use Swift Package Manager add Surge to your
let package = Package( name: "myproject", dependencies: [ .package(url: "https://github.com/mattt/Surge.git", .upToNextMajor(from: "2.0.0")), ], targets: [ .target( name: "myproject", dependencies: ["Surge"]), ] )
To use CocoaPods add Surge to your
source 'https://github.com/CocoaPods/Specs.git' platform :ios, '10.0' use_frameworks! target '<Your Target Name>' do pod 'Surge', '~> 2.0.0' end
To use Carthage add Surge to your
github "mattt/Surge" ~> 2.0.0
carthage update and use the framework in
Surge functions are named according to their corresponding "Math.h" functions, where applicable (omitting
daffixes, since type information is communicated and enforced by the language's type system).
Computing Sum of
import Surge let n = [1.0, 2.0, 3.0, 4.0, 5.0] let sum = Surge.sum(n) // 15.0
Computing Product of Two
import Surge let a = [1.0, 3.0, 5.0, 7.0] let b = [2.0, 4.0, 6.0, 8.0] let product = Surge.mul(a, b) // [2.0, 12.0, 30.0, 56.0]
Surge is available under the MIT license. See the LICENSE file for more info.
Help us keep the lights on
2.1.0 - Jun 30, 2018
+ operator is used by Swift for array concatenation. This caused some confusion with Surge's
+ element-wise addition. For this version all element-wise operators are preceded by a dot:
This version also updates to Swift 4.0 and adds a few extra functions.
2.0.0 - Sep 19, 2017
It took a while but it's finally here. This version support Swift 3.2 and Xcode 9.
Other changes include:
- Fix Matrix initialization bug
- Add Swift Package Manager support
- Fix Carthage support.
- Make rows and columns properties public
- Add sum of square values.
- Add some helper methods for matrix
subscriptsupport to return specific row or column
- Add support for scaling matrix by row or by column
powsupport applying to every element
- Add subtract method and operator
0.4.0 - Dec 11, 2015
This release is the last version to support Swift 1.0. Surge 2.x releases will support Swift 2.0.