search

boostorg / geometry

Boost.Geometry - Generic Geometry Library | Requires C++14 since Boost 1.75
http://boost.org/libs/geometry
Boost Software License 1.0
458 stars 216 forks source link

Set operation strategies are undocumented #810

Open vissarion opened 3 years ago

vissarion commented 3 years ago

In documentation, there are links for set operations with the use of strategies e.g. difference (with strategy), see below for more. However, the description on the use of the strategy seems loose, e.g. the example is identical to the original (without strategy) function.

Is this on purpose? If not this could be fixed.

https://www.boost.org/doc/libs/1_75_0/libs/geometry/doc/html/geometry/reference/algorithms/difference/difference_4_with_strategy.html https://www.boost.org/doc/libs/1_75_0/libs/geometry/doc/html/geometry/reference/algorithms/union_/union__4_with_strategy.html https://www.boost.org/doc/libs/1_75_0/libs/geometry/doc/html/geometry/reference/algorithms/intersection/intersection_4_with_strategy.html https://www.boost.org/doc/libs/1_75_0/libs/geometry/doc/html/geometry/reference/algorithms/sym_difference/sym_difference_4_with_strategy.html

pcmourya commented 3 years ago

I want to work on this, may I proceed with that?

mloskot commented 3 years ago

@pcmourya No need to ask for permission. There is no reservation of issues or tasks in use. First PR submitted, first PR reviewed and first PR has chance to be merged first.

ayushgupta138 commented 3 years ago

I could not find any pre defined strategies in the official documentation for set operations mentioned above. So do we have to define a custom strategy and add it to the example codes? It would be helpful if @vissarion could clarify on this.

Siddharth-coder13 commented 3 years ago

is this on purpose? If not this could be fixed.

I think strategies for these operations are not yet defined, that's why the same example is used on both functions. But using the same example on both functions can be misleading, I guess it needs to be removed from the with strategies part, till the strategies are defined.

ayushgupta138 commented 3 years ago

I agree with @Siddharth-coder13.

vissarion commented 3 years ago

I think it is OK to stay as is until the strategies are documented and properly linked as available strategies in the algorithm documentation. Also note that recently set operations were refactored see https://github.com/boostorg/geometry/pull/768