---

yaml
---
r: 283903
b: refs/heads/master-next
c: f454132
h: refs/heads/master
i:
  283901: 1cd860c
  283899: a0b27ec
  283895: 94d9eb9
  283887: 8db9aef
  283871: 1b8250d
  283839: 7dff0f2
  283775: 32eac47
  283647: 629dc2e

Author: FlexMonkey

[refs]

@@ -1,6 +1,6 @@
 ---
 refs/heads/master: 913a1f57faca996135623c287c09060d8d0532ec
-refs/heads/master-next: f1e98b61477a26c77653d4dd71f6ec8a49aaef4b
+refs/heads/master-next: f454132641befffb61024b442294eb2cb85609b8
 refs/tags/osx-passed: b6b74147ef8a386f532cf9357a1bde006e552c54
 refs/tags/swift-2.2-SNAPSHOT-2015-12-01-a: 6bb18e013c2284f2b45f5f84f2df2887dc0f7dea
 refs/tags/swift-2.2-SNAPSHOT-2015-12-01-b: 66d897bfcf64a82cb9a87f5e663d889189d06d07

branches/master-next/stdlib/public/Darwin/Accelerate/vDSP_ClippingLimitThreshold.swift

@@ -141,6 +141,19 @@ extension vDSP {
     /// - Parameter vector: Source vector.
     /// - Parameter bounds: Clipping threshold.
     /// - Returns: The clipped result.
+    ///
+    /// This function performs the following operation where `A` is `vector`, `B` is `bounds.lowerBound`,
+    /// `C` is `bounds.upperBound`, and `D` is the inverted clip result:
+    /// ```
+    /// for (int n = 0; n < N; ++n) {
+    ///     if (A[n] <= *B || A[n] >= *C)
+    ///         D[n] = A[n];
+    ///     else if (A[n] < 0)
+    ///         D[n] = *B;
+    ///     else
+    ///         D[n] = *C;
+    /// }
+    /// ```
     @inline(__always)
     @available(iOS 9999, OSX 9999, tvOS 9999, watchOS 9999, *)
     public static func invertedClip<U>(_ vector: U,
@@ -167,6 +180,19 @@ extension vDSP {
     /// - Parameter vector: Source vector.
     /// - Parameter bounds: Clipping threshold.
     /// - Parameter result: The clipped result.
+    ///
+    /// This function performs the following operation where `A` is `vector`, `B` is `bounds.lowerBound`,
+    /// `C` is `bounds.upperBound`, and `D` is the inverted clip result:
+    /// ```
+    /// for (int n = 0; n < N; ++n) {
+    ///     if (A[n] <= *B || A[n] >= *C)
+    ///         D[n] = A[n];
+    ///     else if (A[n] < 0)
+    ///         D[n] = *B;
+    ///     else
+    ///         D[n] = *C;
+    /// }
+    /// ```
     @inline(__always)
     @available(iOS 9999, OSX 9999, tvOS 9999, watchOS 9999, *)
     public static func invertedClip<U, V>(_ vector: U,
@@ -200,6 +226,19 @@ extension vDSP {
     /// - Parameter vector: Source vector.
     /// - Parameter bounds: Clipping threshold.
     /// - Returns: The clipped result.
+    ///
+    /// This function performs the following operation where `A` is `vector`, `B` is `bounds.lowerBound`,
+    /// `C` is `bounds.upperBound`, and `D` is the inverted clip result:
+    /// ```
+    /// for (int n = 0; n < N; ++n) {
+    ///     if (A[n] <= *B || A[n] >= *C)
+    ///         D[n] = A[n];
+    ///     else if (A[n] < 0)
+    ///         D[n] = *B;
+    ///     else
+    ///         D[n] = *C;
+    /// }
+    /// ```
     @inline(__always)
     @available(iOS 9999, OSX 9999, tvOS 9999, watchOS 9999, *)
     public static func invertedClip<U>(_ vector: U,
@@ -226,6 +265,19 @@ extension vDSP {
     /// - Parameter vector: Source vector.
     /// - Parameter bounds: Clipping threshold.
     /// - Parameter result: The clipped result.
+    ///
+    /// This function performs the following operation where `A` is `vector`, `B` is `bounds.lowerBound`,
+    /// `C` is `bounds.upperBound`, and `D` is the inverted clip result:
+    /// ```
+    /// for (int n = 0; n < N; ++n) {
+    ///     if (A[n] <= *B || A[n] >= *C)
+    ///         D[n] = A[n];
+    ///     else if (A[n] < 0)
+    ///         D[n] = *B;
+    ///     else
+    ///         D[n] = *C;
+    /// }
+    /// ```
     @inline(__always)
     @available(iOS 9999, OSX 9999, tvOS 9999, watchOS 9999, *)
     public static func invertedClip<U, V>(_ vector: U,