mirror of https://github.com/CGAL/cgal
Add the documentation for Kd_tree::build() and unify it with AABB_tree::build.
The latter was in a Section 'Advanced' (not \cgalAdvanced, just a \heading). They are now both in the Section `Creation`.
This commit is contained in:
parent
119d5b345c
commit
64a901a863
|
|
@ -143,6 +143,15 @@ namespace CGAL {
|
||||||
AABB_tree(InputIterator first, InputIterator beyond,T1&,T2&,T3&,T4&,T5&);
|
AABB_tree(InputIterator first, InputIterator beyond,T1&,T2&,T3&,T4&,T5&);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/// After one or more calls to `insert()` the internal data
|
||||||
|
/// structure of the tree must be reconstructed. This procedure
|
||||||
|
/// has a complexity of \f$O(n log(n))\f$, where \f$n\f$ is the number of
|
||||||
|
/// primitives of the tree. This procedure is called implicitly
|
||||||
|
/// at the first call to a query member function. You can call
|
||||||
|
/// `build()` explicitly to ensure that the next call to
|
||||||
|
/// query functions will not trigger the reconstruction of the
|
||||||
|
/// data structure.
|
||||||
|
void build();
|
||||||
///@}
|
///@}
|
||||||
|
|
||||||
/// \name Operations
|
/// \name Operations
|
||||||
|
|
@ -236,21 +245,6 @@ namespace CGAL {
|
||||||
bool empty() const { return m_primitives.empty(); }
|
bool empty() const { return m_primitives.empty(); }
|
||||||
///@}
|
///@}
|
||||||
|
|
||||||
/// \name Advanced
|
|
||||||
///@{
|
|
||||||
|
|
||||||
/// After one or more calls to `AABB_tree::insert()` the internal data
|
|
||||||
/// structure of the tree must be reconstructed. This procedure
|
|
||||||
/// has a complexity of \f$O(n log(n))\f$, where \f$n\f$ is the number of
|
|
||||||
/// primitives of the tree. This procedure is called implicitly
|
|
||||||
/// at the first call to a query member function. You can call
|
|
||||||
/// AABB_tree::build() explicitly to ensure that the next call to
|
|
||||||
/// query functions will not trigger the reconstruction of the
|
|
||||||
/// data structure.
|
|
||||||
void build();
|
|
||||||
|
|
||||||
///@}
|
|
||||||
|
|
||||||
private:
|
private:
|
||||||
#if !defined(CGAL_CFG_NO_CPP0X_VARIADIC_TEMPLATES) && !defined(CGAL_CFG_NO_CPP0X_RVALUE_REFERENCE)
|
#if !defined(CGAL_CFG_NO_CPP0X_VARIADIC_TEMPLATES) && !defined(CGAL_CFG_NO_CPP0X_RVALUE_REFERENCE)
|
||||||
template <typename ... T>
|
template <typename ... T>
|
||||||
|
|
|
||||||
|
|
@ -92,6 +92,16 @@ The value type of the `InputIterator` must be `Point_d`.
|
||||||
*/
|
*/
|
||||||
template <class InputIterator> Kd_tree(InputIterator first, InputIterator beyond, Splitter s=Splitter(),Traits t=Traits());
|
template <class InputIterator> Kd_tree(InputIterator first, InputIterator beyond, Splitter s=Splitter(),Traits t=Traits());
|
||||||
|
|
||||||
|
/*!
|
||||||
|
The constructor does not build the internal data structure, and it
|
||||||
|
is also not updated after calls to `insert()`.
|
||||||
|
The method `build()` is called implicitly
|
||||||
|
at the first call to a query member function. You can call
|
||||||
|
`build()` explicitly to ensure that the next call to
|
||||||
|
query functions will not trigger the reconstruction of the
|
||||||
|
data structure.
|
||||||
|
*/
|
||||||
|
void build();
|
||||||
/// @}
|
/// @}
|
||||||
|
|
||||||
/// \name Operations
|
/// \name Operations
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue