Documentation

ole · ole · commit a6b440f51b8d · 2017-03-18T12:54:44.000+01:00
diff --git a/Sources/SortedArray.swift b/Sources/SortedArray.swift
@@ -98,6 +98,8 @@ extension SortedArray: RandomAccessCollection {
         return _elements[position]
     }
 
+    /// Like `Sequence.filter(_:)`, but returns a `SortedArray` instead of an `Array`.
+    /// We can do this efficiently because filtering doesn't change the sort order.
     public func filter(_ isIncluded: (Element) throws -> Bool) rethrows -> SortedArray<Element> {
         let newElements = try _elements.filter(isIncluded)
         return SortedArray(sorted: newElements, areInIncreasingOrder: areInIncreasingOrder)

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,8 @@ extension SortedArray: RandomAccessCollection {`
`98`	`98`	`return _elements[position]`
`99`	`99`	`}`
`100`	`100`
	`101`	+ /// Like `Sequence.filter(_:)`, but returns a `SortedArray` instead of an `Array`.
	`102`	`+ /// We can do this efficiently because filtering doesn't change the sort order.`
`101`	`103`	`public func filter(_ isIncluded: (Element) throws -> Bool) rethrows -> SortedArray<Element> {`
`102`	`104`	`let newElements = try _elements.filter(isIncluded)`
`103`	`105`	`return SortedArray(sorted: newElements, areInIncreasingOrder: areInIncreasingOrder)`