Remove error and ctor options from direct ctors #530
Merged
Conversation
This file contains 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
Modify direct constructors (`NewPoint` etc.) to no longer perform validation at all. The direct constructors are for more advanced use cases where geometries are being constructed from other geometries or raw sequences of floats. Things like custom geometric algorithms come to mind. Because these are for advanced use cases, making users validate manually is reasonable. Modifying direct constructors removes error handling mismatch, with users no longer having to handle errors that can never occur (when validation is disabled). It also eliminates the situation where constructor options would sometimes be ignored, and simplifies the rules around what validation occurs during direct construction (i.e. now none is performed).
peterstace
commented
Sep 20, 2023
| @@ -81,6 +81,9 @@ func setOp(a Geometry, include func([2]bool) bool, b Geometry) (Geometry, error) | |||
| if err != nil { | |||
| return Geometry{}, wrap(err, "internal error extracting geometry") | |||
| } | |||
| if err := g.Validate(); err != nil { | |||
There was a problem hiding this comment.
Validation is removed from extractGeometry, so it occurs right at the end now.
A similar pattern is used for the parsers (WKB etc.) as well.
albertteoh
approved these changes
Sep 22, 2023
|
Thanks for reviewing @albertteoh , I really appreciate it 😁 |
Base automatically changed from
remove_validation_from_transform_xy
to
master
September 26, 2023 19:03
peterstace
deleted the
remove_error_and_ctor_options_from_direct_ctors
branch
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.
Description
Modify direct constructors (
NewPointetc.) to no longer perform validation at all. The direct constructors are for more advanced use cases where geometries are being constructed from other geometries or raw sequences of floats. Things like custom geometric algorithms come to mind. Because these are for advanced use cases, making users validate manually is reasonable.Modifying direct constructors removes error handling mismatch, with users no longer having to handle errors that can never occur (when validation is disabled). It also eliminates the situation where constructor options would sometimes be ignored, and simplifies the rules around what validation occurs during direct construction (i.e. now none is performed).
See #525 for more context.
Check List
Have you:
Added unit tests? Yes.
Add cmprefimpl tests? (if appropriate?) N/A.
Updated release notes? (if appropriate?) No. This will be done when all constructor option changes are complete.
Related Issue
Benchmark Results
Benchmark results are attached. Some notes about the apparent regressions:
results.txt