You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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`
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/BUG_REPORT.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ about: Something isn't working as expected
16
16
17
17
Replace this paragraph with a short description of the incorrect incorrect behavior. If this is a regression, please note the last version that the behavior was correct in addition to your current version.
18
18
19
-
**Swift Algorithms version:**`0.0.1` or the `main` branch, for example.
19
+
**Swift Algorithms version:**`1.0.0` or the `main` branch, for example.
20
20
**Swift version:** Paste the output of `swift --version` here.
Copy file name to clipboardExpand all lines: Guides/AdjacentPairs.md
+22-11
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@
5
5
6
6
Lazily iterates over tuples of adjacent elements.
7
7
8
-
This operation is available for any sequence by calling the `adjacentPairs()` method.
8
+
This operation is available for any sequence by calling the `adjacentPairs()`
9
+
method.
9
10
10
11
```swift
11
12
let numbers = (1...5)
@@ -15,38 +16,48 @@ let pairs = numbers.adjacentPairs()
15
16
16
17
## Detailed Design
17
18
18
-
The `adjacentPairs()` method is declared as a `Sequence` extension returning `AdjacentPairsSequence` and as a `Collection` extension returning `AdjacentPairsCollection`.
19
+
The `adjacentPairs()` method is declared as a `Sequence` extension returning
20
+
`AdjacentPairsSequence` and as a `Collection` extension returning
The `AdjacentPairsSequence` type is a sequence, and the `AdjacentPairsCollection` type is a collection with conditional conformance to `BidirectionalCollection` and `RandomAccessCollection` when the underlying collection conforms.
35
+
The `AdjacentPairsSequence` type is a sequence, and the
36
+
`AdjacentPairsCollection` type is a collection with conditional conformance to
37
+
`BidirectionalCollection` and `RandomAccessCollection` when the underlying
38
+
collection conforms.
33
39
34
40
### Complexity
35
41
36
42
Calling `adjacentPairs` is an O(1) operation.
37
43
38
44
### Naming
39
45
40
-
This method is named for clarity while remaining agnostic to any particular domain of programming. In natural language processing, this operation is akin to computing a list of bigrams; however, this algorithm is not specific to this use case.
This method is named for clarity while remaining agnostic to any particular
47
+
domain of programming. In natural language processing, this operation is akin to
48
+
computing a list of bigrams; however, this algorithm is not specific to this use
49
+
case.
43
50
44
51
### Comparison with other languages
45
52
46
-
This function is often written as a `zip` of a sequence together with itself, minus its first element.
53
+
This function is often written as a `zip` of a sequence together with itself,
54
+
minus its first element.
47
55
48
56
**Haskell:** This operation is spelled ``s `zip` tail s``.
49
57
50
-
**Python:** Python users may write `zip(s, s[1:])` for a list with at least one element. For natural language processing, the `nltk` package offers a `bigrams` function akin to this method.
58
+
**Python:** Python users may write `zip(s, s[1:])` for a list with at least one
59
+
element. For natural language processing, the `nltk` package offers a `bigrams`
60
+
function akin to this method.
51
61
52
-
Note that in Swift, the spelling `zip(s, s.dropFirst())` is undefined behavior for a single-pass sequence `s`.
62
+
Note that in Swift, the spelling `zip(s, s.dropFirst())` is undefined behavior
The `ChunkedBy` and `ChunkedOn` types are bidirectional when the wrapped collection is
90
-
bidirectional.
92
+
The `ChunkedByCollection`, `ChunkedOnCollection`, and `ChunksOfCountCollection`
93
+
types are bidirectional when the wrapped collection is bidirectional.
94
+
`ChunksOfCountCollection` also conforms to `LazySequenceProtocol` when the base
95
+
collection conforms.
91
96
92
97
### Complexity
93
98
94
99
The eager methods are O(_n_), the lazy methods are O(_1_).
95
100
96
101
### Naming
97
102
98
-
The operation performed by these methods is similar to other ways of breaking a collection up into subsequences. In particular, the predicate-based `split(where:)` method looks similar to `chunked(on:)`. You can draw a distinction between these different operations based on the resulting subsequences:
99
-
100
-
-`split`: *In the standard library.* Breaks a collection into subsequences, removing any elements that are considered "separators". The original collection cannot be recovered from the result of splitting.
101
-
-`chunked`: *In this package.* Breaks a collection into subsequences, preserving each element in its initial ordering. Joining the resulting subsequences re-forms the original collection.
102
-
-`sliced`: *Not included in this package or the stdlib.* Breaks a collection into potentially overlapping subsequences.
103
-
103
+
The operation performed by these methods is similar to other ways of breaking a
104
+
collection up into subsequences. In particular, the predicate-based
105
+
`split(where:)` method looks similar to `chunked(on:)`. You can draw a
106
+
distinction between these different operations based on the resulting
107
+
subsequences:
108
+
109
+
-`split`: *In the standard library.* Breaks a collection into subsequences,
110
+
removing any elements that are considered "separators". The original collection
111
+
cannot be recovered from the result of splitting.
112
+
-`chunked`: *In this package.* Breaks a collection into subsequences,
113
+
preserving each element in its initial ordering. Joining the resulting
114
+
subsequences re-forms the original collection.
115
+
-`sliced`: *Not included in this package or the stdlib.* Breaks a collection
0 commit comments