Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminology for Vertex is not clear and missing. #658

Open
SkybuckFlying opened this issue Aug 29, 2022 · 1 comment
Open

Terminology for Vertex is not clear and missing. #658

SkybuckFlying opened this issue Aug 29, 2022 · 1 comment

Comments

@SkybuckFlying
Copy link
Contributor

Having used 3D packages such as 3D Studio 4.0 I am used to thinking of a vertex as a coordinate x,y,z.

However UBER H3 library seems to use the term for an H3 Vertex as far as I can tell.

So basically a H3 Index repurposed for a H3 Vertex Index.

This API documentation mentions verteces/vertexes however it's not immediately clear if a vertex in the sense of 3D coordinate is ment or vertex in the sense of an H3 Index... H3 Vertex Index.

https://h3geo.org/docs/api/vertex

Also the H3 Terminology makes no mention of the word/term Vertex or the difference between Vertex in the 3D coordinate sense of the H3 Vertex Index sense.

https://h3geo.org/docs/library/terminology

It would be a good idea to update the documentation to more clearly explain the difference.

(
Perhaps the same could be done to indicate a cleared difference between an edge between 3D verteces and an edge index between H3 Indexes. Though I am not yet familiar unknown with H3 Edges and H3 Edge Indexes and such... I am still trying to figure this part out :)

Also I have not yet used the H3 Vertex Index functionality... but from the looks of it... I think what I am writing about is correct.
)

@SkybuckFlying SkybuckFlying changed the title Terminology for Vertex is not clear. Terminology for Vertex is not clear and missing. Aug 29, 2022
@nrabinowitz
Copy link
Collaborator

I think there's a valid issue here, which is that we use vertex somewhat interchangeably to talk about geographic vertexes (which are returned as part of cellToBoundary) and H3 Vertexes, which are H3 index representations of a topological vertex in the grid. The latter are for specialized use - the main advantage is that they are properly shared between neighbors, where geographic vertexes may be subject to FPE and other distortions between neighbors and are not guaranteed to match exactly. Most end users will not need or want H3 Vertexes. We can add a note to the docs with this disclaimer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants