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

Documentation is a bit unclear #34

Open
oisyn opened this issue Mar 4, 2024 · 6 comments
Open

Documentation is a bit unclear #34

oisyn opened this issue Mar 4, 2024 · 6 comments

Comments

@oisyn
Copy link

oisyn commented Mar 4, 2024

The documentation for incircle, orient2d and orient3d all speak of "counterclockwise order", but without specifying the assumed handedness of the coordinate system, this is fairly meaningless.

The documentation for insphere speaks of the points needing to be in a "positive orientation". It is unclear what is meant by this. I'm also not sure if this is in any way intuitively quantifyable? Perhaps something along the lines of: a positive orientation is where point d is on the left or right (whichever is applicable, handedness applies here as well) of the plane defined by the triangle abc. I'm not sure whether this definition always holds, though.

@urschrei
Copy link
Member

urschrei commented Mar 4, 2024

The documentation for incircle, orient2d and orient3d all speak of "counterclockwise order", but without specifying the assumed handedness of the coordinate system, this is fairly meaningless.

The meanings of clockwise, counterclockwise, and positive are assumed to be in keeping with the original paper and documentation coordinate system (section 4.1):

These definitions extend to arbitrary dimensions. For instance, ORIENT3D returns a positive value if d lies below the oriented plane passing through a, b , and c. By oriented plane, I mean that a, b, and c appear in counter- clockwise order when viewed from above the plane.

@oisyn
Copy link
Author

oisyn commented Mar 4, 2024

Well, yes, but the paper doesn't seem to be very clear about that either.

@urschrei
Copy link
Member

urschrei commented Mar 4, 2024

In that case I suggest you direct your questions to Jonathan Shewchuk.

@oisyn
Copy link
Author

oisyn commented Mar 4, 2024

Suppose I found out, would you be open to change the documentation? Because that's what this is ultimately about.

@urschrei
Copy link
Member

urschrei commented Mar 4, 2024

Yes, we're always open to clearer documentation.

@hugoledoux
Copy link

It's actually clear in the paper:

SCR-20240304-oztr

This is consistent with the left-hand rule: when the ordering of $a$, $b$ and $c$ follows the direction of rotation of the curled fingers of the left hand, then the thumb points towards the positive side (the above side of the plane).

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

3 participants