From 8555cd3ec7324cfd172497a2384d9ab89c43bbfc Mon Sep 17 00:00:00 2001 From: Marc Pouget Date: Tue, 20 Feb 2007 11:00:07 +0000 Subject: [PATCH] added global fct bis! --- Ridges_3/doc_tex/Ridges_3_ref/Ridge_order.tex | 42 ++++++++++++ .../Ridges_3_ref/compute_crest_ridges.tex | 64 +++++++++++++++++++ .../Ridges_3_ref/compute_max_ridges.tex | 64 +++++++++++++++++++ .../Ridges_3_ref/compute_min_ridges.tex | 64 +++++++++++++++++++ 4 files changed, 234 insertions(+) create mode 100644 Ridges_3/doc_tex/Ridges_3_ref/Ridge_order.tex create mode 100644 Ridges_3/doc_tex/Ridges_3_ref/compute_crest_ridges.tex create mode 100644 Ridges_3/doc_tex/Ridges_3_ref/compute_max_ridges.tex create mode 100644 Ridges_3/doc_tex/Ridges_3_ref/compute_min_ridges.tex diff --git a/Ridges_3/doc_tex/Ridges_3_ref/Ridge_order.tex b/Ridges_3/doc_tex/Ridges_3_ref/Ridge_order.tex new file mode 100644 index 00000000000..e55e7fc2c08 --- /dev/null +++ b/Ridges_3/doc_tex/Ridges_3_ref/Ridge_order.tex @@ -0,0 +1,42 @@ +% +------------------------------------------------------------------------+ +% | Reference manual page: Ridge_order.tex +% +------------------------------------------------------------------------+ +% | 15.09.2006 Marc Pouget and Frédéric Cazals +% | Package: Ridges_3 +% | +\RCSdef{\RCSRidgeorderRev}{$Id$} +\RCSdefDate{\RCSRidgeorderDate}{$Date$} +% | +%%RefPage: end of header, begin of main body +% +------------------------------------------------------------------------+ + + +\begin{ccRefEnum}{Ridge_order} %% add template arg's if necessary + +%% \ccHtmlCrossLink{} %% add further rules for cross referencing links +%% \ccHtmlIndexC[enum]{} %% add further index entries + +\ccDefinition + +The enum \ccRefName\ describes the order of differential quantities +used to distinguish elliptic and hyperbolic ridges. Third or fourth +order quantities may be used as explained in section \ref{ridge-mesh} +of the user manual. + +\ccInclude{CGAL/Ridges.h} + +\ccGlobalEnum{enum Ridge_order { + Ridge_order_3 = 3, Ridge_order_4};} + + +\ccSeeAlso + +\ccc{Ridge_approximation} + +\end{ccRefEnum} + +% +------------------------------------------------------------------------+ +%%RefPage: end of main body, begin of footer +% EOF +% +------------------------------------------------------------------------+ + diff --git a/Ridges_3/doc_tex/Ridges_3_ref/compute_crest_ridges.tex b/Ridges_3/doc_tex/Ridges_3_ref/compute_crest_ridges.tex new file mode 100644 index 00000000000..13d4a1ae90f --- /dev/null +++ b/Ridges_3/doc_tex/Ridges_3_ref/compute_crest_ridges.tex @@ -0,0 +1,64 @@ +% +------------------------------------------------------------------------+ +% | Reference manual page: compute_crest_ridges.tex +% +------------------------------------------------------------------------+ +% | 15.09.2006 Marc Pouget and Frédéric Cazals +% | Package: Ridges_3 +% | +\RCSdef{\RCScomputecrestridgesRev}{$Id$} +\RCSdefDate{\RCScomputecrestridgesDate}{$Date$} +% | +%%RefPage: end of header, begin of main body +% +------------------------------------------------------------------------+ + + +\begin{ccRefFunction}{compute_crest_ridges} +%% add templatearg's if necessary + +%% \ccHtmlCrossLink{} %% add further rules for cross referencing links +%% \ccHtmlIndexC[class]{} %% add further index entries + +\ccDefinition + +The function \ccRefName\ is a short cut to the method of the same name +of the class \ccc{Ridge_approximation}. + +\ccInclude{CGAL/Ridges.h} + +%\ccNestedType{TYPE}{some nested types} +% \ccEnum{ enum Tag_order {Tag_3, Tag_4};} {Order of differential +% quantities used to distinguish elliptic and hyperbolic ridges. Third +% (\ccc{Tag_3}) or fourth (\ccc{Tag_4}) order quantities may be used as +% explained in section \ref{ridge-mesh} of the user manual.} + + + +\ccFunction{template < class TriangulatedSurfaceMesh, + class Vertex2FTPropertyMap, + class Vertex2VectorPropertyMap, + class OutputIterator> + OutputIterator compute_crest_ridges(const TriangulatedSurfaceMesh &P, + const Vertex2FTPropertyMap& vertex2k1_pm, const + Vertex2FTPropertyMap& vertex2k2_pm, const + Vertex2FTPropertyMap& vertex2b0_pm, const + Vertex2FTPropertyMap& vertex2b3_pm, const + Vertex2VectorPropertyMap& vertex2d1_pm, const + Vertex2VectorPropertyMap& vertex2d2_pm, const + Vertex2FTPropertyMap& vertex2P1_pm, const + Vertex2FTPropertyMap& vertex2P2_pm, + OutputIterator it, + CGAL::Ridge_order order = CGAL::Ridge_order_3);} + {} + +%\ccOperations + +\ccSeeAlso + +\ccc{Ridge_approximation} + +\end{ccRefFunction} + +% +------------------------------------------------------------------------+ +%%RefPage: end of main body, begin of footer +% EOF +% +------------------------------------------------------------------------+ + diff --git a/Ridges_3/doc_tex/Ridges_3_ref/compute_max_ridges.tex b/Ridges_3/doc_tex/Ridges_3_ref/compute_max_ridges.tex new file mode 100644 index 00000000000..4bcdfc78e3b --- /dev/null +++ b/Ridges_3/doc_tex/Ridges_3_ref/compute_max_ridges.tex @@ -0,0 +1,64 @@ +% +------------------------------------------------------------------------+ +% | Reference manual page: compute_max_ridges.tex +% +------------------------------------------------------------------------+ +% | 15.09.2006 Marc Pouget and Frédéric Cazals +% | Package: Ridges_3 +% | +\RCSdef{\RCScomputemaxridgesRev}{$Id$} +\RCSdefDate{\RCScomputemaxridgesDate}{$Date$} +% | +%%RefPage: end of header, begin of main body +% +------------------------------------------------------------------------+ + + +\begin{ccRefFunction}{compute_max_ridges} +%% add templatearg's if necessary + +%% \ccHtmlCrossLink{} %% add further rules for cross referencing links +%% \ccHtmlIndexC[class]{} %% add further index entries + +\ccDefinition + +The function \ccRefName\ is a short cut to the method of the same name +of the class \ccc{Ridge_approximation}. + +\ccInclude{CGAL/Ridges.h} + +%\ccNestedType{TYPE}{some nested types} +% \ccEnum{ enum Tag_order {Tag_3, Tag_4};} {Order of differential +% quantities used to distinguish elliptic and hyperbolic ridges. Third +% (\ccc{Tag_3}) or fourth (\ccc{Tag_4}) order quantities may be used as +% explained in section \ref{ridge-mesh} of the user manual.} + + + +\ccFunction{template < class TriangulatedSurfaceMesh, + class Vertex2FTPropertyMap, + class Vertex2VectorPropertyMap, + class OutputIterator> + OutputIterator compute_max_ridges(const TriangulatedSurfaceMesh &P, + const Vertex2FTPropertyMap& vertex2k1_pm, const + Vertex2FTPropertyMap& vertex2k2_pm, const + Vertex2FTPropertyMap& vertex2b0_pm, const + Vertex2FTPropertyMap& vertex2b3_pm, const + Vertex2VectorPropertyMap& vertex2d1_pm, const + Vertex2VectorPropertyMap& vertex2d2_pm, const + Vertex2FTPropertyMap& vertex2P1_pm, const + Vertex2FTPropertyMap& vertex2P2_pm, + OutputIterator it, + CGAL::Ridge_order order = CGAL::Ridge_order_3);} + {} + +%\ccOperations + +\ccSeeAlso + +\ccc{Ridge_approximation} + +\end{ccRefFunction} + +% +------------------------------------------------------------------------+ +%%RefPage: end of main body, begin of footer +% EOF +% +------------------------------------------------------------------------+ + diff --git a/Ridges_3/doc_tex/Ridges_3_ref/compute_min_ridges.tex b/Ridges_3/doc_tex/Ridges_3_ref/compute_min_ridges.tex new file mode 100644 index 00000000000..a4a9036288e --- /dev/null +++ b/Ridges_3/doc_tex/Ridges_3_ref/compute_min_ridges.tex @@ -0,0 +1,64 @@ +% +------------------------------------------------------------------------+ +% | Reference manual page: compute_min_ridges.tex +% +------------------------------------------------------------------------+ +% | 15.09.2006 Marc Pouget and Frédéric Cazals +% | Package: Ridges_3 +% | +\RCSdef{\RCScomputeminridgesRev}{$Id$} +\RCSdefDate{\RCScomputeminridgesDate}{$Date$} +% | +%%RefPage: end of header, begin of main body +% +------------------------------------------------------------------------+ + + +\begin{ccRefFunction}{compute_min_ridges} +%% add templatearg's if necessary + +%% \ccHtmlCrossLink{} %% add further rules for cross referencing links +%% \ccHtmlIndexC[class]{} %% add further index entries + +\ccDefinition + +The function \ccRefName\ is a short cut to the method of the same name +of the class \ccc{Ridge_approximation}. + +\ccInclude{CGAL/Ridges.h} + +%\ccNestedType{TYPE}{some nested types} +% \ccEnum{ enum Tag_order {Tag_3, Tag_4};} {Order of differential +% quantities used to distinguish elliptic and hyperbolic ridges. Third +% (\ccc{Tag_3}) or fourth (\ccc{Tag_4}) order quantities may be used as +% explained in section \ref{ridge-mesh} of the user manual.} + + + +\ccFunction{template < class TriangulatedSurfaceMesh, + class Vertex2FTPropertyMap, + class Vertex2VectorPropertyMap, + class OutputIterator> + OutputIterator compute_min_ridges(const TriangulatedSurfaceMesh &P, + const Vertex2FTPropertyMap& vertex2k1_pm, const + Vertex2FTPropertyMap& vertex2k2_pm, const + Vertex2FTPropertyMap& vertex2b0_pm, const + Vertex2FTPropertyMap& vertex2b3_pm, const + Vertex2VectorPropertyMap& vertex2d1_pm, const + Vertex2VectorPropertyMap& vertex2d2_pm, const + Vertex2FTPropertyMap& vertex2P1_pm, const + Vertex2FTPropertyMap& vertex2P2_pm, + OutputIterator it, + CGAL::Ridge_order order = CGAL::Ridge_order_3);} + {} + +%\ccOperations + +\ccSeeAlso + +\ccc{Ridge_approximation} + +\end{ccRefFunction} + +% +------------------------------------------------------------------------+ +%%RefPage: end of main body, begin of footer +% EOF +% +------------------------------------------------------------------------+ +