Performance improvements for Calendar.RecurrenceRule
#981
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
itingliu
reviewed
Oct 16, 2024
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
|
The benchmark improvements are exciting |
itingliu
reviewed
Oct 18, 2024
Sources/FoundationEssentials/Calendar/Calendar_Recurrence.swift
Outdated
Show resolved
Hide resolved
|
@swift-ci please test |
hristost
force-pushed
the
hs/recurrence-rule-faster-enumeration
branch
2 times, most recently
from
4bf3d71 to
afc2c56
Compare
|
@swift-ci please test |
hristost
commented
Oct 21, 2024
| @@ -54,7 +54,7 @@ let benchmarks = { | |||
| } | |||
|
|
|||
| // Only available in Swift 6 for non-Darwin platforms, macOS 15 for Darwin | |||
| #if swift(>=6.0) | |||
There was a problem hiding this comment.
We don't need Swift 6 mode to run the benchmarks, just a Swift 6 compiler
| @@ -511,14 +512,8 @@ extension Calendar { | |||
| matchingPolicy: MatchingPolicy, | |||
| repeatedTimePolicy: RepeatedTimePolicy, | |||
| direction: SearchDirection, | |||
| inSearchingDate: Date, | |||
| inSearchingDate searchingDate: Date, | |||
There was a problem hiding this comment.
This function gets split into two, with the latter _adjustDates being exposed for recurrence enumeration.
| @@ -1393,7 +1405,7 @@ extension Calendar { | |||
| } | |||
| } | |||
|
|
|||
| private func dateAfterMatchingEra(startingAt startDate: Date, components: DateComponents, direction: SearchDirection, matchedEra: inout Bool) -> Date? { | |||
| internal func dateAfterMatchingEra(startingAt startDate: Date, components: DateComponents, direction: SearchDirection, matchedEra: inout Bool) -> Date? { | |||
There was a problem hiding this comment.
Some dateAfterMatching* functions are exposed for recurrence enumeration as well.
|
We also need the perf results for the other calendar enumeration tests, to make sure those haven't regressed. |
The original implementation of `Calendar.RecurrenceRule` expanded recurrences of dates using the Calendar APIs for matching date components. This would result in multiple sequences for matching date components even when just a single sequence would have sufficed, thus requiring more time and memory to complete enumeration E.g: finding the dates for Thanksgivings (fourth Thursday of each November) took ~4 times as much time using RecurrenceRule when compared to simply matching date components. This commit optimizes how we expand dates for recurrences. Instead of creating a sequence for each value of each component in the recurrence rule, we introduce a new type of sequence closely resembling Calendar.DatesByMatching, but which also allows multiple values per date component.
I just reran all of the Calendar benchmarks, results below. There are a few small regressions that seem to be due to measuring tolerances, e.g. Benchmark baseline comparison |
hristost
force-pushed
the
hs/recurrence-rule-faster-enumeration
branch
from
71ff275 to
084549f
Compare
|
@swift-ci please run |
|
@swift-ci please test |
1 similar comment
|
@swift-ci please test |
itingliu
approved these changes
Oct 21, 2024
cthielen
pushed a commit
to cthielen/swift-foundation
that referenced
this pull request
Nov 8, 2024
The original implementation of `Calendar.RecurrenceRule` expanded recurrences of dates using the Calendar APIs for matching date components. This would result in multiple sequences for matching date components even when just a single sequence would have sufficed, thus requiring more time and memory to complete enumeration E.g: finding the dates for Thanksgivings (fourth Thursday of each November) took ~4 times as much time using RecurrenceRule when compared to simply matching date components. This commit optimizes how we expand dates for recurrences. Instead of creating a sequence for each value of each component in the recurrence rule, we introduce a new type of sequence closely resembling Calendar.DatesByMatching, but which also allows multiple values per date component.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original implementation of
Calendar.RecurrenceRuleexpanded recurrences ofdates using the Calendar APIs for matching date components. This would result in
multiple sequences for matching date components even when just a single sequence
would have sufficed, thus requiring more time and memory to complete enumeration
E.g: finding the dates for Thanksgivings (fourth Thursday of each November) took
~4 times as much time using RecurrenceRule when compared to simply matching date
components.
This commit optimizes how we expand dates for recurrences. Instead of creating a
sequence for each value of each component in the recurrence rule, we introduce a
new type of sequence closely resembling Calendar.DatesByMatching, but which also
allows multiple values per date component.
Addresses #555
Preliminary benchmarks