BrunoLevy / geogram

a programming library with geometric algorithms
Other
1.87k stars 128 forks source link

Clarification on compute_RVC() documentation #25

Closed akrodger closed 2 years ago

akrodger commented 2 years ago

I'm confused about the wording on the documentation of the 4th input parameter of compute_RVC() within the RestrictedVoronoiDiagram class. It reads as

[in] copy_symbolic_info if true, symbolic information is copied. An attribute "id" is attached to the facets. The value of id[f] is either 1 + the index of the Voronoi vertex that generated with i the bisector that created the facet, or -1-g if the facet was an original facet of mesh M, where g is the index of the original facet in M.

It says "Voronoi vertex" but then mentions the bisecting plane. However, don't the vertices of the Delaunay graph generate the bisecting planes? Does this actually refer to the generating seed point for a voronoi cell or a vert of the voronoi graph? Or perhaps I am misunderstanding something else. Thanks for any clarification.

BrunoLevy commented 2 years ago

Yes, the documentation is not clear, "Voronoi vertex" means "generating seed point of Voronoi cell".

akrodger commented 2 years ago

Excellent, thank you again!