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.

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

Jump to bottom

Fix typos in NearestNeighborSearch.h #6705

Merged
merged 3 commits into from
Apr 1, 2024
Merged

Fix typos in NearestNeighborSearch.h #6705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b50ef9a
Fix typo in NearestNeighborSearch.h
mone27 Mar 19, 2024
a7e85f4
fix typos in NearestNeighborSearch.h
mone27 Mar 19, 2024
bdebc48
fix typos in docstrings for cor/nns NanoFlannIndex and NNSIndex
mone27 Apr 1, 2024
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
6 changes: 3 additions & 3 deletions cpp/open3d/core/nns/NNSIndex.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class NNSIndex {
/// \param knn Number of nearest neighbor to search.
/// \return Pair of Tensors: (indices, distances):
/// - indices: Tensor of shape {n, knn}, with dtype Int32.
/// - distainces: Tensor of shape {n, knn}, same dtype with dataset_points.
/// - distances: Tensor of shape {n, knn}, same dtype with dataset_points.
virtual std::pair<Tensor, Tensor> SearchKnn(const Tensor &query_points,
int knn) const = 0;

Expand All @@ -61,7 +61,7 @@ class NNSIndex {
/// dtype with dataset_points.
/// \param radii list of radius. Must be 1D, with shape {n, }.
/// \return Tuple of Tensors: (indices, distances, num_neighbors):
/// - indicecs: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - indices: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - distances: Tensor of shape {total_num_neighbors,}, same dtype with
/// dataset_points.
/// - num_neighbors: Tensor of shape {n,}, dtype Int32.
Expand All @@ -76,7 +76,7 @@ class NNSIndex {
/// dtype with dataset_points.
/// \param radius Radius.
/// \return Tuple of Tensors, (indices, distances, num_neighbors):
/// - indicecs: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - indices: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - distances: Tensor of shape {total_num_neighbors,}, same dtype with
/// dataset_points.
/// - num_neighbors: Tensor of shape {n}, dtype Int32.
Expand Down
6 changes: 3 additions & 3 deletions cpp/open3d/core/nns/NanoFlannIndex.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class NanoFlannIndex : public NNSIndex {
/// \param knn Number of nearest neighbor to search.
/// \return Pair of Tensors: (indices, distances):
/// - indices: Tensor of shape {n, knn}, with dtype Int32.
/// - distainces: Tensor of shape {n, knn}, same dtype with dataset_points.
/// - distances: Tensor of shape {n, knn}, same dtype with dataset_points.
std::pair<Tensor, Tensor> SearchKnn(const Tensor &query_points,
int knn) const override;

Expand All @@ -64,7 +64,7 @@ class NanoFlannIndex : public NNSIndex {
/// dtype with dataset_points.
/// \param radii list of radius. Must be 1D, with shape {n, }.
/// \return Tuple of Tensors: (indices, distances, counts):
/// - indicecs: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - indices: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - distances: Tensor of shape {total_num_neighbors,}, same dtype with
/// dataset_points.
/// - counts: Tensor of shape {n,}, dtype Int64.
Expand All @@ -79,7 +79,7 @@ class NanoFlannIndex : public NNSIndex {
/// dtype with dataset_points.
/// \param radius Radius.
/// \return Tuple of Tensors, (indices, distances, counts):
/// - indicecs: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - indices: Tensor of shape {total_num_neighbors,}, dtype Int32.
/// - distances: Tensor of shape {total_num_neighbors,}, same dtype with
/// dataset_points.
/// - counts: Tensor of shape {n}, dtype Int64.
Expand Down
6 changes: 3 additions & 3 deletions cpp/open3d/core/nns/NearestNeighborSearch.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class NearestNeighborSearch {
/// \param radius Radius.
/// \param sort Sort the results by distance. Default is True.
/// \return Tuple of Tensors, (indices, distances, num_neighbors):
/// - indicecs: Tensor of shape {total_number_of_neighbors,}, with dtype
/// - indices: Tensor of shape {total_number_of_neighbors,}, with dtype
/// same as index_dtype_.
/// - distances: Tensor of shape {total_number_of_neighbors,}, same dtype
/// with query_points. The distances are squared L2 distances.
Expand All @@ -91,7 +91,7 @@ class NearestNeighborSearch {
/// \param radii Radii of query points. Each query point has one radius.
/// Must be 1D, with shape {n,}.
/// \return Tuple of Tensors, (indices,distances, num_neighbors):
/// - indicecs: Tensor of shape {total_number_of_neighbors,}, with dtype
/// - indices: Tensor of shape {total_number_of_neighbors,}, with dtype
/// same as index_dtype_.
/// - distances: Tensor of shape {total_number_of_neighbors,}, same dtype
/// with query_points. The distances are squared L2 distances.
Expand All @@ -108,7 +108,7 @@ class NearestNeighborSearch {
/// \param max_knn Maximum number of neighbor to search per query.
/// \return Tuple of Tensors, (indices, distances, counts):
/// - indices: Tensor of shape {n, knn}, with dtype same as index_dtype_.
/// - distainces: Tensor of shape {n, knn}, with same dtype with
/// - distances: Tensor of shape {n, knn}, with same dtype with
/// query_points. The distances are squared L2 distances.
/// - counts: Counts of neighbour for each query points. [Tensor
/// of shape {n}, with dtype same as index_dtype_].
Expand Down
Loading