Merge pull request #1 from InteractiveComputerGraphics/neighbor_list

new method PointSet::neighbor_list

Author: WeilerMarcel

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2019 Interactive Computer Graphics 
+Copyright (c) 2019-present, cuNSearch contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

README.md

@@ -1,7 +1,7 @@
 # cuNSearch
 A C++/CUDA library to efficiently compute neighborhood information on the GPU for 3D point clouds within a fixed radius. Suitable for many applications, e.g. neighborhood search for SPH fluid simulations.
 
-The library interface is similar to CompactNSearch (https://github.com/InteractiveComputerGraphics/CompactNSearch)
+The library interface is similar to the CPU neighborhood search [CompactNSearch](https://github.com/InteractiveComputerGraphics/CompactNSearch).
 ## Libraries using cuNSearch
 
 * [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH) - A C++ library for the physically-based simulation of fluids using Smoothed Particle Hydrodynamics (see screenshot)

include/PointSet.h

@@ -79,6 +79,19 @@ class PointSet
 		const auto &neighborSet = neighbors[point_set];
 		return neighborSet.Neighbors[neighborSet.Offsets[i] + k];
 	}
+
+	/**
+	* Fetches pointer to neighbors of point i in the given point set.
+	* @param point_set Point set index of other point set where neighbors have been searched.
+	* @param i Point index for which the neighbor id should be returned.
+	* @returns Pointer to ids of neighboring points of i in point set point_set.
+	*/
+	inline unsigned int * neighbor_list(unsigned int point_set, unsigned int i) const 
+	{
+		//Return index of the k-th neighbor to point i (of the given point set)
+		const auto &neighborSet = neighbors[point_set];
+		return &neighborSet.Neighbors[neighborSet.Offsets[i]];
+	}
 
 	/**
 	* @returns the number of points contained in the point set.