robust icon indicating copy to clipboard operation
robust copied to clipboard

Documentation is a bit unclear

Open oisyn opened this issue 1 year ago • 6 comments

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.

oisyn avatar Mar 04 '24 09:03 oisyn

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.

urschrei avatar Mar 04 '24 12:03 urschrei

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

oisyn avatar Mar 04 '24 13:03 oisyn

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

urschrei avatar Mar 04 '24 13:03 urschrei

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

oisyn avatar Mar 04 '24 13:03 oisyn

Yes, we're always open to clearer documentation.

urschrei avatar Mar 04 '24 13:03 urschrei

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).

hugoledoux avatar Mar 04 '24 16:03 hugoledoux