From a79bcb9e57d978c0c6afdd60006ff231ee27fcec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20M=C3=B6ller?= Date: Thu, 25 Aug 2011 16:11:47 +0000 Subject: [PATCH] Deprecating of Object concept, documentation --- .../Kernel_23_ref/Intersection_traits.tex | 6 ++- .../doc_tex/Kernel_23_ref/Kernel_Assign_2.tex | 5 ++- .../doc_tex/Kernel_23_ref/Kernel_Assign_3.tex | 4 ++ .../Kernel_ConstructObject_2.tex | 5 ++- .../Kernel_ConstructObject_3.tex | 5 ++- .../Kernel_23_ref/Kernel_Intersect_2.tex | 15 ++----- .../Kernel_23_ref/Kernel_Intersect_3.tex | 39 +++---------------- .../doc_tex/Kernel_23_ref/Kernel_Object_2.tex | 5 ++- .../doc_tex/Kernel_23_ref/Kernel_Object_3.tex | 4 ++ .../doc_tex/Kernel_23_ref/intersection.tex | 2 +- 10 files changed, 39 insertions(+), 51 deletions(-) diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Intersection_traits.tex b/Kernel_23/doc_tex/Kernel_23_ref/Intersection_traits.tex index b55e11e53a0..0cfd75132d5 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Intersection_traits.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Intersection_traits.tex @@ -1,4 +1,4 @@ -\begin{ccRefClass}{Intersection_traits, B} +\begin{ccRefClass}{Intersection_traits, B>} \ccInclude{CGAL/Intersection_traits.h} @@ -11,8 +11,12 @@ in the \ccc{intersection} documentation of the corresponding kernel. For convenience the alias \ccStyle{IT} is provided. +A list of all available specializations can be found in \ccRefIdfierPage{CGAL::intersection}. + \ccTypes \ccStyle{result_type} The type of the resulting intersection between \ccStyle{A} and \ccStyle{B}. \end{ccRefClass} +\ccSeeAlso +\ccRefIdfierPage{CGAL::intersection} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_2.tex index 4204d8ee651..f0ca3ab025c 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_2.tex @@ -1,6 +1,8 @@ \begin{ccRefFunctionObjectConcept}{Kernel::Assign_2} -A model for this must provide: +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. +A model for this must provide: \ccCreationVariable{fo} \ccMemberFunction{ @@ -19,4 +21,5 @@ Returns \ccc{true}, if the assignment was possible.} \ccRefConceptPage{Kernel::Object_2} \\ \ccRefConceptPage{Kernel::Intersect_2} \\ +\end{ccDeprecated} \end{ccRefFunctionObjectConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_3.tex index 23e1fcd5db5..7d0c6d1763e 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Assign_3.tex @@ -1,4 +1,7 @@ \begin{ccRefFunctionObjectConcept}{Kernel::Assign_3} +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. + A model for this must provide: \ccCreationVariable{fo} @@ -19,4 +22,5 @@ Returns \ccc{true}, if the assignment was possible.} \ccRefConceptPage{Kernel::Object_3} \\ \ccRefConceptPage{Kernel::Intersect_3} \\ +\end{ccDeprecated} \end{ccRefFunctionObjectConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_2.tex index 006e3450dbc..9bac5f0d2db 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_2.tex @@ -1,4 +1,7 @@ \begin{ccRefFunctionObjectConcept}{Kernel::ConstructObject_2} +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. + A model for this must provide: \ccCreationVariable{fo} @@ -18,5 +21,5 @@ Object_2 operator()(const T& t);} \ccRefConceptPage{Kernel::Assign_3} \\ \ccRefConceptPage{Kernel::Object_2} \\ \ccRefConceptPage{Kernel::Object_3} \\ - +\end{ccDeprecated} \end{ccRefFunctionObjectConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_3.tex index 79ff5b1a986..ab1c70f6506 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_ConstructObject_3.tex @@ -1,4 +1,7 @@ \begin{ccRefFunctionObjectConcept}{Kernel::ConstructObject_3} +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. + A model for this must provide: \ccCreationVariable{fo} @@ -18,5 +21,5 @@ Object_3 operator()(const T& t);} \ccRefConceptPage{Kernel::Assign_3} \\ \ccRefConceptPage{Kernel::Object_2} \\ \ccRefConceptPage{Kernel::Object_3} \\ - +\end{ccDeprecated} \end{ccRefFunctionObjectConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_2.tex index 55adf8ba2c6..215411a6859 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_2.tex @@ -3,20 +3,13 @@ A model for this must provide \ccCreationVariable{fo} -\ccMemberFunction{Kernel::Object_2 operator()(Type1 obj1, Type2 obj2);} +\ccMemberFunction{Intersection_traits, Type2>::result_type operator()(Type1 obj1, Type2 obj2);} {computes the \ccHtmlNoLinksFrom{intersection} region of two geometrical objects of type \ccStyle{Type1} and \ccStyle{Type2}} -for all pairs \ccStyle{Type1} and \ccStyle{Type2}, where -the types \ccStyle{Type1} and \ccStyle{Type2} can be any of the -following: -\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{} -\item \ccStyle{Kernel::Line_2} -\item \ccStyle{Kernel::Ray_2} -\item \ccStyle{Kernel::Segment_2} -\item \ccStyle{Kernel::Triangle_2} -\item \ccStyle{Kernel::Iso_rectangle_2} -\end{itemize} +The function is only defined for \ccStyle{Type} and \ccStyle{Type2} +when \ccStyle{Intersection_traits::result_type} is also defined. \ccRefines \ccc{AdaptableFunctor} (with two arguments) diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_3.tex index 51ee37577d6..519a08aa2d6 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Intersect_3.tex @@ -3,48 +3,19 @@ A model for this must provide \ccCreationVariable{fo} -\ccMemberFunction{Kernel::Object_3 operator()(Type1 obj1, Type2 obj2);} +\ccMemberFunction{Intersection_traits, Type2>::result_type operator()(Type1 obj1, Type2 obj2);} {computes the \ccHtmlNoLinksFrom{intersection} region of two geometrical objects of type \ccStyle{Type1} and \ccStyle{Type2}} -for all pairs \ccStyle{Type1} and \ccStyle{Type2}, where -the types \ccStyle{Type1} and -\ccStyle{Type2} can be any of the following: -\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{} -\item \ccStyle{Kernel::Plane_3} -\item \ccStyle{Kernel::Line_3} -\item \ccStyle{Kernel::Ray_3} -\item \ccStyle{Kernel::Segment_3} -\item \ccStyle{Kernel::Triangle_3} -\end{itemize} - -\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Sphere_3 s1, - Kernel::Sphere_3 s2);} -{computes the \ccHtmlNoLinksFrom{intersection} of two spheres. The result -can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3}, a -\ccc{Kernel::Sphere_3} or empty.} - -\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Plane_3 p, - Kernel::Sphere_3 s);} -{computes the \ccHtmlNoLinksFrom{intersection} of a plane and a sphere. The result -can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3} or empty.} - -\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Sphere_3 s, - Kernel::Plane_3 p);} -{computes the \ccHtmlNoLinksFrom{intersection} of a plane and a sphere. The result -can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Circle_3} or empty.} - -\ccMemberFunction{Kernel::Object_3 operator()(Kernel::Plane_3 pl1, - Kernel::Plane_3 pl2, - Kernel::Plane_3 pl3);} -{computes the \ccHtmlNoLinksFrom{intersection} of three planes. The result -can be either a \ccc{Kernel::Point_3}, a \ccc{Kernel::Line_3}, a -\ccc{Kernel::Plane_3}, or empty.} +The function is only defined for \ccStyle{Type} and \ccStyle{Type2} +when \ccStyle{Intersection_traits::result_type} is also defined. \ccRefines \ccc{AdaptableFunctor} (with two or three arguments) \ccSeeAlso \ccRefIdfierPage{CGAL::intersection}\\ +\ccRefIdfierPage{CGAL::Intersection_traits, B>}\\ \end{ccRefFunctionObjectConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_2.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_2.tex index 76fd24835b5..4438bcfe5f8 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_2.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_2.tex @@ -1,4 +1,7 @@ \begin{ccRefConcept}{Kernel::Object_2} +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. + A type representing different types of objects in two dimensions. \ccRefines @@ -9,5 +12,5 @@ CopyConstructible, Assignable, DefaultConstructible \ccRefConceptPage{Kernel::Assign_2}\\ \ccRefConceptPage{Kernel::ConstructObject_2} \\ \ccRefConceptPage{Kernel::Intersect_2} \\ - +\end{ccDeprecated} \end{ccRefConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_3.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_3.tex index 5e1aa6698b0..4aafedd2afd 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_3.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel_Object_3.tex @@ -1,4 +1,7 @@ \begin{ccRefConcept}{Kernel::Object_3} +\begin{ccDeprecated} +{\em Note} : this concept is deprecated since CGAL VERSION HERE and type safe ways should be preferred. + A type representing different types of objects in three dimensions. \ccRefines @@ -10,4 +13,5 @@ CopyConstructible, Assignable, DefaultConstructible \ccRefConceptPage{Kernel::ConstructObject_3} \\ \ccRefConceptPage{Kernel::Intersect_3} \\ +\end{ccDeprecated} \end{ccRefConcept} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex b/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex index 46ea6984d43..65b02be3ebc 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex @@ -658,7 +658,7 @@ and~\ref{chapter-spherical-kernel}. \ccSeeAlso \ccRefIdfierPage{CGAL::do_intersect}, \\ -\ccRefIdfierPage{CGAL::Intersection_traits, B}, \\ +\ccRefIdfierPage{CGAL::Intersection_traits< Kernel, A, B >}, \\ \ccAnchor{www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional}, \\ \ccAnchor{www.boost.org/doc/html/variant.html}{boost::variant}