Repository navigation
Quantiles javadoc: name the exception each sketch throws when empty - #791
Merged
Merged
Conversation
The quantiles API interfaces said every query on an empty sketch throws IllegalArgumentException. Only some implementations do: - KLL (doubles, floats, longs, items) throws SketchesArgumentException, which extends RuntimeException, not IllegalArgumentException. - QuantilesDoublesSketch, QuantilesItemsSketch and ReqSketch throw IllegalArgumentException. Each @throws tag in QuantilesDoublesAPI, QuantilesFloatsAPI and QuantilesGenericAPI now names both cases. QuantilesLongsAPI, which only KLL implements, names SketchesArgumentException. PartitioningFeature now documents the IllegalArgumentException its implementations throw for an empty sketch. GenericPartitionBoundaries getMinItem() and getMaxItem() lose a @throws tag: they return a stored field and never throw. No behavior changes. Checked by calling every documented method on an empty instance of each implementation, including the heapify, wrap and compact forms. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
proost
approved these changes
Nov 2, 2026
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.
Docs only. The quantiles API javadoc said that every query on an empty sketch throws
IllegalArgumentException, but only some implementations do. A caller who followed the docs would miss the exception from a KLL sketch, becauseSketchesArgumentExceptionextendsRuntimeException, notIllegalArgumentException.What each sketch actually throws on an empty sketch
QuantilesDoublesSketch,QuantilesItemsSketch,ReqSketchgetQuantile(s),getRank(s),getPMF,getCDF,getMin/MaxItem,getQuantileLower/UpperBoundSketchesArgumentExceptionIllegalArgumentExceptiongetSortedView()SketchesArgumentExceptionSketchesArgumentExceptiongetPartitionBoundariesFrom*()(items sketches)IllegalArgumentExceptionIllegalArgumentExceptionI found this by calling every documented method on an empty instance of each implementation, including the heapify, wrap and compact forms.
Changes
QuantilesDoublesAPI,QuantilesFloatsAPI,QuantilesGenericAPI: each "if sketch is empty"@throwsnow names both cases, for exampleSketchesArgumentExceptionforKllFloatsSketchandIllegalArgumentExceptionforReqSketch.QuantilesLongsAPI, which only KLL implements, now namesSketchesArgumentException.PartitioningFeature: adds the missing@throws IllegalArgumentException if sketch is empty.GenericPartitionBoundaries.getMinItem()/getMaxItem(): removes a@throwstag. They return a stored field and never throw.The
getSortedView()docs were already correct.No behavior changes. Making the empty checks throw one exception type everywhere would change behavior for callers who catch
IllegalArgumentException, so that is left for 10.0.Testing
mvn verify, including javadoc and checkstyle: 2320 tests, 0 failures.🤖 Generated with Claude Code