songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Small documentation corrections

This commit is contained in:
Philipp Möller 2011-11-24 10:44:23 +00:00
parent a2d3b5444c
commit 26a94ab6bb
5 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Kernel_23/doc_tex/Kernel_23/kernel_toc.tex
View File

@ -91,7 +91,6 @@
\ccRefIdfierPage{CGAL::do_intersect} \\
\ccRefIdfierPage{CGAL::intersection} \\
\ccRefIdfierPage{CGAL::Intersection_traits<Kernel, A<Kernel>, B<Kernel>} \\
\ccRefIdfierPage{CGAL::squared_distance} \\
\subsubsection*{Predicates and Constructions}

6
Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
View File

@ -31,10 +31,11 @@ points \ccStyle{p} that are part of both \ccStyle{obj1} and \ccStyle{obj2}.
Note that for objects like triangles and polygons that enclose a
bounded region, this region is considered part of the object.
If a segment lies completely inside a triangle, then those two objects
intersect and the \ccHtmlNoLinksFrom{intersection} region is the complete segment.
intersect and the \ccHtmlNoLinksFrom{intersection} region is the complete segment.
Here, \ccStyle{Intersect_23} means either \ccStyle{Intersect_2} or \ccStyle{Intersect_3}, respectively.
}}
The same functionality is also available through the functors \ccc{Kernel::Intersect_2} and \ccc{Kernel::Intersect_2}.
The same functionality is also available through the functors \ccc{Kernel::Intersect_2} and \ccc{Kernel::Intersect_3}.
The possible values for types \ccStyle{Type1} and \ccStyle{Type2} and
the value for T\ldots in \ccStyle{boost::optional< boost::variant<
@ -124,7 +125,6 @@ type A & type B & \parbox{4 cm}{\vspace{1 mm}{return type}} \\
\ccStyle{Point_2}
\\ \ccStyle{Segment_2}
\\ \ccStyle{Triangle_2}
\\ \ccStyle{_2}
\vspace{1 mm}} \\
\hline
\ccStyle{Iso_rectangle_2} & \ccStyle{Iso_rectangle_2} & \parbox{4 cm}{\vspace{1 mm}

1
Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex
View File

@ -45,5 +45,4 @@
\ccRefIdfierPage{CGAL::do_intersect}\\
\ccRefIdfierPage{CGAL::intersection}\\
\ccRefIdfierPage{CGAL::Intersection_traits}

2
Kernel_d/doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex
View File

@ -4,7 +4,7 @@ A model for this must provide:
\ccCreationVariable{fo}
\ccMemberFunction{
Intersection_traits<K, Type1<K>, Type2<K> >::result_type
Kernel::Intersect_d::Result<Type1<K>, Type2<K> >::Type
operator()(const Type1<K>& p, const Type2<K>& q);}
{returns the result of the intersection of $p$ and $q$ in form of a
polymorphic object. \ccc{Kernel_object} may be any of

15
Kernel_d/doc_tex/Kernel_d_ref/intersection.tex
View File

@ -1,7 +1,7 @@
\begin{ccRefFunction}{intersection}
\ccInclude{CGAL/intersections_d.h}
\ccFunction{Intersection_traits<R, Type1<R>, Type2<R> >::result_type
\ccFunction{Kernel::Intersect_d::Result<Type1<K>, Type2<K> >::Type
intersection(Type1<R> f1, Type2<R> f2);} { returns the intersection
result of $f1$ and $f2$.
\ccPrecond The objects are of the same dimension.}
@ -162,15 +162,20 @@ struct Intersection_visitor {
template <class R>
void foo(Segment_d<R> seg, Line_d<R> lin)
{
ITd< R, Segment_d<R>, Line_d<R> >::result_type result = intersection(seg, lin);
R::Intersect_d::template Result< Segment_d<R>, Line_d<R> >
result = intersection(seg, lin);
if(result) { boost::apply_visitor(Intersection_visitor<R>(), *result); }
else { /* no intersection */ }
}
\end{verbatim}%
\ccHtmlLinksOn%
\ccSeeAlso \ccc{do_intersect}, \ccc{Kernel::Intersect_d} ,
\ccc{Kernel::Do_intersect_d}, \ccAnchor{www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional},
\ccAnchor{www.boost.org/doc/html/variant.html}{boost::variant}
\ccSeeAlso
\ccc{do_intersect}, \\
\ccc{Kernel::Intersect_d}, \\
\ccc{Kernel::Do_intersect_d}, \\
\ccAnchor{http://www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional}, \\
\ccAnchor{http://www.boost.org/doc/html/variant.html}{boost::variant} \\
\end{ccRefFunction}