[5.1] Collected Accelerate overlay work #24269

stephentyrone · 2019-04-25T13:20:21Z

This batches up all of @FlexMonkey's Accelerate overlay changes for 5.1 branch.

rdar://problem/50203684

* [Accelerate] [Quadrature] New Quadrature Overlay A class that simplifies approximating the definite integral of a function. * Fixes in response to PR Review. Change `@_exported import Accelerate` to `import Accelerate`. Correct date in copyright comment. * Code Review Fixes. * Remove mutable integrator, simply set options in init(). * Remove mutable `maxIntervals` and `qagPointsPerInterval`. * Update tests. * Code Review Fixes. * Use standard library `Result`. * Implement `QAGPointsPerInterval` as a struct. * Tidy up Passing Integrand to `quadrature_integrate_function`. Pass the integrand closure directly to the `quadrature_integrate_function` initialiser rather than attaching as a property of the `Quadrature` class. * Make `Quadrature` a struct, and remove requirement for `integrand` to be escaping. * Code Review Changes * Add long-form integrator algorithm aliases (update tests to use these aliases). * Make quadrature error description public. * New tests for error description and `QAGPointsPerInterval`. * Vectorized Integrand for Quadrature Create an alternative implementation of `integrate` that accepts an integrand of type `(_ input: UnsafeBufferPointer<Double>, _ result: UnsafeMutableBufferPointer<Double>)`. * Vectorized Integrand for Quadrature Create an alternative implementation of `integrate` that accepts an integrand of type `(_ input: UnsafeBufferPointer<Double>, _ result: UnsafeMutableBufferPointer<Double>)`. * Vectorized Integrand for Quadrature Remove _ContiguousCollection - it's no longer used. * Delete ContiguousCollection.swift Not required. * Refactor tests.

* [Accelerate] [vForce] New vForce Overlay This PR contains a suite of overlays to the vForce transcendental and trigonometric functions on vectors of any length. The overlays simplify the API to the existing functions and accept collections that implement a new protocol called AccelerateBuffer. Conformances are provided for the most useful stdlib Collections.

…DSP-Overlays

* Add missing cast to new vDSP_FIR overlay. * Use macOS instead of OSX in availability annotations. * Reorder Accelerate/CMakeLists.txt alphabetically.

* Accelerate vImage Swift Overlays A suite of functions, enumerations, and option sets to make working with vImage in Swift simpler. * vImage_Buffer - new initializers to instantiate and initialize buffers with a single function call. * vImage_Buffer - new functions to copy buffers and create CGImage instances from contents. * vImage_CGImageFormat - new initializers. * vImage_CGImageFormat - new equivalence operator. * vImageConverter - methods to wrap free functions. * vImageConverter - new make and convert functions. * vImageCVImageFormat - new make functions. * vImageCVImageFormat - methods to wrap free functions. * vImage_Error - errorDescription function. * vImage flags as an option set. * Add new methods for generating CV -> CG and CG -> CV converters. * update comments: `height` and `width` to `size`. * `vImage_CGImageFormat.componentCount` should be `Int`. * `vImage_CGImageFormat.componentCount` should be `Int` * Move `self.init()` to after the size check for kvImageNoAllocate init. * Buffer initializers to width and height rather than size. * change vImage_CGImageFormat lightweight initializer to accept Int for `bitsPerComponent` and `bitsPerPixel`. * Flesh out docs for vImage_Buffer.size * Remove faux initializer in favor of new static function: `preferredAlignmentAndRowBytes`. * Change functions to use proper error handling rather than inout error codes. * Removed `flags` from basic init. The only real flag to pass here is print diagnostics to console, and I now throw proper errors. * Tests to check error throwing for buffer copy. * remove unnecessary import, add missing docs. * Add comments to error enums. * Fix bug creating string from format code. * Make `vImageCVImageFormat.formatCode` a `UInt32`. * Remove equivalence operator from `CGImageFormat`.

@moiseev

* Swift overlay to vDSP cascaded biquad IIR filter. * update comment in test * Swift overlay to vDSP Discrete Cosine Transform * Swift Overlays to vDSP Fast Fourier Transform and Discrete Fourier Transform * Tests for DFT and FFT * Some refactoring and begin documentation. * Swift overlays to FFT and DFT operations. * Expand docs. * Implement `vDSP_destroy_fftsetup` and `vDSP_destroy_fftsetupD` * Refactor Tests * Refactor Tests * Provide transform function that returns the result. Refactoring: parameter names more consistent with other vDSP operations, push `fileprivate` symbols to bottom of file. * Add apply() function that returns the result. * Added a version of DFT transform that returns the result. * update some DFT comments * Remove FFT overlays from this branch to separate DFT and FFT pull requests. * [Accelerate] [vDSP] Swift Overlays to FFT Operations This PR contains Swift overlays to simplify performing 1D and 2D fast Fourier transforms on single- and double-precision data. This PR includes a subset of the operations (e.g. vDSP_fft_zrop for FFT). My plan is to add the additional operations (e.g. multiple signals, in-place operations, etc.) in a subsequent PR once this is approved. cc: @moiseev @airspeedswift @stephentyrone * Composite Branch Contains FFT, DFT, DCT, and Biquad branches.

…ilability

stephentyrone · 2019-04-25T13:20:39Z

@swift-ci please test

stephentyrone · 2019-04-25T13:20:57Z

@swift-ci please test source compatibility

swift-ci · 2019-04-25T13:33:25Z

Build failed
Swift Test OS X Platform
Git Sha - 1508934

…vImage-test Temporarily disable a new vImage test that's failing for some platforms.

This file exists on master but not on 5.1.

stephentyrone · 2019-04-25T19:54:31Z

@swift-ci please test

stephentyrone · 2019-04-25T19:54:40Z

@swift-ci please test source compatibility

swift-ci · 2019-04-25T19:56:35Z

Build failed
Swift Test Linux Platform
Git Sha - 1508934

swift-ci · 2019-04-25T20:05:48Z

Build failed
Swift Test OS X Platform
Git Sha - 1508934

stephentyrone · 2019-04-25T23:48:09Z

Turns out the GYB_SOURCES change never made it onto 5.1 branch. Alas.

stephentyrone · 2019-04-25T23:48:15Z

@swift-ci please test

swift-ci · 2019-04-25T23:54:42Z

Build failed
Swift Test Linux Platform
Git Sha - 10f301c

stdlib/public/Darwin/Accelerate/AccelerateBuffer.swift

stephentyrone · 2019-04-26T00:24:38Z

@swift-ci please test

swift-ci · 2019-04-26T00:26:43Z

Build failed
Swift Test Linux Platform
Git Sha - c6335c9

karwa · 2019-04-26T01:04:41Z

stdlib/public/Darwin/Accelerate/vDSP_Arithmetic.swift

+    /// - Returns: The `c` in `c[i] = a[i] + b`.
+    @inline(__always)
+    @available(iOS 9999, macOS 9999, tvOS 9999, watchOS 9999, *)
+    public static func add<U>(_ scalar: Float,


This is a design point, and I know that this is an Apple framework and not necessarily subject to SE or any community involvement, but I'll posit that lots of developers who could use these functions won't use them because they're hard to discover. vDSP.add(6, myArray) is certainly nicer than the C name vDSP_vsadd but still, if you didn't already know it exists, you'd never find it.

Did you consider putting these functions on AccelerateBuffer directly? Alternatively, namespacing them would also be more discoverable than hanging them off of vDSP as static functions, IMO:

extension AccelerateBuffer { func vectorised() -> vDSP<Self> { return vDSP(data: self) } } struct vDSP<T: AccelerateBuffer> { var data: T } extension vDSP where T.Element == Double { func add(scalar: T.Element) {} } [1.0, 2, 3].vectorised().add(scalar: 6)

Just a thought. I'm happy to see these APIs improve 👍

@karwa We definitely wouldn't want them on AB directly because we don't want every [Float] to pop up ~500 autocomplete suggestions unrelated to what most people are doing (worse, in some editors, the autocomplete suggestions don't take into account conditional conformance, so they'd appear on every Array; that's an editor bug, but we don't need to compound the pain).

Your vDSP wrapping function is plausible, but it's also worth considering that most of these operations do not have a primary source that makes a good LHS. Ultimately, this design was up to the Accelerate team, but I think they struck a reasonable compromise.

swift-ci · 2019-04-26T04:33:28Z

Build failed
Swift Test OS X Platform
Git Sha - 10f301c

@moiseev

* [Accelerate] [Quadrature] New Quadrature Overlay (swiftlang#23127) * [Accelerate] [Quadrature] New Quadrature Overlay A class that simplifies approximating the definite integral of a function. * Fixes in response to PR Review. Change `@_exported import Accelerate` to `import Accelerate`. Correct date in copyright comment. * Code Review Fixes. * Remove mutable integrator, simply set options in init(). * Remove mutable `maxIntervals` and `qagPointsPerInterval`. * Update tests. * Code Review Fixes. * Use standard library `Result`. * Implement `QAGPointsPerInterval` as a struct. * Tidy up Passing Integrand to `quadrature_integrate_function`. Pass the integrand closure directly to the `quadrature_integrate_function` initialiser rather than attaching as a property of the `Quadrature` class. * Make `Quadrature` a struct, and remove requirement for `integrand` to be escaping. * Code Review Changes * Add long-form integrator algorithm aliases (update tests to use these aliases). * Make quadrature error description public. * New tests for error description and `QAGPointsPerInterval`. * Vectorized Integrand for Quadrature Create an alternative implementation of `integrate` that accepts an integrand of type `(_ input: UnsafeBufferPointer<Double>, _ result: UnsafeMutableBufferPointer<Double>)`. * Vectorized Integrand for Quadrature Create an alternative implementation of `integrate` that accepts an integrand of type `(_ input: UnsafeBufferPointer<Double>, _ result: UnsafeMutableBufferPointer<Double>)`. * Vectorized Integrand for Quadrature Remove _ContiguousCollection - it's no longer used. * Delete ContiguousCollection.swift Not required. * Refactor tests. * Accelerate vForce (swiftlang#24152) * [Accelerate] [vForce] New vForce Overlay This PR contains a suite of overlays to the vForce transcendental and trigonometric functions on vectors of any length. The overlays simplify the API to the existing functions and accept collections that implement a new protocol called AccelerateBuffer. Conformances are provided for the most useful stdlib Collections. * Merge pull request swiftlang#24184 from FlexMonkey/Accelerate_Swift-vDSP-Overlays * Fix a case where vDSP is missing a cast (swiftlang#24197) * Add missing cast to new vDSP_FIR overlay. * Use macOS instead of OSX in availability annotations. * Reorder Accelerate/CMakeLists.txt alphabetically. * [Accelerate] [vImage] Swift Overlays (swiftlang#23592) * Accelerate vImage Swift Overlays A suite of functions, enumerations, and option sets to make working with vImage in Swift simpler. * vImage_Buffer - new initializers to instantiate and initialize buffers with a single function call. * vImage_Buffer - new functions to copy buffers and create CGImage instances from contents. * vImage_CGImageFormat - new initializers. * vImage_CGImageFormat - new equivalence operator. * vImageConverter - methods to wrap free functions. * vImageConverter - new make and convert functions. * vImageCVImageFormat - new make functions. * vImageCVImageFormat - methods to wrap free functions. * vImage_Error - errorDescription function. * vImage flags as an option set. * Add new methods for generating CV -> CG and CG -> CV converters. * update comments: `height` and `width` to `size`. * `vImage_CGImageFormat.componentCount` should be `Int`. * `vImage_CGImageFormat.componentCount` should be `Int` * Move `self.init()` to after the size check for kvImageNoAllocate init. * Buffer initializers to width and height rather than size. * change vImage_CGImageFormat lightweight initializer to accept Int for `bitsPerComponent` and `bitsPerPixel`. * Flesh out docs for vImage_Buffer.size * Remove faux initializer in favor of new static function: `preferredAlignmentAndRowBytes`. * Change functions to use proper error handling rather than inout error codes. * Removed `flags` from basic init. The only real flag to pass here is print diagnostics to console, and I now throw proper errors. * Tests to check error throwing for buffer copy. * remove unnecessary import, add missing docs. * Add comments to error enums. * Fix bug creating string from format code. * Make `vImageCVImageFormat.formatCode` a `UInt32`. * Remove equivalence operator from `CGImageFormat`. * [Accelerate] [vDSP] DFT, FFT, DCT, and Biquad (swiftlang#24207) * Swift overlay to vDSP cascaded biquad IIR filter. * update comment in test * Swift overlay to vDSP Discrete Cosine Transform * Swift Overlays to vDSP Fast Fourier Transform and Discrete Fourier Transform * Tests for DFT and FFT * Some refactoring and begin documentation. * Swift overlays to FFT and DFT operations. * Expand docs. * Implement `vDSP_destroy_fftsetup` and `vDSP_destroy_fftsetupD` * Refactor Tests * Refactor Tests * Provide transform function that returns the result. Refactoring: parameter names more consistent with other vDSP operations, push `fileprivate` symbols to bottom of file. * Add apply() function that returns the result. * Added a version of DFT transform that returns the result. * update some DFT comments * Remove FFT overlays from this branch to separate DFT and FFT pull requests. * [Accelerate] [vDSP] Swift Overlays to FFT Operations This PR contains Swift overlays to simplify performing 1D and 2D fast Fourier transforms on single- and double-precision data. This PR includes a subset of the operations (e.g. vDSP_fft_zrop for FFT). My plan is to add the additional operations (e.g. multiple signals, in-place operations, etc.) in a subsequent PR once this is approved. cc: @moiseev @airspeedswift @stephentyrone * Composite Branch Contains FFT, DFT, DCT, and Biquad branches. * Merge pull request swiftlang#24232 from stephentyrone/veclib-enum-availability * Merge pull request swiftlang#24275 from stephentyrone/disable-broken-vImage-test Temporarily disable a new vImage test that's failing for some platforms. * Remove magic-symbols-for-install-name.c from Accelerate CMakeLists.txt This file exists on master but not on 5.1. * Apparently GYB_SOURCES hasn't made it onto 5.1. * Slice should only conform to AB when the Base conforms to AB.

FlexMonkey and others added 7 commits April 25, 2019 09:13

Merge pull request swiftlang#24184 from FlexMonkey/Accelerate_Swift-v…

88b9180

…DSP-Overlays

Fix a case where vDSP is missing a cast (swiftlang#24197)

958b8d6

* Add missing cast to new vDSP_FIR overlay. * Use macOS instead of OSX in availability annotations. * Reorder Accelerate/CMakeLists.txt alphabetically.

Merge pull request swiftlang#24232 from stephentyrone/veclib-enum-ava…

1508934

…ilability

stephentyrone requested a review from airspeedswift April 25, 2019 13:20

airspeedswift approved these changes Apr 25, 2019

View reviewed changes

eeckstein and others added 2 commits April 25, 2019 15:45

Merge pull request swiftlang#24275 from stephentyrone/disable-broken-…

69716ca

…vImage-test Temporarily disable a new vImage test that's failing for some platforms.

Remove magic-symbols-for-install-name.c from Accelerate CMakeLists.txt

10f301c

This file exists on master but not on 5.1.

Apparently GYB_SOURCES hasn't made it onto 5.1.

c6335c9

karwa reviewed Apr 26, 2019

View reviewed changes

stdlib/public/Darwin/Accelerate/AccelerateBuffer.swift Outdated Show resolved Hide resolved

Slice should only conform to AB when the Base conforms to AB.

5c47382

karwa reviewed Apr 26, 2019

View reviewed changes

stephentyrone merged commit 2802df1 into swiftlang:swift-5.1-branch Apr 26, 2019

stephentyrone deleted the accelerate-5.1 branch April 26, 2019 11:49

stephentyrone mentioned this pull request Apr 26, 2019

[5.1-04-24] Accelerate overlay #24312

Merged

[5.1] Collected Accelerate overlay work #24269

[5.1] Collected Accelerate overlay work #24269

Uh oh!

Conversation

stephentyrone commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

swift-ci commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

swift-ci commented Apr 25, 2019

Uh oh!

swift-ci commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

stephentyrone commented Apr 25, 2019

Uh oh!

swift-ci commented Apr 25, 2019

Uh oh!

Uh oh!

stephentyrone commented Apr 26, 2019

Uh oh!

swift-ci commented Apr 26, 2019

Uh oh!

karwa Apr 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephentyrone Apr 26, 2019

Choose a reason for hiding this comment

Uh oh!

swift-ci commented Apr 26, 2019

Uh oh!

Uh oh!

karwa Apr 26, 2019 •

edited

Loading