Skip to content

Commit e3859a2

Browse files
committed
DOC: added comments
1 parent 9d68304 commit e3859a2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/quadtree.cpp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,9 @@ Quadtree::qtnode Quadtree::new_node(arma_vec lower_left_norm_in,
201201
}
202202

203203
// --------------------------------------------------------------------------
204-
//
204+
// This returns the lower left (LL) coordinate in normalized coordinates or
205+
// the size of the node in the right (SR) or up (SU) directions. It can
206+
// also return the midpoint of the node (MID)
205207
// --------------------------------------------------------------------------
206208

207209
arma_vec Quadtree::get_vect(Quadtree::qtnode node, std::string which) {
@@ -483,7 +485,9 @@ arma_vec Quadtree::wrap_point_cubesphere(arma_vec point) {
483485
}
484486

485487
// --------------------------------------------------------------------------
486-
//
488+
// This is the starting point for determining which node a point
489+
// on the sphere is located. The point needs to be in normalized
490+
// coordinates.
487491
// --------------------------------------------------------------------------
488492

489493
int64_t Quadtree::find_point(arma_vec point) {
@@ -509,7 +513,9 @@ int64_t Quadtree::find_point(arma_vec point) {
509513
}
510514

511515
// --------------------------------------------------------------------------
512-
//
516+
// This is the starting point for determining which root a point
517+
// on the sphere is located. The point needs to be in normalized
518+
// coordinates.
513519
// --------------------------------------------------------------------------
514520

515521
int64_t Quadtree::find_root(arma_vec point) {

0 commit comments

Comments
 (0)