DOC: Clarify multiset behaviour of Index.union with duplicate valuesDoc index union multiset #63497
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.
Adds a Notes section to
Index.unionclarifying that, for Indexobjects containing duplicate values, the operation behaves as a
multiset union where multiplicity is determined by the maximum
count across the two input Index objects.
This note also highlights that this differs from other set
operations such as
differenceandsymmetric_difference,which operate only on the carrier sets.
Closes #56137