[mlpack-git] master: Improve documentation (a5bebf4)
gitdub at mlpack.org
gitdub at mlpack.org
Sat Aug 20 14:56:08 EDT 2016
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/3274b05fcc545c3b36f783316fea2e22f79c3d03...1c77230c7d3b9c45fb102cd3c632d9c7248e085e
>---------------------------------------------------------------
commit a5bebf46f28825e873c2a9bfde38efcb4bdee10a
Author: MarcosPividori <marcos.pividori at gmail.com>
Date: Fri Aug 19 15:09:25 2016 -0300
Improve documentation
>---------------------------------------------------------------
a5bebf46f28825e873c2a9bfde38efcb4bdee10a
src/mlpack/core/tree/spill_tree/spill_tree.hpp | 24 ++++++++++++++++--------
1 file changed, 16 insertions(+), 8 deletions(-)
diff --git a/src/mlpack/core/tree/spill_tree/spill_tree.hpp b/src/mlpack/core/tree/spill_tree/spill_tree.hpp
index 452ebfb..3d34a75 100644
--- a/src/mlpack/core/tree/spill_tree/spill_tree.hpp
+++ b/src/mlpack/core/tree/spill_tree/spill_tree.hpp
@@ -265,8 +265,10 @@ class SpillTree
size_t NumChildren() const;
/**
- * Return the nearest child node to the given query point. If this is a leaf
- * node, it will return a reference to itself.
+ * Return the nearest child node to the given query point (this is an
+ * efficient estimation based on the splitting hyperplane, the node returned
+ * is not necessarily the nearest). If this is a leaf node, it will return a
+ * reference to itself.
*/
template<typename VecType>
SpillTree& GetNearestChild(
@@ -274,8 +276,10 @@ class SpillTree
typename boost::enable_if<IsVector<VecType> >::type* = 0);
/**
- * Return the furthest child node to the given query point. If this is a leaf
- * node, it will return a reference to itself.
+ * Return the furthest child node to the given query point (this is an
+ * efficient estimation based on the splitting hyperplane, the node returned
+ * is not necessarily the furthest). If this is a leaf node, it will return a
+ * reference to itself.
*/
template<typename VecType>
SpillTree& GetFurthestChild(
@@ -283,14 +287,18 @@ class SpillTree
typename boost::enable_if<IsVector<VecType> >::type* = 0);
/**
- * Return the nearest child node to the given query node. If it can't decide
- * it will return a null pointer.
+ * Return the nearest child node to the given query node (this is an
+ * efficient estimation based on the splitting hyperplane, the node returned
+ * is not necessarily the nearest). If it can't decide it will return a null
+ * pointer.
*/
SpillTree* GetNearestChild(const SpillTree& queryNode);
/**
- * Return the furthest child node to the given query node. If it can't decide
- * it will return a null pointer.
+ * Return the furthest child node to the given query node (this is an
+ * efficient estimation based on the splitting hyperplane, the node returned
+ * is not necessarily the furthest). If it can't decide it will return a null
+ * pointer.
*/
SpillTree* GetFurthestChild(const SpillTree& queryNode);
More information about the mlpack-git
mailing list