[Compacted] Adding `compacted()` method to remove all nils in a sequence or collection by LucianoPAlmeida · Pull Request #112 · apple/swift-algorithms

LucianoPAlmeida · 2021-03-24T02:03:50Z

Fixes #107

From the sketch from @kylemacomber on the issue, this just complement the implementation adding the tests and docs.
Let me know what you think =]

cc @kylemacomber @natecook1000 @timvermeulen

Replace this paragraph with a description of your changes and rationale. Provide links to an existing issue or external references/discussions, if appropriate.

Checklist

I've added at least one test that validates that my change is working, if appropriate
I've followed the code style of the rest of the project
I've read the Contribution Guidelines
I've updated the documentation if necessary

natecook1000

Thanks for taking this one on, @LucianoPAlmeida! 👏 A few notes below about indexes and conformances.

LucianoPAlmeida · 2021-03-30T21:37:43Z

@natecook1000 @kylemacomber Thank you for the review :)

natecook1000

Looking good, @LucianoPAlmeida! Some more notes for you below, then I think we just need docs on the methods themselves.

…ce as convenience for .compactMap { $0 }

LucianoPAlmeida · 2021-03-31T12:38:56Z

@natecook1000 Thanks again and sorry for those mistakes, I think all things were addressed =]

LucianoPAlmeida · 2021-03-31T12:39:15Z

@swift-ci Please test

natecook1000

Almost there! Just a couple notes left.

natecook1000 · 2021-03-31T15:28:32Z

+extension CompactedCollection: RandomAccessCollection
+  where Base: RandomAccessCollection {}


I missed this — because we don't know how far apart the non-nil elements are until we iterate, we can't make CompactedCollection conform to RandomAccessCollection.

Makes sense :)

natecook1000 · 2021-03-31T15:31:05Z

+
+  func testCollectionTraversals() {
+    for array in self.tests {
+      validateIndexTraversals(array)


Looks like we need to call compacted() here.

Sorry for that

natecook1000 · 2021-03-31T15:34:18Z

+  func testCollectionEquatableConformances() {
+    for array in self.tests {
+      XCTAssertEqual(
+        array.eraseToAnyHashableSequence().compacted(),
+        array.compactMap({ $0 }).eraseToAnyHashableSequence().compacted()
+      )
+      XCTAssertEqual(
+        array.compacted(), array.compactMap({ $0 }).compacted()
+      )
+    }
+  }
+
+  func testCollectionHashableConformances() {
+    for array in self.tests {
+      let seq = array.eraseToAnyHashableSequence()
+      XCTAssertEqualHashValue(
+        seq.compacted(), seq.compactMap({ $0 }).compacted()
+      )
+      XCTAssertEqualHashValue(
+        array.compacted(), array.compactMap({ $0 }).compacted()
+      )
+    }
+  }


For these two tests it would be great to make sure that equality and hashing work for non-equal base sequences/collections that are equal when compacted. E.g. [1, 2, 3, nil, nil, 4].compacted() == [1, nil, 2, nil, 3, 4].compacted(). You're covering the correctness of compacting already, so I don't think you need to do the comparison with compactMap { $0 } any more.

Adjusted :)

timvermeulen · 2021-04-01T18:46:32Z

+
+  @inlinable
+  public func index(after i: Index) -> Index {
+    precondition(i < endIndex, "Index out of bounds")


Suggested change

precondition(i < endIndex, "Index out of bounds")

precondition(i != endIndex, "Index out of bounds")

We try to compare indices using != wherever possible to be consistent with the stdlib, also see #65 (comment)

Ah ok, thanks

natecook1000 · 2021-04-02T19:12:36Z

@swift-ci Please test

LucianoPAlmeida · 2021-04-05T11:16:15Z

@swift-ci Please test

natecook1000 · 2021-04-05T14:52:41Z

LucianoPAlmeida force-pushed the compact branch 2 times, most recently from 2d63197 to b50ed7e Compare March 24, 2021 03:44

kylemacomber mentioned this pull request Mar 24, 2021

Make uniqued() lazy by default #71

Merged

4 tasks

LucianoPAlmeida force-pushed the compact branch from b50ed7e to f9da719 Compare March 27, 2021 01:05

natecook1000 reviewed Mar 30, 2021

View reviewed changes

kylemacomber reviewed Mar 30, 2021

View reviewed changes

Comment thread Tests/SwiftAlgorithmsTests/CompactedTests.swift Outdated

timvermeulen reviewed Mar 30, 2021

View reviewed changes

Comment thread Sources/Algorithms/Compacted.swift Outdated

LucianoPAlmeida force-pushed the compact branch 6 times, most recently from f7d73f7 to e446d44 Compare March 30, 2021 22:51

LucianoPAlmeida requested review from kylemacomber, natecook1000 and timvermeulen March 30, 2021 22:56

natecook1000 reviewed Mar 31, 2021

View reviewed changes

LucianoPAlmeida force-pushed the compact branch from ff8b573 to d6bf57d Compare March 31, 2021 12:08

LucianoPAlmeida added 2 commits March 31, 2021 09:24

[Compacted] Implementation of CompactedCollection and CompactedSequen…

d0d9ed5

…ce as convenience for .compactMap { $0 }

[tests] [Compacted] Adding tests for compacted()

05491db

LucianoPAlmeida force-pushed the compact branch from 89692d8 to db76f21 Compare March 31, 2021 12:26

[gardening] Adding Guides to compacted()

abe4890

LucianoPAlmeida force-pushed the compact branch from db76f21 to abe4890 Compare March 31, 2021 12:36

LucianoPAlmeida requested a review from natecook1000 March 31, 2021 12:39

natecook1000 reviewed Mar 31, 2021

View reviewed changes

LucianoPAlmeida force-pushed the compact branch from d301172 to 44ee039 Compare March 31, 2021 17:54

LucianoPAlmeida requested a review from natecook1000 March 31, 2021 17:56

LucianoPAlmeida force-pushed the compact branch 3 times, most recently from 6aebc1f to 3db1df0 Compare March 31, 2021 21:30

timvermeulen reviewed Apr 1, 2021

View reviewed changes

Comment thread Sources/Algorithms/Compacted.swift Outdated

[CodeReview] Making the corrections

a42bc53

LucianoPAlmeida force-pushed the compact branch from 3db1df0 to a42bc53 Compare April 1, 2021 21:24

LucianoPAlmeida requested a review from timvermeulen April 1, 2021 21:25

Fix typo

d64dd16

natecook1000 merged commit 198eee0 into apple:main Apr 5, 2021

		extension CompactedCollection: RandomAccessCollection
		where Base: RandomAccessCollection {}

	precondition(i < endIndex, "Index out of bounds")
	precondition(i != endIndex, "Index out of bounds")

Conversation

LucianoPAlmeida commented Mar 24, 2021

Checklist

Uh oh!

natecook1000 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LucianoPAlmeida commented Mar 30, 2021

Uh oh!

Uh oh!

natecook1000 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LucianoPAlmeida commented Mar 31, 2021

Uh oh!

LucianoPAlmeida commented Mar 31, 2021

Uh oh!

natecook1000 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natecook1000 commented Apr 2, 2021

Uh oh!

LucianoPAlmeida commented Apr 5, 2021

Uh oh!

natecook1000 commented Apr 5, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants