mirror of https://github.com/CGAL/cgal
66 lines
1.6 KiB
TeX
Executable File
66 lines
1.6 KiB
TeX
Executable File
% +------------------------------------------------------------------------+
|
|
% | Reference manual page: Fair.tex
|
|
% +------------------------------------------------------------------------+
|
|
% | 1.07.2001 Johan W.H. Tangelder
|
|
% | Package: ASPAS
|
|
% |
|
|
\RCSdef{\RCSFairRev}{$Revision$}
|
|
\RCSdefDate{\RCSFairDate}{$Date$}
|
|
% |
|
|
%%RefPage: end of header, begin of main body
|
|
% +------------------------------------------------------------------------+
|
|
|
|
|
|
\begin{ccRefFunctionObjectClass}{Fair<Item>} %% add template arg's if necessary
|
|
|
|
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
|
%% \ccHtmlIndexC[class]{} %% add further index entries
|
|
|
|
\begin{ccAdvanced}
|
|
|
|
\ccDefinition
|
|
Implements the fair splitting rule.
|
|
|
|
\ccParameters
|
|
|
|
Expects for the parameter \ccc{Item} an implementation of a $d$-dimensional point,\\
|
|
for example \ccc{CGAL::Point_d}.
|
|
|
|
\ccInclude{CGAL/Splitting_rules.h}
|
|
|
|
\ccIsModel
|
|
|
|
SplitRule
|
|
|
|
\ccTypes
|
|
|
|
\ccTypedef{Item::R::FT NT;}{Number type.}
|
|
|
|
\ccCreation
|
|
\ccCreationVariable{s} %% choose variable name
|
|
|
|
\ccConstructor{
|
|
Fair();}{Default constructor.}
|
|
|
|
\ccHeading{Member Functions}
|
|
|
|
\ccMethod{
|
|
const Plane_separator<NT>& rule(Point_container<Item>& c, NT Aspect_ratio;);}
|
|
{Computes and returns the splitter, that can split \ccc{c}.}
|
|
|
|
\ccSeeAlso
|
|
|
|
SplitRule,
|
|
\ccc{Point_container},
|
|
\ccc{Plane_separator}.
|
|
|
|
\end{ccAdvanced}
|
|
|
|
\end{ccRefFunctionObjectClass}
|
|
|
|
% +------------------------------------------------------------------------+
|
|
%%RefPage: end of main body, begin of footer
|
|
% EOF
|
|
% +------------------------------------------------------------------------+
|
|
|