mirror of https://github.com/CGAL/cgal
408 lines
13 KiB
TeX
408 lines
13 KiB
TeX
% +------------------------------------------------------------------------+
|
|
% | CBP Reference Manual: main.tex
|
|
% +------------------------------------------------------------------------+
|
|
% | Automatically generated driver file for the reference manual chapter
|
|
% | of this package. Do not edit manually, you may loose your changes.
|
|
% +------------------------------------------------------------------------+
|
|
|
|
\newcommand{\KernelRefLayout}{%
|
|
\ccSetThreeColumns{const Comparison_result}{}{\hspace*{8cm}}%
|
|
\ccPropagateThreeToTwoColumns
|
|
}
|
|
\renewcommand{\ccRefPageBegin}{\KernelRefLayout }
|
|
|
|
\chapter{Reference Pages}
|
|
\lcTex{
|
|
The following pages give a complete overview on the functionality provided
|
|
in the kernel.
|
|
}
|
|
|
|
\lcTex{\input{kernel_toc}}
|
|
|
|
\clearpage
|
|
\section{Concepts}
|
|
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
\input{Ref/Kernel.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/EuclideanRingNumberType.tex}
|
|
\input{Ref/FieldNumberType.tex}
|
|
\input{Ref/R.tex}
|
|
\input{Ref/RingNumberType.tex}
|
|
|
|
\clearpage
|
|
\section{Kernel Classes and Operations}
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
|
|
\input{Ref/Cartesian.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/Cartesian_converter.tex}
|
|
\input{Ref/cartesian_to_homogeneous.tex}
|
|
\input{Ref/Filtered_kernel.tex}
|
|
\input{Ref/Filtered_predicate.tex}
|
|
\input{Ref/Homogeneous.tex}
|
|
\input{Ref/Homogeneous_converter.tex}
|
|
\input{Ref/homogeneous_to_cartesian.tex}
|
|
\input{Ref/homogeneous_to_quotient_cartesian.tex}
|
|
\input{Ref/Kernel_traits.tex}
|
|
\input{Ref/Simple_cartesian.tex}
|
|
\input{Ref/Simple_homogeneous.tex}
|
|
|
|
\clearpage
|
|
\section{Kernel Objects}
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
|
|
\subsection{Two-dimensional Objects}
|
|
|
|
\input{Ref/Aff_transformation_2.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/Bbox_2.tex}
|
|
\input{Ref/Circle_2.tex}
|
|
\input{Ref/Direction_2.tex}
|
|
\input{Ref/Iso_rectangle_2.tex}
|
|
\input{Ref/Line_2.tex}
|
|
\input{Ref/Point_2.tex}
|
|
\input{Ref/Ray_2.tex}
|
|
\input{Ref/Segment_2.tex}
|
|
\input{Ref/Triangle_2.tex}
|
|
\input{Ref/Vector_2.tex}
|
|
\input{Ref/Weighted_point_2.tex}
|
|
|
|
\clearpage
|
|
\subsection{Three-dimensional Objects}
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
|
|
\input{Ref/Bbox_3.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/Aff_transformation_3.tex}
|
|
\input{Ref/Direction_3.tex}
|
|
\input{Ref/Iso_cuboid_3.tex}
|
|
\input{Ref/Line_3.tex}
|
|
\input{Ref/Plane_3.tex}
|
|
\input{Ref/Point_3.tex}
|
|
\input{Ref/Ray_3.tex}
|
|
\input{Ref/Segment_3.tex}
|
|
\input{Ref/Sphere_3.tex}
|
|
\input{Ref/Tetrahedron_3.tex}
|
|
\input{Ref/Triangle_3.tex}
|
|
\input{Ref/Vector_3.tex}
|
|
\input{Ref/Weighted_point_3.tex}
|
|
|
|
\subsection{Polymorphic Objects}
|
|
|
|
\input{Ref/Object.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/assign.tex}
|
|
\input{Ref/make_object.tex}
|
|
|
|
\clearpage
|
|
\section{Constants and Enumerations}
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
\input{Ref/Angle_enum.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Bounded_side.tex}
|
|
\clearpage
|
|
\input{Ref/Comparison_result.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Sign.tex}
|
|
\clearpage
|
|
\input{Ref/Orientation_enum.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Oriented_side.tex}
|
|
\clearpage
|
|
\input{Ref/CLOCKWISE.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/COUNTERCLOCKWISE.tex}
|
|
\clearpage
|
|
\input{Ref/COLLINEAR_const.tex}
|
|
\vspace*{3cm}
|
|
\input{Ref/LEFT_TURN_const.tex}
|
|
\vspace*{3cm}
|
|
\input{Ref/RIGHT_TURN_const.tex}
|
|
\clearpage
|
|
\input{Ref/COPLANAR_const.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/DEGENERATE.tex}
|
|
\clearpage
|
|
\input{Ref/Null_vector.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/NULL_VECTOR_const.tex}
|
|
\clearpage
|
|
\input{Ref/Origin.tex}
|
|
\vspace*{3cm}
|
|
\input{Ref/ORIGIN_const.tex}
|
|
\clearpage
|
|
\input{Ref/Identity_transformation.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Reflection.tex}
|
|
\clearpage
|
|
\input{Ref/Rotation.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Scaling.tex}
|
|
\clearpage
|
|
\input{Ref/Translation.tex}
|
|
|
|
\clearpage
|
|
\section{Global Functions}
|
|
|
|
\input{Ref/angle.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
\input{Ref/are_ordered_along_line.tex}
|
|
\input{Ref/are_strictly_ordered_along_line.tex}
|
|
\input{Ref/centroid.tex}
|
|
\input{Ref/circumcenter.tex}
|
|
\input{Ref/collinear.tex}
|
|
\input{Ref/collinear_are_ordered_along_line.tex}
|
|
\input{Ref/collinear_are_strictly_ordered_along_line.tex}
|
|
\input{Ref/compare_distance_to_point.tex}
|
|
\input{Ref/compare_signed_distance_to_line.tex}
|
|
\input{Ref/compare_signed_distance_to_plane.tex}
|
|
\input{Ref/compare_slopes.tex}
|
|
\input{Ref/compare_x.tex}
|
|
\input{Ref/compare_xy.tex}
|
|
\input{Ref/compare_xyz.tex}
|
|
\input{Ref/compare_x_at_y.tex}
|
|
\input{Ref/compare_y.tex}
|
|
\input{Ref/compare_y_at_x.tex}
|
|
\input{Ref/compare_yx.tex}
|
|
\input{Ref/compare_z.tex}
|
|
\input{Ref/coplanar.tex}
|
|
\input{Ref/coplanar_orientation.tex}
|
|
\input{Ref/coplanar_side_of_bounded_circle.tex}
|
|
\input{Ref/cross_product.tex}
|
|
\input{Ref/do_intersect.tex}
|
|
\input{Ref/do_overlap.tex}
|
|
\input{Ref/has_larger_distance_to_point.tex}
|
|
\input{Ref/has_larger_signed_distance_to_line.tex}
|
|
\input{Ref/has_larger_signed_distance_to_plane.tex}
|
|
\input{Ref/has_smaller_distance_to_point.tex}
|
|
\input{Ref/has_smaller_signed_distance_to_line.tex}
|
|
\input{Ref/has_smaller_signed_distance_to_plane.tex}
|
|
\input{Ref/intersection.tex}
|
|
\input{Ref/left_turn.tex}
|
|
\input{Ref/lexicographically_xyz_smaller.tex}
|
|
\input{Ref/lexicographically_xyz_smaller_or_equal.tex}
|
|
\input{Ref/lexicographically_xy_larger.tex}
|
|
\input{Ref/lexicographically_xy_larger_or_equal.tex}
|
|
\input{Ref/lexicographically_xy_smaller.tex}
|
|
\input{Ref/lexicographically_xy_smaller_or_equal.tex}
|
|
\input{Ref/midpoint.tex}
|
|
\input{Ref/operator+.tex}
|
|
\input{Ref/operator-.tex}
|
|
\input{Ref/operatorStar.tex}
|
|
\input{Ref/opposite.tex}
|
|
\input{Ref/orientation.tex}
|
|
\input{Ref/quotient_cartesian_to_homogeneous.tex}
|
|
\input{Ref/rational_rotation_approximation.tex}
|
|
\input{Ref/right_turn.tex}
|
|
\input{Ref/side_of_bounded_circle.tex}
|
|
\input{Ref/side_of_bounded_sphere.tex}
|
|
\input{Ref/side_of_oriented_circle.tex}
|
|
\input{Ref/side_of_oriented_sphere.tex}
|
|
\input{Ref/squared_distance.tex}
|
|
\input{Ref/squared_radius.tex}
|
|
\input{Ref/x_equal.tex}
|
|
\input{Ref/y_equal.tex}
|
|
\input{Ref/z_equal.tex}
|
|
|
|
\clearpage
|
|
\section{Kernel Function Object Concepts}
|
|
\input{Ref/Kernel_Angle_2.tex}
|
|
\input{Ref/Kernel_Angle_3.tex}
|
|
\input{Ref/Kernel_AreOrderedAlongLine_2.tex}
|
|
\input{Ref/Kernel_AreOrderedAlongLine_3.tex}
|
|
\input{Ref/Kernel_AreStrictlyOrderedAlongLine_2.tex}
|
|
\input{Ref/Kernel_AreStrictlyOrderedAlongLine_3.tex}
|
|
\input{Ref/Kernel_Assign_2.tex}
|
|
\input{Ref/Kernel_Assign_3.tex}
|
|
\input{Ref/Kernel_BoundedSide_2.tex}
|
|
\input{Ref/Kernel_BoundedSide_3.tex}
|
|
\input{Ref/Kernel_Circle_2.tex}
|
|
\input{Ref/Kernel_CollinearAreOrderedAlongLine_2.tex}
|
|
\input{Ref/Kernel_CollinearAreOrderedAlongLine_3.tex}
|
|
\input{Ref/Kernel_CollinearAreStrictlyOrderedAlongLine_2.tex}
|
|
\input{Ref/Kernel_CollinearAreStrictlyOrderedAlongLine_3.tex}
|
|
\input{Ref/Kernel_CollinearHasOn_2.tex}
|
|
\input{Ref/Kernel_Collinear_2.tex}
|
|
\input{Ref/Kernel_Collinear_3.tex}
|
|
\input{Ref/Kernel_CompareAngleWithXAxis_2.tex}
|
|
\input{Ref/Kernel_CompareDistance_2.tex}
|
|
\input{Ref/Kernel_CompareDistance_3.tex}
|
|
\input{Ref/Kernel_CompareSlope_2.tex}
|
|
\input{Ref/Kernel_CompareXAtY_2.tex}
|
|
\input{Ref/Kernel_CompareXYZ_3.tex}
|
|
\input{Ref/Kernel_CompareXY_2.tex}
|
|
\input{Ref/Kernel_CompareXY_3.tex}
|
|
\input{Ref/Kernel_CompareX_2.tex}
|
|
\input{Ref/Kernel_CompareX_3.tex}
|
|
\input{Ref/Kernel_CompareYAtX_2.tex}
|
|
\input{Ref/Kernel_CompareY_2.tex}
|
|
\input{Ref/Kernel_CompareY_3.tex}
|
|
\input{Ref/Kernel_CompareZ_3.tex}
|
|
\input{Ref/Kernel_ComputeArea_2.tex}
|
|
\input{Ref/Kernel_ComputeSquaredArea_3.tex}
|
|
\input{Ref/Kernel_ComputeSquaredDistance_2.tex}
|
|
\input{Ref/Kernel_ComputeSquaredDistance_3.tex}
|
|
\input{Ref/Kernel_ComputeSquaredLength_2.tex}
|
|
\input{Ref/Kernel_ComputeSquaredLength_3.tex}
|
|
\input{Ref/Kernel_ComputeSquaredRadius_2.tex}
|
|
\input{Ref/Kernel_ComputeSquaredRadius_3.tex}
|
|
\input{Ref/Kernel_ComputeVolume_3.tex}
|
|
%\input{Ref/Kernel_ComputeYAtX_2.tex}
|
|
\input{Ref/Kernel_ConstructBaseVector_3.tex}
|
|
\input{Ref/Kernel_ConstructBisector_2.tex}
|
|
\input{Ref/Kernel_ConstructCenter_2.tex}
|
|
\input{Ref/Kernel_ConstructCenter_3.tex}
|
|
\input{Ref/Kernel_ConstructCentroid_2.tex}
|
|
\input{Ref/Kernel_ConstructCentroid_3.tex}
|
|
\input{Ref/Kernel_ConstructCircle_2.tex}
|
|
\input{Ref/Kernel_ConstructCircumcenter_2.tex}
|
|
\input{Ref/Kernel_ConstructCircumcenter_3.tex}
|
|
\input{Ref/Kernel_ConstructCrossProductVector_3.tex}
|
|
\input{Ref/Kernel_ConstructDirection_2.tex}
|
|
\input{Ref/Kernel_ConstructDirection_3.tex}
|
|
\input{Ref/Kernel_ConstructIsoCuboid_3.tex}
|
|
\input{Ref/Kernel_ConstructIsoRectangle_2.tex}
|
|
\input{Ref/Kernel_ConstructLiftedPoint_3.tex}
|
|
\input{Ref/Kernel_ConstructLine_2.tex}
|
|
\input{Ref/Kernel_ConstructLine_3.tex}
|
|
\input{Ref/Kernel_ConstructMidpoint_2.tex}
|
|
\input{Ref/Kernel_ConstructMidpoint_3.tex}
|
|
\input{Ref/Kernel_ConstructObject_2.tex}
|
|
\input{Ref/Kernel_ConstructObject_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeCircle_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeDirection_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeDirection_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeLine_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeLine_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositePlane_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeRay_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeRay_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeSegment_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeSegment_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeSphere_3.tex}
|
|
\input{Ref/Kernel_ConstructOppositeTriangle_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeVector_2.tex}
|
|
\input{Ref/Kernel_ConstructOppositeVector_3.tex}
|
|
\input{Ref/Kernel_ConstructOrthogonalVector_3.tex}
|
|
\input{Ref/Kernel_ConstructPerpendicularDirection_2.tex}
|
|
\input{Ref/Kernel_ConstructPerpendicularLine_2.tex}
|
|
\input{Ref/Kernel_ConstructPerpendicularLine_3.tex}
|
|
\input{Ref/Kernel_ConstructPerpendicularPlane_3.tex}
|
|
\input{Ref/Kernel_ConstructPerpendicularVector_2.tex}
|
|
\input{Ref/Kernel_ConstructPlane_3.tex}
|
|
\input{Ref/Kernel_ConstructPointOn_2.tex}
|
|
\input{Ref/Kernel_ConstructPointOn_3.tex}
|
|
\input{Ref/Kernel_ConstructPoint_2.tex}
|
|
\input{Ref/Kernel_ConstructPoint_3.tex}
|
|
\input{Ref/Kernel_ConstructProjectedPoint_2.tex}
|
|
\input{Ref/Kernel_ConstructProjectedPoint_3.tex}
|
|
\input{Ref/Kernel_ConstructProjectedXYPoint_2.tex}
|
|
\input{Ref/Kernel_ConstructRay_2.tex}
|
|
\input{Ref/Kernel_ConstructRay_3.tex}
|
|
\input{Ref/Kernel_ConstructScaledVector_2.tex}
|
|
\input{Ref/Kernel_ConstructScaledVector_3.tex}
|
|
\input{Ref/Kernel_ConstructSegment_2.tex}
|
|
\input{Ref/Kernel_ConstructSegment_3.tex}
|
|
\input{Ref/Kernel_ConstructSphere_3.tex}
|
|
\input{Ref/Kernel_ConstructSupportingLine_2.tex}
|
|
\input{Ref/Kernel_ConstructSupportingLine_3.tex}
|
|
\input{Ref/Kernel_ConstructSupportingPlane_3.tex}
|
|
\input{Ref/Kernel_ConstructTetrahedron_3.tex}
|
|
\input{Ref/Kernel_ConstructTranslatedPoint_2.tex}
|
|
\input{Ref/Kernel_ConstructTranslatedPoint_3.tex}
|
|
\input{Ref/Kernel_ConstructTriangle_2.tex}
|
|
\input{Ref/Kernel_ConstructTriangle_3.tex}
|
|
\input{Ref/Kernel_ConstructVector_2.tex}
|
|
\input{Ref/Kernel_ConstructVector_3.tex}
|
|
\input{Ref/Kernel_ConstructVertex_2.tex}
|
|
\input{Ref/Kernel_ConstructVertex_3.tex}
|
|
\input{Ref/Kernel_CoplanarOrientation_3.tex}
|
|
\input{Ref/Kernel_CoplanarSideOfBoundedCircle_3.tex}
|
|
\input{Ref/Kernel_Coplanar_3.tex}
|
|
\input{Ref/Kernel_CounterclockwiseInBetween_2.tex}
|
|
\input{Ref/Kernel_Direction_2.tex}
|
|
\input{Ref/Kernel_Direction_3.tex}
|
|
\input{Ref/Kernel_DoIntersect_2.tex}
|
|
\input{Ref/Kernel_DoIntersect_3.tex}
|
|
\input{Ref/Kernel_EqualXY_3.tex}
|
|
\input{Ref/Kernel_EqualX_2.tex}
|
|
\input{Ref/Kernel_EqualX_3.tex}
|
|
\input{Ref/Kernel_EqualY_2.tex}
|
|
\input{Ref/Kernel_EqualY_3.tex}
|
|
\input{Ref/Kernel_EqualZ_3.tex}
|
|
\input{Ref/Kernel_Equal_2.tex}
|
|
\input{Ref/Kernel_Equal_3.tex}
|
|
\input{Ref/Kernel_HasOnBoundary_2.tex}
|
|
\input{Ref/Kernel_HasOnBoundary_3.tex}
|
|
\input{Ref/Kernel_HasOnBoundedSide_2.tex}
|
|
\input{Ref/Kernel_HasOnBoundedSide_3.tex}
|
|
\input{Ref/Kernel_HasOnNegativeSide_2.tex}
|
|
\input{Ref/Kernel_HasOnNegativeSide_3.tex}
|
|
\input{Ref/Kernel_HasOnPositiveSide_2.tex}
|
|
\input{Ref/Kernel_HasOnPositiveSide_3.tex}
|
|
\input{Ref/Kernel_HasOnUnboundedSide_2.tex}
|
|
\input{Ref/Kernel_HasOnUnboundedSide_3.tex}
|
|
\input{Ref/Kernel_HasOn_2.tex}
|
|
\input{Ref/Kernel_HasOn_3.tex}
|
|
\input{Ref/Kernel_Intersect_2.tex}
|
|
\input{Ref/Kernel_Intersect_3.tex}
|
|
\input{Ref/Kernel_IsDegenerate_2.tex}
|
|
\input{Ref/Kernel_IsDegenerate_3.tex}
|
|
\input{Ref/Kernel_IsHorizontal_2.tex}
|
|
\input{Ref/Kernel_IsoCuboid_3.tex}
|
|
\input{Ref/Kernel_IsoRectangle_2.tex}
|
|
\input{Ref/Kernel_IsVertical_2.tex}
|
|
\input{Ref/Kernel_LeftTurn_2.tex}
|
|
\input{Ref/Kernel_LessDistanceToPoint_2.tex}
|
|
\input{Ref/Kernel_LessDistanceToPoint_3.tex}
|
|
\input{Ref/Kernel_LessRotateCCW_2.tex}
|
|
\input{Ref/Kernel_LessSignedDistanceToLine_2.tex}
|
|
\input{Ref/Kernel_LessSignedDistanceToPlane_3.tex}
|
|
\input{Ref/Kernel_LessXYZ_3.tex}
|
|
\input{Ref/Kernel_LessXY_2.tex}
|
|
\input{Ref/Kernel_LessXY_3.tex}
|
|
\input{Ref/Kernel_LessX_2.tex}
|
|
\input{Ref/Kernel_LessX_3.tex}
|
|
\input{Ref/Kernel_LessYX_2.tex}
|
|
\input{Ref/Kernel_LessY_2.tex}
|
|
\input{Ref/Kernel_LessY_3.tex}
|
|
\input{Ref/Kernel_LessZ_3.tex}
|
|
\input{Ref/Kernel_Line_2.tex}
|
|
\input{Ref/Kernel_Line_3.tex}
|
|
\input{Ref/Kernel_Object_2.tex}
|
|
\input{Ref/Kernel_Object_3.tex}
|
|
\input{Ref/Kernel_Orientation_2.tex}
|
|
\input{Ref/Kernel_Orientation_3.tex}
|
|
\input{Ref/Kernel_OrientedSide_2.tex}
|
|
\input{Ref/Kernel_OrientedSide_3.tex}
|
|
\input{Ref/Kernel_Plane_3.tex}
|
|
\input{Ref/Kernel_Point_2.tex}
|
|
\input{Ref/Kernel_Point_3.tex}
|
|
\input{Ref/Kernel_Ray_2.tex}
|
|
\input{Ref/Kernel_Ray_3.tex}
|
|
\input{Ref/Kernel_Segment_2.tex}
|
|
\input{Ref/Kernel_Segment_3.tex}
|
|
\input{Ref/Kernel_SideOfBoundedCircle_2.tex}
|
|
\input{Ref/Kernel_SideOfBoundedSphere_3.tex}
|
|
\input{Ref/Kernel_SideOfOrientedCircle_2.tex}
|
|
\input{Ref/Kernel_SideOfOrientedSphere_3.tex}
|
|
\input{Ref/Kernel_Sphere_3.tex}
|
|
\input{Ref/Kernel_Tetrahedron_3.tex}
|
|
\input{Ref/Kernel_Triangle_2.tex}
|
|
\input{Ref/Kernel_Triangle_3.tex}
|
|
\input{Ref/Kernel_Vector_2.tex}
|
|
\input{Ref/Kernel_Vector_3.tex}
|
|
\input{Ref/Kernel_WeightedPoint_2.tex}
|
|
\input{Ref/Kernel_WeightedPoint_3.tex}
|
|
|
|
\section{Tag Classes}
|
|
\gdef\ccRefPageBreak{\ccFalse}
|
|
|
|
\input{Ref/Tag_false.tex}
|
|
\vspace*{4cm}
|
|
\input{Ref/Tag_true.tex}
|
|
\gdef\ccRefPageBreak{\ccTrue}
|
|
|
|
%% EOF
|