Semantics-preserving cleanup

Sources/Surge/Auxiliary.swift → Sources/Surge/Auxiliary Functions/Auxiliary.swift

@@ -20,7 +20,7 @@
 
 import Accelerate
 
-// MARK: Absolute Value
+// MARK: - Absolute Value
 
 /// Elemen-wise absolute value.
 ///
@@ -50,7 +50,7 @@ public func abs<C: UnsafeMemoryAccessible>(_ x: C) -> [Float] where C.Element ==
     return results
 }
 
-// MARK: Ceiling
+// MARK: - Ceiling
 
 /// Elemen-wise ceiling.
 ///
@@ -80,7 +80,7 @@ public func ceil<C: UnsafeMemoryAccessible>(_ x: C) -> [Double] where C.Element
     return results
 }
 
-// MARK: Clip
+// MARK: - Clip
 
 public func clip<C: UnsafeMemoryAccessible>(_ x: C, low: Float, high: Float) -> [Float] where C.Element == Float {
     var results = [Float](repeating: 0.0, count: numericCast(x.count))
@@ -110,7 +110,7 @@ public func clip<C: UnsafeMemoryAccessible>(_ x: C, low: Double, high: Double) -
     return results
 }
 
-// MARK: Copy Sign
+// MARK: - Copy Sign
 
 /// - Warning: does not support memory stride (assumes stride is 1).
 public func copysign<S: UnsafeMemoryAccessible, M: UnsafeMemoryAccessible>(sign: S, magnitude: M) -> [Float] where S.Element == Float, M.Element == Float {
@@ -136,7 +136,7 @@ public func copysign<S: UnsafeMemoryAccessible, M: UnsafeMemoryAccessible>(sign:
     return results
 }
 
-// MARK: Floor
+// MARK: - Floor
 
 /// Elemen-wise floor.
 ///
@@ -166,7 +166,7 @@ public func floor<C: UnsafeMemoryAccessible>(_ x: C) -> [Double] where C.Element
     return results
 }
 
-// MARK: Negate
+// MARK: - Negate
 
 public func neg<C: UnsafeMemoryAccessible>(_ x: C) -> [Float] where C.Element == Float {
     var results = [Float](repeating: 0.0, count: numericCast(x.count))
@@ -188,7 +188,7 @@ public func neg<C: UnsafeMemoryAccessible>(_ x: C) -> [Double] where C.Element =
     return results
 }
 
-// MARK: Reciprocal
+// MARK: - Reciprocal
 
 /// - Warning: does not support memory stride (assumes stride is 1).
 public func rec<C: UnsafeMemoryAccessible>(_ x: C) -> [Float] where C.Element == Float {
@@ -214,7 +214,7 @@ public func rec<C: UnsafeMemoryAccessible>(_ x: C) -> [Double] where C.Element =
     return results
 }
 
-// MARK: Round
+// MARK: - Round
 
 /// - Warning: does not support memory stride (assumes stride is 1).
 public func round<C: UnsafeMemoryAccessible>(_ x: C) -> [Float] where C.Element == Float {
@@ -240,7 +240,7 @@ public func round<C: UnsafeMemoryAccessible>(_ x: C) -> [Double] where C.Element
     return results
 }
 
-// MARK: Threshold
+// MARK: - Threshold
 
 public func threshold<C: UnsafeMemoryAccessible>(_ x: C, low: Float) -> [Float] where C.Element == Float {
     var results = [Float](repeating: 0.0, count: numericCast(x.count))
@@ -268,7 +268,7 @@ public func threshold<C: UnsafeMemoryAccessible>(_ x: C, low: Double) -> [Double
     return results
 }
 
-// MARK: Truncate
+// MARK: - Truncate
 
 /// - Warning: does not support memory stride (assumes stride is 1).
 public func trunc<C: UnsafeMemoryAccessible>(_ x: C) -> [Float] where C.Element == Float {

Sources/Surge/Convolution.swift → Sources/Surge/Digital Signal Processing/Convolution.swift

@@ -20,7 +20,7 @@
 
 import Accelerate
 
-// MARK: Convolution
+// MARK: - Convolution
 
 /// Convolution of a signal [x], with a kernel [k]. The signal must be at least as long as the kernel.
 public func conv<X: UnsafeMemoryAccessible, K: UnsafeMemoryAccessible>(_ x: X, _ k: K) -> [Float] where X.Element == Float, K.Element == Float {
@@ -68,7 +68,7 @@ public func conv<X: UnsafeMemoryAccessible, K: UnsafeMemoryAccessible>(_ x: X, _
     return result
 }
 
-// MARK: Cross-Correlation
+// MARK: - Cross-Correlation
 
 /// Cross-correlation of a signal [x], with another signal [y]. The signal [y]
 /// is padded so that it is the same length as [x].
@@ -124,7 +124,7 @@ public func xcorr<X: UnsafeMemoryAccessible, Y: UnsafeMemoryAccessible>(_ x: X,
     return result
 }
 
-// MARK: Auto-correlation
+// MARK: - Auto-correlation
 
 /// Auto-correlation of a signal [x]
 public func xcorr<X: UnsafeMemoryAccessible>(_ x: X) -> [Float] where X.Element == Float {

Sources/Surge/FFT.swift → Sources/Surge/Digital Signal Processing/FFT.swift

@@ -20,7 +20,7 @@
 
 import Accelerate
 
-// MARK: Fast Fourier Transform
+// MARK: - Fast Fourier Transform
 
 public func fft(_ input: [Float]) -> [Float] {
     var real = [Float](input)

Sources/Surge/Exponential/Exponential.swift

@@ -0,0 +1,73 @@
+// Copyright © 2014-2018 the Surge contributors
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import Accelerate
+
+// MARK: - Exponentiation
+
+/// - Warning: does not support memory stride (assumes stride is 1).
+public func exp<X: UnsafeMemoryAccessible>(_ x: X) -> [Float] where X.Element == Float {
+    return x.withUnsafeMemory { xm in
+        precondition(xm.stride == 1, "\(#function) does not support strided memory access")
+        var results = [Float](repeating: 0.0, count: numericCast(x.count))
+        results.withUnsafeMutableBufferPointer { rbp in
+            vvexpf(rbp.baseAddress!, xm.pointer, [numericCast(xm.count)])
+        }
+        return results
+    }
+}
+
+/// - Warning: does not support memory stride (assumes stride is 1).
+public func exp<X: UnsafeMemoryAccessible>(_ x: X) -> [Double] where X.Element == Double {
+    return x.withUnsafeMemory { xm in
+        precondition(xm.stride == 1, "\(#function) does not support strided memory access")
+        var results = [Double](repeating: 0.0, count: numericCast(x.count))
+        results.withUnsafeMutableBufferPointer { rbp in
+            vvexp(rbp.baseAddress!, xm.pointer, [numericCast(xm.count)])
+        }
+        return results
+    }
+}
+
+// MARK: - Square Exponentiation
+
+/// - Warning: does not support memory stride (assumes stride is 1).
+public func exp2<X: UnsafeMemoryAccessible>(_ x: X) -> [Float] where X.Element == Float {
+    return x.withUnsafeMemory { xm in
+        precondition(xm.stride == 1, "\(#function) does not support strided memory access")
+        var results = [Float](repeating: 0.0, count: numericCast(x.count))
+        results.withUnsafeMutableBufferPointer { rbp in
+            vvexp2f(rbp.baseAddress!, xm.pointer, [numericCast(xm.count)])
+        }
+        return results
+    }
+}
+
+/// - Warning: does not support memory stride (assumes stride is 1).
+public func exp2<X: UnsafeMemoryAccessible>(_ x: X) -> [Double] where X.Element == Double {
+    return x.withUnsafeMemory { xm in
+        precondition(xm.stride == 1, "\(#function) does not support strided memory access")
+        var results = [Double](repeating: 0.0, count: numericCast(x.count))
+        results.withUnsafeMutableBufferPointer { rbp in
+            vvexp2(rbp.baseAddress!, xm.pointer, [numericCast(xm.count)])
+        }
+        return results
+    }
+}