Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend doc for @max_methods #45595

Merged
merged 3 commits into from Jun 7, 2022
Merged

Extend doc for @max_methods #45595

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6106b06
Extend doc for `@max_methods`
rikhuijzer Jun 6, 2022
0a074c8
Implement suggestions from Shuhei
rikhuijzer Jun 7, 2022
2e29dbd
Minor change
rikhuijzer Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions base/experimental.jl
View file
Open in desktop
Expand Up @@ -129,6 +129,15 @@ Set the maximum number of potentially-matching methods considered when running i
for methods defined in the current module. This setting affects inference of calls with
incomplete knowledge of the argument types.

The benefit of this setting is to avoid excessive compilation and reduce invalidation risks
in poorly-inferred cases. For example, when `@max_methods 2` is set and there are two
potentially-matching methods returning different types inside a function body, then Julia
will compile subsequent calls for both types so that the compiled function body accounts
for both possibilities. Also the compiled code is vulnerable to invalidations that would
happen when either of the two methods gets invalidated. This speculative compilation and
these invalidations can be avoided by setting `@max_methods 1` and allowing the compiled
code to resort to runtime dispatch instead.

Supported values are `1`, `2`, `3`, `4`, and `default` (currently equivalent to `3`).
"""
macro max_methods(n::Int)
Expand Down