cgal/Spatial_searching/doc_tex/Spatial_searching_ref/Sliding_midpoint.tex

65 lines
2.0 KiB
TeX

% +------------------------------------------------------------------------+
% | Reference manual page: Sliding_midpoint.tex
% +------------------------------------------------------------------------+
% | 1.07.2001 Johan W.H. Tangelder
% | Package: ASPAS
% |
\RCSdef{\RCSSlidingmidpointRev}{$Id$}
\RCSdefDate{\RCSSlidingmidpointDate}{$Date$}
% |
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefFunctionObjectClass}{Sliding_midpoint<Traits, SpatialSeparator>}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[class]{} %% add further index entries
\ccDefinition
Implements the {\em sliding midpoint} splitting rule.
This is a modification of the \ccc{Midpoint_of_rectangle} splitting rule.
It first attempts to perform a midpoint of rectangle split as
described above. If data points lie on both sides of the separating
plane the sliding midpoint rule computes the same separator as
the midpoint of rectangle rule. If the data points lie only on one
side it avoids this by sliding the separator, computed by
the midpoint of rectangle rule, to the nearest datapoint.
\ccInclude{CGAL/Splitters.h}
\ccParameters
Expects for the first template argument a model of the concept
\ccc{SearchTraits}, for example \ccc{CGAL::Cartesian_d<double>}.
Expects for the second template argument a model of the concept \ccc{Separator}. It has as default value
the type, \ccc{CGAL::Plane_separator<Traits::FT>}.
\ccIsModel
\ccc{Splitter}
\ccCreation
\ccCreationVariable{s} %% choose variable name
\ccConstructor{ Sliding_fair(unsigned int bucket_size)}{Constructor.}
\ccOperations
\ccMethod{unsigned int bucket_size();} {Returns the bucket size of the leaf nodes.}
\ccSeeAlso
\ccc{Splitter},\\
\ccc{SpatialSeparator}
\end{ccRefFunctionObjectClass}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+