Add Performance::NumericPredicate cop#440
Open
miry wants to merge 1 commit intorubocop:masterfrom
Open
Conversation
aff4286 to
7bdfdef
Compare
Performance::NumericPredicate cop identifies places where numeric uses predicates like
`positive?`, `negative?` and for some cases `zero?` should be converted to compare operator.
The `Performance::NumericPredicate` cop is added to identify instances where numeric predicates
such as `positive?`, `negative?`, and occasionally `zero?` should be replaced
with comparison operators for improved efficiency.
Predicates incur a performance overhead by executing a method before comparison.
A small benchmark comparison between using a comparison operator (`> 0`) and `positive?` illustrates the performance difference:
```ruby
x.report("compare with 0") { arr.each {|i| i > 0 } }
x.report("positive?") { arr.each {|i| i.positive? } }
```
Benchmark results on Ruby 3.3.0 (with YJIT) indicate a significant performance gain when using the comparison operator:
```
ruby 3.3.0 (2023-12-25 revision 5124f9ac75) +YJIT [arm64-darwin23]
Warming up --------------------------------------
compare with 0 1.000 i/100ms
positive? 1.000 i/100ms
Calculating -------------------------------------
compare with 0 3.153 (± 0.0%) i/s - 95.000 in 30.132600s
positive? 2.397 (± 0.0%) i/s - 72.000 in 30.042688s
Comparison:
compare with 0: 3.2 i/s
positive?: 2.4 i/s - 1.32x slower
```
This cop is unsafe because it cannot be guaranteed that the receiver is Number and could be noisy.
Signed-off-by: Michael Nikitochkin <michael.nikitochkin@gmx.net>
7bdfdef to
795f7cc
Compare
bdewater
reviewed
Sep 13, 2024
| REPLACEMENTS = { negative?: '<', positive?: '>', zero?: '==' }.freeze | ||
|
|
||
| def_node_matcher :num_predicate?, <<~PATTERN | ||
| (send $numeric_type? ${:negative? :positive? :zero?}) |
Contributor
|
This is just |
Author
|
@Earlopain Are there any established practices for handling conflicts between rubocop cops and performance cops? |
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
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.
Performance::NumericPredicate cop identifies places where numeric uses predicates like
positive?,negative?and for some caseszero?should be converted to compare operator.The
Performance::NumericPredicatecop is added to identify instances where numeric predicates such aspositive?,negative?, and occasionallyzero?should be replaced with comparison operators for improved efficiency.Predicates incur a performance overhead by executing a method before comparison. A small benchmark comparison between using a comparison operator (
> 0) andpositive?illustrates the performance difference:Benchmark results on Ruby 3.3.0 (with YJIT) indicate a significant performance gain when using the comparison operator:
This cop is unsafe because it cannot be guaranteed that the receiver is Number and could be noisy.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.