doc: clarify Expr.forEachWhere semantics - #14650
Open
sankalpsthakur wants to merge 1 commit into
Open
Conversation
|
Mathlib CI status (docs):
|
Collaborator
|
Reference manual CI status:
|
sankalpsthakur
marked this pull request as ready for review
August 2, 2026 05:17
sankalpsthakur
force-pushed
the
agent/clarify-foreachwhere-docs
branch
from
August 4, 2026 01:52
d34b363 to
a68b728
Compare
Collaborator
|
I see you updated these branches. Did you see my message on the Lean Zulip? |
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.
This PR documents the two behavioral differences between
Expr.forEachWhereandExpr.forEachthat matter to callers.Matching subterms are deduplicated by structural equality, so the callback runs at most once for each distinct matching expression even when it occurs multiple times. The traversal also carries pointer and hash-set caches, which can be beneficial for selective predicates or expensive callbacks but can cost more than
forEachwhen most subterms match.The public
stopWhenVisiteddescription is also made precise: descent stops when the callback is invoked for a matching subterm.Closes #2511
Validation
visitedandcheckedstate used byForEachExprWhere.visitAI assistance
AI tools assisted with issue triage, duplicate-PR search, implementation inspection, and wording. I reviewed the traversal, deduplication state, and final one-file diff.