Update changelog for 0.0.4 release (#120)

CHANGELOG.md

@@ -16,6 +16,33 @@ package updates, you can specify your package dependency using
 
 ---
 
+## [0.0.4] - 2021-03-29
+
+### Additions
+
+More new algorithms to join the party:
+
+- A lazy version of the standard library's two `split` methods. ([#78])
+- `firstNonNil(_:)` returns the first non-`nil` element from an
+  optional-generating transform. ([#31])
+- `uniquePermutations()` skips duplicates when generating permutations of a
+  collection. ([#91])
+- The `reductions` methods return all the in-between states of reducing a
+  sequence or collection. ([#46])
+
+### Fixes
+
+- Methods and computed properties are more consistently marked as inlinable, 
+  resolving a performance regression. 
+- The `Stride` type now efficiently calculates distances between positions,
+  supported by the underlying collection.
+- Better test coverage and improved diagnostics for comparing sequences.
+- Fixed links and improved documentation.
+
+The 0.0.4 release includes contributions from [bjhomer], [danielctull],
+[hashemi], [karwa], [kylemacomber], [LucianoPAlmeida], [mdznr], [natecook1000],
+[ollieatkinson], [Qata], [timvermeulen], and [toddthomas]. Thank you!
+
 ## [0.0.3] - 2021-02-26
 
 ### Additions
@@ -96,7 +123,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 
 <!-- Link references for releases -->
 
-[Unreleased]: https://github.com/apple/swift-algorithms/compare/0.0.3...HEAD
+[Unreleased]: https://github.com/apple/swift-algorithms/compare/0.0.4...HEAD
+[0.0.4]: https://github.com/apple/swift-algorithms/compare/0.0.3...0.0.4
 [0.0.3]: https://github.com/apple/swift-algorithms/compare/0.0.2...0.0.3
 [0.0.2]: https://github.com/apple/swift-algorithms/compare/0.0.1...0.0.2
 [0.0.1]: https://github.com/apple/swift-algorithms/releases/tag/0.0.1
@@ -107,20 +135,26 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [#9]: https://github.com/apple/swift-algorithms/pull/9
 [#20]: https://github.com/apple/swift-algorithms/pull/20
 [#24]: https://github.com/apple/swift-algorithms/pull/24
+[#31]: https://github.com/apple/swift-algorithms/pull/31
 [#35]: https://github.com/apple/swift-algorithms/pull/35
+[#46]: https://github.com/apple/swift-algorithms/pull/46
 [#51]: https://github.com/apple/swift-algorithms/pull/51
 [#54]: https://github.com/apple/swift-algorithms/pull/54
 [#56]: https://github.com/apple/swift-algorithms/pull/56
 [#65]: https://github.com/apple/swift-algorithms/pull/65
 [#77]: https://github.com/apple/swift-algorithms/pull/77
+[#78]: https://github.com/apple/swift-algorithms/pull/78
+[#91]: https://github.com/apple/swift-algorithms/pull/91
 
 <!-- Link references for contributors -->
 
 [AustinConlon]: https://github.com/apple/swift-algorithms/commits?author=AustinConlon
 [benrimmington]: https://github.com/apple/swift-algorithms/commits?author=benrimmington
+[bjhomer]: https://github.com/apple/swift-algorithms/commits?author=bjhomer
 [danielctull]: https://github.com/apple/swift-algorithms/commits?author=danielctull
 [dhruvshah8]: https://github.com/apple/swift-algorithms/commits?author=dhruvshah8
 [egorzhdan]: https://github.com/apple/swift-algorithms/commits?author=egorzhdan
+[hashemi]: https://github.com/apple/swift-algorithms/commits?author=hashemi
 [IanKeen]: https://github.com/apple/swift-algorithms/commits?author=IanKeen
 [iSame7]: https://github.com/apple/swift-algorithms/commits?author=iSame7
 [karwa]: https://github.com/apple/swift-algorithms/commits?author=karwa
@@ -133,10 +167,12 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [nordicio]: https://github.com/apple/swift-algorithms/commits?author=nordicio
 [ollieatkinson]: https://github.com/apple/swift-algorithms/commits?author=ollieatkinson
 [pmtao]: https://github.com/apple/swift-algorithms/commits?author=pmtao
+[Qata]: https://github.com/apple/swift-algorithms/commits?author=Qata
 [rakaramos]: https://github.com/apple/swift-algorithms/commits?author=rakaramos
 [rockbruno]: https://github.com/apple/swift-algorithms/commits?author=rockbruno
 [Roshankumar350]: https://github.com/apple/swift-algorithms/commits?author=Roshankumar350
 [schlagelk]: https://github.com/apple/swift-algorithms/commits?author=schlagelk
 [sidepelican]: https://github.com/apple/swift-algorithms/commits?author=sidepelican
 [stephentyrone]: https://github.com/apple/swift-algorithms/commits?author=stephentyrone
 [timvermeulen]: https://github.com/apple/swift-algorithms/commits?author=timvermeulen
+[toddthomas]: https://github.com/apple/swift-algorithms/commits?author=toddthomas

Guides/Reductions.md

@@ -3,9 +3,7 @@
 [[Source](https://github.com/apple/swift-algorithms/blob/main/Sources/Algorithms/Reductions.swift) |
  [Tests](https://github.com/apple/swift-algorithms/blob/main/Tests/SwiftAlgorithmsTests/ReductionsTests.swift)]
 
-Produces a sequence of values.
-
-This has the behaviour of reduce, but also returns all intermediate results.
+Produces all the intermediate results of reducing a sequence's elements using a closure.
 
 ```swift
 let exclusiveRunningTotal = (1...5).reductions(0, +)

README.md

@@ -27,7 +27,9 @@ Read more about the package, and the intent behind it, in the [announcement on s
 
 - [`randomSample(count:)`, `randomSample(count:using:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/RandomSampling.md): Randomly selects a specific number of elements from a collection.
 - [`randomStableSample(count:)`, `randomStableSample(count:using:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/RandomSampling.md): Randomly selects a specific number of elements from a collection, preserving their original relative order.
+- [`striding(by:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Stride.md): Returns every nth element of a collection.
 - [`suffix(while:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Suffix.md): Returns the suffix of a collection where all element pass a given predicate.
+- [`trimming(while:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Trim.md): Returns a slice by trimming elements from a collection's start and end.
 - [`uniqued()`, `uniqued(on:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Unique.md): The unique elements of a collection, preserving their order.
 
 #### Partial sorting
@@ -37,12 +39,12 @@ Read more about the package, and the intent behind it, in the [announcement on s
 #### Other useful operations
 
 - [`chunked(by:)`, `chunked(on:)`, `chunks(ofCount:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Chunked.md): Eager and lazy operations that break a collection into chunks based on either a binary predicate or when the result of a projection changes or chunks of a given count.
+- [`firstNonNil(_:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/FirstNonNil.md): Returns the first non-`nil` result from transforming a sequence's elements.
 - [`indexed()`](https://github.com/apple/swift-algorithms/blob/main/Guides/Indexed.md): Iterate over tuples of a collection's indices and elements. 
 - [`interspersed(with:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Intersperse.md): Place a value between every two elements of a sequence.
-- [`trimming(while:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Trim.md): Returns a slice by trimming elements from a collection's start and end.
-- [`windows(ofCount:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Windows.md): Breaks a collection into overlapping subsequences where elements are slices from the original collection.
-- [`striding(by:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Stride.md): Returns every nth element of a collection.
+- [`reductions(_:)`, `reductions(_:_:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Reductions.md): Returns all the intermediate states of reducing the elements of a sequence or collection.
 - [`split(maxSplits:omittingEmptySubsequences:whereSeparator)`, `split(separator:maxSplits:omittingEmptySubsequences)`](https://github.com/apple/swift-algorithms/blob/main/Guides/LazySplit.md): Lazy versions of the Standard Library's eager operations that split sequences and collections into subsequences separated by the specified separator element.
+- [`windows(ofCount:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Windows.md): Breaks a collection into overlapping subsequences where elements are slices from the original collection.
 
 ## Adding Swift Algorithms as a Dependency