- Restructure the project README, moving the list of guides into a
README in the `Guides` directory
- Curate the `keyed(by:)` and `grouped(by:)` methods
* Add Grouped and Keyed
* Add `Key` to `combine` closure
* Split `keyed(by:)` into two overloads
* Rename uniquingKeysWith → resolvingConflictsWith
* Keep latest instead of throwing on collision
* Finish sub-page documentation updates
Some of these pages could use introductions, but the current state is
ready for publication.
* Add SPI yaml file for building docs
The latest Swift versions appear to have a problem with the
LinuxMain.swift again, which we haven't needed for quite some time.
Linux test autodiscovery has been enabled since 5.4, so we can
update to that version and drop the file.
* Clarify that the determining factor for being grouped is equality (`Equatable`), which doesn’t necessarily mean the _same_ value (identity)
* Correct algorithmic complexity documentation on the lazy Chunked functions
* Document `belongInSameGroup` and `projection`
This change improves the documentation for `evenlyChunked(in:)` and
`chunks(ofCount:)` and renames `EvenChunksCollection` to
`EvenlyChunkedCollection` to follow the pattern of wrapper type
names matching their producing functions.
Adds `evenlyChunked(in:)` as a `Collection` method that divides a
collection into a specific number of chunks as evenly as possible.
Co-authored-by: Tim Vermeulen <tvermeulen@apple.com>
* Use back ticks around code references
* Add missing spaces before parenthesis
* Use “passed” instead of “past”
Add missing comma
Add back ticks around code references
Add missing space before parenthesis
* Consistently use spaces around `%` operator
Co-authored-by: Matt Zanchelli <mattt@apple.com>
This could result in fewer comparisons.
Additionally, it ensures that the insertion index is valid for insertion. The `removeLast()` documentation states:
> Calling this method may invalidate all saved indices of this collection. Do not rely on a previously stored index value after altering a collection with any operation that can change its length.
* Add `partitioned(_:)`
`partitioned(_:)` works like `filter(_:)`, but also returns the excluded elements by returning a tuple of two `Array`s
* For collections with fewer than 8 elements, use the `Sequence`-based implementation
This constant was determined using benchmarking. More information: https://github.com/apple/swift-algorithms/pull/152#issuecomment-887130149
* Remove check for collections fewer than 8 elements
* Make `_partitioned` `internal`
* Prefer `Array` over `ContiguousArray`
* Document `partitioned(_:)` on `Collection`
* Remove `partitioned(upTo:)`
* Remove `_tupleMap`
* Remove `_partitioned` and use it inline (since it’s no longer used by the `Collection` implementation
* Remove unnecessary conversation of `Array` to `Array`
* Correct indentation
Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>
* Consistent syntax
Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>
* Add an external `by:` label to `partitioned`
* Add labels to returned tuple `falseElements`, `trueElements`
* Correct function signature
* Rename `belongsInSecondCollection` parameter name to simply `predicate`
The parameter name was potentially confusing. Unlike the other `partition` functions, this function can rely on its named tuple to clarify its behavior.
* Update copyright information
Co-authored-by: Nate Cook <natecook@apple.com>
* Update documentation
Co-authored-by: Nate Cook <natecook@apple.com>
* Update comment
* Add a precondition to ensure that the count matches up with the number of actual elements found while iterating
Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>
Co-authored-by: Nate Cook <natecook@apple.com>
* Rename types to include a Sequence or Collection suffix, and clean up some guides
* Various refactors
* Replace `validateIndexTraversals` test method with `IndexValidator` type
* Add LazySequenceProtocol to StridingSequence, StridingCollection
* Update the Numerics dependency to 1.0
* Set `IndexedCollection.Indices` to `Base.Indices`
* Remove deprecations
* Update the changelog/README for the 1.0.0 release
* Fix compiler error on Linux
* Rename `WindowsCollection` to `WindowsOfCountCollection`
The RealModule _library product_ will be removed from Numerics at some future point (the _module_ will continue to exist). Update Package.swift to depend on the Numerics library instead.
Benchmarks on Xcode 12.4 showed compiling / type checking
StrideCollection.offsetBackward was the bottleneck for building
the package. Replacing the ternary operator in that function
with an explicit if/else removes the bottleneck.
* Add function to find MIN and MAX in one pass
Add a method extending sequences that finds both the minimal and maximal elements of the receiver in a single pass, based off a given ordering predicate. Add an overload that defaults the comparison predicate to the standard less-than operator.