// right now the size of CUDA STACK is set to 1000, increase it if you mean to make deeper tree // data should be stored in row-major // x1,x2,x3,x4,x5...... // y1,y2,y3,y4,y5...... // .................... // .................... #ifndef KDTREE_H #define KDTREE_H #define stack_size 50 #include "device_launch_parameters.h" #include #include #include "cuda_runtime.h" #include #include #include #include #include #include #include namespace stim { namespace kdtree { template // typename refers to float or double while D refers to dimension of points struct point { T dim[D]; // create a structure to store every one input point }; template class kdnode { public: kdnode() { // constructor for initializing a kdnode parent = NULL; // set every node's parent, left and right kdnode pointers to NULL left = NULL; right = NULL; parent_idx = -1; // set parent node index to default -1 left_idx = -1; right_idx = -1; split_value = -1; // set split_value to default -1 } int idx; // index of current node int parent_idx, left_idx, right_idx; // index of parent, left and right nodes kdnode *parent, *left, *right; // parent, left and right kdnodes T split_value; // splitting value of current node std::vector indices; // it indicates the points' indices that current node has size_t level; // tree level of current node }; } // end of namespace kdtree template // set dimension of data to default 3 class cpu_kdtree { protected: int current_axis; // current judging axis int n_id; // store the total number of nodes std::vector < typename kdtree::point > *tmp_points; // transfer or temperary points std::vector < typename kdtree::point > cpu_tmp_points; // for cpu searching kdtree::kdnode *root; // root node static cpu_kdtree *cur_tree_ptr; public: cpu_kdtree() { // constructor for creating a cpu_kdtree cur_tree_ptr = this; // create a class pointer points to the current class value n_id = 0; // set total number of points to default 0 } ~cpu_kdtree() { // destructor of cpu_kdtree std::vector *> next_nodes; next_nodes.push_back(root); while (next_nodes.size()) { std::vector *> next_search_nodes; while (next_nodes.size()) { kdtree::kdnode *cur = next_nodes.back(); next_nodes.pop_back(); if (cur->left) next_search_nodes.push_back(cur->left); if (cur->right) next_search_nodes.push_back(cur->right); delete cur; } next_nodes = next_search_nodes; } root = NULL; } void cpu_create(std::vector < typename kdtree::point > &reference_points, size_t max_levels) { tmp_points = &reference_points; root = new kdtree::kdnode(); // initializing the root node root->idx = n_id++; // the index of root is 0 root->level = 0; // tree level begins at 0 root->indices.resize(reference_points.size()); // get the number of points for (size_t i = 0; i < reference_points.size(); i++) { root->indices[i] = i; // set indices of input points } std::vector *> next_nodes; // next nodes next_nodes.push_back(root); // push back the root node while (next_nodes.size()) { std::vector *> next_search_nodes; // next search nodes while (next_nodes.size()) { // two same WHILE is because we need to make a new vector to store nodes for search kdtree::kdnode *current_node = next_nodes.back(); // handle node one by one (right first) next_nodes.pop_back(); // pop out current node in order to store next round of nodes if (current_node->level < max_levels) { if (current_node->indices.size() > 1) { // split if the nonleaf node contains more than one point kdtree::kdnode *left = new kdtree::kdnode(); kdtree::kdnode *right = new kdtree::kdnode(); left->idx = n_id++; // set the index of current node's left node right->idx = n_id++; split(current_node, left, right); // split left and right and determine a node std::vector temp; // empty vecters of int //temp.resize(current_node->indices.size()); current_node->indices.swap(temp); // clean up current node's indices current_node->left = left; current_node->right = right; current_node->left_idx = left->idx; current_node->right_idx = right->idx; if (right->indices.size()) next_search_nodes.push_back(right); // left pop out first if (left->indices.size()) next_search_nodes.push_back(left); } } } next_nodes = next_search_nodes; // go deeper within the tree } } static bool sort_points(const size_t a, const size_t b) { // create functor for std::sort std::vector < typename kdtree::point > &pts = *cur_tree_ptr->tmp_points; // put cur_tree_ptr to current input points' pointer return pts[a].dim[cur_tree_ptr->current_axis] < pts[b].dim[cur_tree_ptr->current_axis]; } void split(kdtree::kdnode *cur, kdtree::kdnode *left, kdtree::kdnode *right) { std::vector < typename kdtree::point > &pts = *tmp_points; current_axis = cur->level % D; // indicate the judicative dimension or axis std::sort(cur->indices.begin(), cur->indices.end(), sort_points); // using SortPoints as comparison function to sort the data size_t mid_value = cur->indices[cur->indices.size() / 2]; // odd in the mid_value, even take the floor cur->split_value = pts[mid_value].dim[current_axis]; // get the parent node left->parent = cur; // set the parent of the next search nodes to current node right->parent = cur; left->level = cur->level + 1; // level + 1 right->level = cur->level + 1; left->parent_idx = cur->idx; // set its parent node's index right->parent_idx = cur->idx; for (size_t i = 0; i < cur->indices.size(); i++) { // split into left and right half-space one by one size_t idx = cur->indices[i]; if (pts[idx].dim[current_axis] < cur->split_value) left->indices.push_back(idx); else right->indices.push_back(idx); } } void create(T *h_reference_points, size_t reference_count, size_t max_levels) { std::vector < typename kdtree::point > reference_points(reference_count); // restore the reference points in particular way for (size_t j = 0; j < reference_count; j++) for (size_t i = 0; i < D; i++) reference_points[j].dim[i] = h_reference_points[j * D + i]; cpu_create(reference_points, max_levels); cpu_tmp_points = *tmp_points; } int get_num_nodes() const { // get the total number of nodes return n_id; } kdtree::kdnode* get_root() const { // get the root node of tree return root; } T cpu_distance(const kdtree::point &a, const kdtree::point &b) { T distance = 0; for (size_t i = 0; i < D; i++) { T d = a.dim[i] - b.dim[i]; distance += d*d; } return distance; } void cpu_search_at_node(kdtree::kdnode *cur, const kdtree::point &query, size_t *index, T *distance, kdtree::kdnode **node) { T best_distance = FLT_MAX; // initialize the best distance to max of floating point size_t best_index = 0; std::vector < typename kdtree::point > pts = cpu_tmp_points; while (true) { size_t split_axis = cur->level % D; if (cur->left == NULL) { // risky but acceptable, same goes for right because left and right are in same pace *node = cur; // pointer points to a pointer for (size_t i = 0; i < cur->indices.size(); i++) { size_t idx = cur->indices[i]; T d = cpu_distance(query, pts[idx]); // compute distances /// if we want to compute k nearest neighbor, we can input the last resul /// (last_best_dist < dist < best_dist) to select the next point until reaching to k if (d < best_distance) { best_distance = d; best_index = idx; // record the nearest neighbor index } } break; // find the target point then break the loop } else if (query.dim[split_axis] < cur->split_value) { // if it has son node, visit the next node on either left side or right side cur = cur->left; } else { cur = cur->right; } } *index = best_index; *distance = best_distance; } void cpu_search_at_node_range(kdtree::kdnode *cur, const kdtree::point &query, T range, size_t *index, T *distance) { T best_distance = FLT_MAX; // initialize the best distance to max of floating point size_t best_index = 0; std::vector < typename kdtree::point > pts = cpu_tmp_points; std::vector < typename kdtree::kdnode*> next_node; next_node.push_back(cur); while (next_node.size()) { std::vector*> next_search; while (next_node.size()) { cur = next_node.back(); next_node.pop_back(); size_t split_axis = cur->level % D; if (cur->left == NULL) { for (size_t i = 0; i < cur->indices.size(); i++) { size_t idx = cur->indices[i]; T d = cpu_distance(query, pts[idx]); if (d < best_distance) { best_distance = d; best_index = idx; } } } else { T d = query.dim[split_axis] - cur->split_value; // computer distance along specific axis or dimension /// there are three possibilities: on either left or right, and on both left and right if (fabs(d) > range) { // absolute value of floating point to see if distance will be larger that best_dist if (d < 0) next_search.push_back(cur->left); // every left[split_axis] is less and equal to cur->split_value, so it is possible to find the nearest point in this region else next_search.push_back(cur->right); } else { // it is possible that nereast neighbor will appear on both left and right next_search.push_back(cur->left); next_search.push_back(cur->right); } } } next_node = next_search; // pop out at least one time } *index = best_index; *distance = best_distance; } void cpu_search(T *h_query_points, size_t query_count, size_t *h_indices, T *h_distances) { /// first convert the input query point into specific type kdtree::point query; for (size_t j = 0; j < query_count; j++) { for (size_t i = 0; i < D; i++) query.dim[i] = h_query_points[j * D + i]; /// find the nearest node, this will be the upper bound for the next time searching kdtree::kdnode *best_node = NULL; T best_distance = FLT_MAX; size_t best_index = 0; T radius = 0; // radius for range cpu_search_at_node(root, query, &best_index, &best_distance, &best_node); // simple search to rougly determine a result for next search step radius = sqrt(best_distance); // It is possible that nearest will appear in another region /// find other possibilities kdtree::kdnode *cur = best_node; while (cur->parent != NULL) { // every node that you pass will be possible to be the best node /// go up kdtree::kdnode *parent = cur->parent; // travel back to every node that we pass through size_t split_axis = (parent->level) % D; /// search other nodes size_t tmp_index; T tmp_distance = FLT_MAX; if (fabs(parent->split_value - query.dim[split_axis]) <= radius) { /// search opposite node if (parent->left != cur) cpu_search_at_node_range(parent->left, query, radius, &tmp_index, &tmp_distance); // to see whether it is its mother node's left son node else cpu_search_at_node_range(parent->right, query, radius, &tmp_index, &tmp_distance); } if (tmp_distance < best_distance) { best_distance = tmp_distance; best_index = tmp_index; } cur = parent; } h_indices[j] = best_index; h_distances[j] = best_distance; } } }; //end class kdtree template cpu_kdtree* cpu_kdtree::cur_tree_ptr = NULL; // definition of cur_tree_ptr pointer points to the current class template struct cuda_kdnode { int parent, left, right; T split_value; size_t num_index; // number of indices it has int index; // the beginning index size_t level; }; template __device__ T gpu_distance(kdtree::point &a, kdtree::point &b) { T distance = 0; for (size_t i = 0; i < D; i++) { T d = a.dim[i] - b.dim[i]; distance += d*d; } return distance; } template __device__ void search_at_node(cuda_kdnode *nodes, size_t *indices, kdtree::point *d_reference_points, int cur, kdtree::point &d_query_point, size_t *d_index, T *d_distance, int *d_node) { T best_distance = FLT_MAX; size_t best_index = 0; while (true) { // break until reach the bottom int split_axis = nodes[cur].level % D; if (nodes[cur].left == -1) { // check whether it has left node or not *d_node = cur; for (int i = 0; i < nodes[cur].num_index; i++) { size_t idx = indices[nodes[cur].index + i]; T dist = gpu_distance(d_query_point, d_reference_points[idx]); if (dist < best_distance) { best_distance = dist; best_index = idx; } } break; } else if (d_query_point.dim[split_axis] < nodes[cur].split_value) { // jump into specific son node cur = nodes[cur].left; } else { cur = nodes[cur].right; } } *d_distance = best_distance; *d_index = best_index; } template __device__ void search_at_node_range(cuda_kdnode *nodes, size_t *indices, kdtree::point *d_reference_points, kdtree::point &d_query_point, int cur, T range, size_t *d_index, T *d_distance, size_t id, int *next_nodes, int *next_search_nodes, int *Judge) { T best_distance = FLT_MAX; size_t best_index = 0; int next_nodes_pos = 0; // initialize pop out order index next_nodes[id * stack_size + next_nodes_pos] = cur; // find data that belongs to the very specific thread next_nodes_pos++; while (next_nodes_pos) { int next_search_nodes_pos = 0; // record push back order index while (next_nodes_pos) { cur = next_nodes[id * stack_size + next_nodes_pos - 1]; // pop out the last push in one and keep poping out next_nodes_pos--; int split_axis = nodes[cur].level % D; if (nodes[cur].left == -1) { for (int i = 0; i < nodes[cur].num_index; i++) { int idx = indices[nodes[cur].index + i]; // all indices are stored in one array, pick up from every node's beginning index T d = gpu_distance(d_query_point, d_reference_points[idx]); if (d < best_distance) { best_distance = d; best_index = idx; } } } else { T d = d_query_point.dim[split_axis] - nodes[cur].split_value; if (fabs(d) > range) { if (d < 0) { next_search_nodes[id * stack_size + next_search_nodes_pos] = nodes[cur].left; next_search_nodes_pos++; } else { next_search_nodes[id * stack_size + next_search_nodes_pos] = nodes[cur].right; next_search_nodes_pos++; } } else { next_search_nodes[id * stack_size + next_search_nodes_pos] = nodes[cur].right; next_search_nodes_pos++; next_search_nodes[id * stack_size + next_search_nodes_pos] = nodes[cur].left; next_search_nodes_pos++; if (next_search_nodes_pos > stack_size) { printf("Thread conflict might be caused by thread %d, so please try smaller input max_tree_levels\n", id); (*Judge)++; } } } } for (int i = 0; i < next_search_nodes_pos; i++) next_nodes[id * stack_size + i] = next_search_nodes[id * stack_size + i]; next_nodes_pos = next_search_nodes_pos; } *d_distance = best_distance; *d_index = best_index; } template __device__ void search(cuda_kdnode *nodes, size_t *indices, kdtree::point *d_reference_points, kdtree::point &d_query_point, size_t *d_index, T *d_distance, size_t id, int *next_nodes, int *next_search_nodes, int *Judge) { int best_node = 0; T best_distance = FLT_MAX; size_t best_index = 0; T radius = 0; search_at_node(nodes, indices, d_reference_points, 0, d_query_point, &best_index, &best_distance, &best_node); radius = sqrt(best_distance); // get range int cur = best_node; while (nodes[cur].parent != -1) { int parent = nodes[cur].parent; int split_axis = nodes[parent].level % D; T tmp_dist = FLT_MAX; size_t tmp_idx; if (fabs(nodes[parent].split_value - d_query_point.dim[split_axis]) <= radius) { if (nodes[parent].left != cur) search_at_node_range(nodes, indices, d_reference_points, d_query_point, nodes[parent].left, radius, &tmp_idx, &tmp_dist, id, next_nodes, next_search_nodes, Judge); else search_at_node_range(nodes, indices, d_reference_points, d_query_point, nodes[parent].right, radius, &tmp_idx, &tmp_dist, id, next_nodes, next_search_nodes, Judge); } if (tmp_dist < best_distance) { best_distance = tmp_dist; best_index = tmp_idx; } cur = parent; } *d_distance = sqrt(best_distance); *d_index = best_index; } template __global__ void search_batch(cuda_kdnode *nodes, size_t *indices, kdtree::point *d_reference_points, kdtree::point *d_query_points, size_t d_query_count, size_t *d_indices, T *d_distances, int *next_nodes, int *next_search_nodes, int *Judge) { size_t idx = blockIdx.x * blockDim.x + threadIdx.x; if (idx >= d_query_count) return; // avoid segfault search(nodes, indices, d_reference_points, d_query_points[idx], &d_indices[idx], &d_distances[idx], idx, next_nodes, next_search_nodes, Judge); // every query points are independent } template class cuda_kdtree { protected: cuda_kdnode *d_nodes; size_t *d_index; kdtree::point* d_reference_points; size_t npts; int num_nodes; public: ~cuda_kdtree() { HANDLE_ERROR(cudaFree(d_nodes)); HANDLE_ERROR(cudaFree(d_index)); HANDLE_ERROR(cudaFree(d_reference_points)); } /// Create a KD-tree given a pointer to an array of reference points and the number of reference points /// @param h_reference_points is a host array containing the reference points in (x0, y0, z0, ...., ) order /// @param reference_count is the number of reference point in the array /// @param max_levels is the deepest number of tree levels allowed void create(T *h_reference_points, size_t reference_count, size_t max_levels = 3) { if (max_levels > 10) { std::cout<<"The max_tree_levels should be smaller!"<(bb, h_reference_points, reference_count); std::vector < typename kdtree::point > reference_points(reference_count); // restore the reference points in particular way for (size_t j = 0; j < reference_count; j++) for (size_t i = 0; i < D; i++) reference_points[j].dim[i] = h_reference_points[j * D + i]; cpu_kdtree tree; // creating a tree on cpu tree.cpu_create(reference_points, max_levels); // building a tree on cpu kdtree::kdnode *d_root = tree.get_root(); num_nodes = tree.get_num_nodes(); npts = reference_count; // also equals to reference_count HANDLE_ERROR(cudaMalloc((void**)&d_nodes, sizeof(cuda_kdnode) * num_nodes)); // copy data from host to device HANDLE_ERROR(cudaMalloc((void**)&d_index, sizeof(size_t) * npts)); HANDLE_ERROR(cudaMalloc((void**)&d_reference_points, sizeof(kdtree::point) * npts)); std::vector < cuda_kdnode > tmp_nodes(num_nodes); std::vector indices(npts); std::vector *> next_nodes; size_t cur_pos = 0; next_nodes.push_back(d_root); while (next_nodes.size()) { std::vector *> next_search_nodes; while (next_nodes.size()) { kdtree::kdnode *cur = next_nodes.back(); next_nodes.pop_back(); int id = cur->idx; // the nodes at same level are independent tmp_nodes[id].level = cur->level; tmp_nodes[id].parent = cur->parent_idx; tmp_nodes[id].left = cur->left_idx; tmp_nodes[id].right = cur->right_idx; tmp_nodes[id].split_value = cur->split_value; tmp_nodes[id].num_index = cur->indices.size(); // number of index if (cur->indices.size()) { for (size_t i = 0; i < cur->indices.size(); i++) indices[cur_pos + i] = cur->indices[i]; tmp_nodes[id].index = (int)cur_pos; // beginning index of reference_points that every bottom node has cur_pos += cur->indices.size(); // store indices continuously for every query_point } else { tmp_nodes[id].index = -1; } if (cur->left) next_search_nodes.push_back(cur->left); if (cur->right) next_search_nodes.push_back(cur->right); } next_nodes = next_search_nodes; } HANDLE_ERROR(cudaMemcpy(d_nodes, &tmp_nodes[0], sizeof(cuda_kdnode) * tmp_nodes.size(), cudaMemcpyHostToDevice)); HANDLE_ERROR(cudaMemcpy(d_index, &indices[0], sizeof(size_t) * indices.size(), cudaMemcpyHostToDevice)); HANDLE_ERROR(cudaMemcpy(d_reference_points, &reference_points[0], sizeof(kdtree::point) * reference_points.size(), cudaMemcpyHostToDevice)); } /// Search the KD tree for nearest neighbors to a set of specified query points /// @param h_query_points an array of query points in (x0, y0, z0, ...) order /// @param query_count is the number of query points /// @param indices are the indices to the nearest reference point for each query points /// @param distances is an array containing the distance between each query point and the nearest reference point void search(T *h_query_points, size_t query_count, size_t *indices, T *distances) { std::vector < typename kdtree::point > query_points(query_count); for (size_t j = 0; j < query_count; j++) for (size_t i = 0; i < D; i++) query_points[j].dim[i] = h_query_points[j * D + i]; unsigned int threads = (unsigned int)(query_points.size() > 1024 ? 1024 : query_points.size()); unsigned int blocks = (unsigned int)(query_points.size() / threads + (query_points.size() % threads ? 1 : 0)); kdtree::point *d_query_points; // create a pointer pointing to query points on gpu size_t *d_indices; T *d_distances; int *next_nodes; // create two STACK-like array int *next_search_nodes; int *Judge = NULL; // judge variable to see whether one thread is overwrite another thread's memory HANDLE_ERROR(cudaMalloc((void**)&d_query_points, sizeof(T) * query_points.size() * D)); HANDLE_ERROR(cudaMalloc((void**)&d_indices, sizeof(size_t) * query_points.size())); HANDLE_ERROR(cudaMalloc((void**)&d_distances, sizeof(T) * query_points.size())); HANDLE_ERROR(cudaMalloc((void**)&next_nodes, threads * blocks * stack_size * sizeof(int))); // STACK size right now is 50, you can change it if you mean to HANDLE_ERROR(cudaMalloc((void**)&next_search_nodes, threads * blocks * stack_size * sizeof(int))); HANDLE_ERROR(cudaMemcpy(d_query_points, &query_points[0], sizeof(T) * query_points.size() * D, cudaMemcpyHostToDevice)); search_batch<<>> (d_nodes, d_index, d_reference_points, d_query_points, query_points.size(), d_indices, d_distances, next_nodes, next_search_nodes, Judge); if (Judge == NULL) { // do the following work if the thread works safely HANDLE_ERROR(cudaMemcpy(indices, d_indices, sizeof(size_t) * query_points.size(), cudaMemcpyDeviceToHost)); HANDLE_ERROR(cudaMemcpy(distances, d_distances, sizeof(T) * query_points.size(), cudaMemcpyDeviceToHost)); } HANDLE_ERROR(cudaFree(next_nodes)); HANDLE_ERROR(cudaFree(next_search_nodes)); HANDLE_ERROR(cudaFree(d_query_points)); HANDLE_ERROR(cudaFree(d_indices)); HANDLE_ERROR(cudaFree(d_distances)); } /// Return the number of points in the KD tree size_t num_points() { return npts; } stim::aabbn getbox() { size_t N = npts; //std::vector < typename kdtree::point > cpu_ref(npts); //allocate space on the CPU for the reference points T* cpu_ref = (T*)malloc(N * D * sizeof(T)); //allocate space on the CPU for the reference points HANDLE_ERROR(cudaMemcpy(cpu_ref, d_reference_points, N * D * sizeof(T), cudaMemcpyDeviceToHost)); //copy from GPU to CPU stim::aabbn bb(cpu_ref); for (size_t i = 1; i < N; i++) { //for each reference point //std::cout << "( " << cpu_ref[i * D + 0] << ", " << cpu_ref[i * D + 1] << ", " << cpu_ref[i * D + 2] << ")" << std::endl; bb.insert(&cpu_ref[i * D]); } return bb; } //generate an implicit distance field for the KD-tree void dist_field3(T* dist, size_t* dims, stim::aabbn bb) { size_t N = 1; //number of query points that make up the distance field for (size_t d = 0; d < 3; d++) N *= dims[d]; //calculate the total number of query points //calculate the grid spatial parameters T dx = 0; if (dims[0] > 1) dx = bb.length(0) / dims[0]; T dy = 0; if (dims[1] > 1) dy = bb.length(1) / dims[1]; T dz = 0; if (dims[2] > 1) dz = bb.length(2) / dims[2]; T* Q = (T*)malloc(N * 3 * sizeof(T)); //allocate space for the query points size_t i; for (size_t z = 0; z < dims[2]; z++) { //for each query point (which is a point in the grid) for (size_t y = 0; y < dims[1]; y++) { for (size_t x = 0; x < dims[0]; x++) { i = z * dims[1] * dims[0] + y * dims[0] + x; Q[i * 3 + 0] = bb.low[0] + x * dx + dx / 2; Q[i * 3 + 1] = bb.low[1] + y * dy + dy / 2; Q[i * 3 + 2] = bb.low[2] + z * dz + dz / 2; //std::cout << i<<" "< bb = getbox(); //get a bounding box around the tree dist_field3(dist, dims, bb); } }; } //end namespace stim #endif