Add CubicCurve::segment_count + iter_samples adjustment
#8711
Conversation
This file contains 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
Previously, the only way to iterate over an evenly spaced set of points on a CubicCurve was to use one of the iter_* methods. The return value of those methods were bound by &self lifetime, making them unusable in certain contexts. Furthermore, other CubicCurve methods (position, velocity, acceleration) required normalizing `t` over the CubicCurve's internal segment count. There were no way to access this segment count, making those methods pretty much unusable. The newly added `segment_count` allows accessing the segment count. `iter_samples` used to accept a `fn`, a function pointer. This is surprising and contrary to the rust stdlib APIs, which accept `Fn` traits for `Iterator` combinators. `iter_samples` now accepts a `FnMut`.
nicopap
added
C-Performance
alice-i-cecile
approved these changes
May 29, 2023
nicopap
commented
May 29, 2023
aevyrie
approved these changes
May 30, 2023
nicopap
added
the
S-Ready-For-Final-Review
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.
Objective
CubicCurvenon-iter methodsFnMutover afnpointer oniter_samplesbuild_*_cubic_100_pointsbenchmark by -45% (this means they are twice as fast)Solution
Previously, the only way to iterate over an evenly spaced set of points on a
CubicCurvewas to use one of theiter_*methods.The return value of those methods were bound by
&selflifetime, making them unusable in certain contexts.Furthermore, other
CubicCurvemethods (position,velocity,acceleration) required normalizingtover theCubicCurve's internal segment count.There were no way to access this segment count, making those methods pretty much unusable.
The newly added
segment_countallows accessing the segment count.iter_samplesused to accept afn, a function pointer. This is surprising and contrary to the rust stdlib APIs, which acceptFntraits forIteratorcombinators.iter_samplesnow accepts aFnMut.I don't trust a bit the bevy benchmark suit, but according to it, this doubles (-45%) the performance on the
build_pos_cubic_100_pointsandbuild_accel_cubic_100_pointsbenchmarks.Changelog
CubicCurve::segmentsmethod to access the underlying segments of a cubic curveCubicCurve::iter_samplessample_functionargument.