Skip to content

docs: dt_mesh returns plain distance, not squared distance#85

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.

Sign up for GitHub

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

Merged
balbasty merged 2 commits into from
Aug 19, 2026
Merged

docs: dt_mesh returns plain distance, not squared distance #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4975867
docs: dt_mesh returns plain distance, not squared distance
claude Aug 19, 2026
f320d8b
docs: wrap dt_mesh's _signed/naive param lines to the 80-column limit
claude Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions include/fastfields/api/distance.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,13 +150,18 @@ void dt_spline_gaussnewton(
/**
* @brief Compute the distance from a set of points to a triangular mesh.
*
* @param dist Output tensor for squared distances (*B,)
* @param dist Output tensor for distances (*B,). NOT squared --
* unlike the spline ops above, this is the plain
* Euclidean point-to-triangle distance, negative
* inside the surface when `_signed`.
* @param nearest_vertex Output tensor for index of nearest vertex (*B,)
* @param loc Input tensor for ND location of each point (*B, D)
* @param vertices Input tensor for mesh vertices (N, D)
* @param faces Input tensor for mesh faces (M, D)
* @param _signed Whether to compute signed distances (inside negative)
* @param naive Whether to use the naive algorithm (no acceleration structure)
* @param _signed Whether to compute signed distances (negative
* inside the surface)
* @param naive Whether to use the naive algorithm (no
* acceleration structure)
* @param stream Cuda stream on which to operate
*/
void dt_mesh(
Expand Down
Loading