mirror of https://github.com/CGAL/cgal
Replaced temporay hack in generate_reference_manual r49560:
Use [A-Z][a-z]+[A-Z]\w* regex to match concepts names and wrap them by \ccc{}.
This commit is contained in:
parent
9b54a2275c
commit
d2d7321ef2
|
|
@ -263,24 +263,26 @@ sub latex_mangle
|
|||
# There is no \ccSubHeading macro yet
|
||||
$buf =~ s/\\ccSubHeading\{/\\subsubsection\{/g;
|
||||
|
||||
#
|
||||
# Trust user
|
||||
#
|
||||
|
||||
# Emphasize words surrounded by double quotes using \em, by stars using \bf [L. Saboret's extension].
|
||||
$buf =~ s/"(.*?)"/\{\\em $1\}/g;
|
||||
$buf =~ s/\*(\w*?)\*/\{\\bf $1\}/g;
|
||||
|
||||
# Wrap words surrounded by simple quotes by \ccc{} [L. Saboret's extension].
|
||||
#
|
||||
# \ccInclude, \ccHeading, \ccNestedType, \ccEnum, \ccConstructor, \ccMethod, \ccVariable & \ccFunction
|
||||
# first curly braces pair must contain plain C++ code.
|
||||
# For the other lines, we wrap API items (concepts, classes, ...) by \ccc{} and we protect
|
||||
# other occurences of _ as \_ (including \subsubsection).
|
||||
#
|
||||
|
||||
# 1) Trust user: wrap words surrounded by simple quotes by \ccc{} [L. Saboret's extension].
|
||||
# Note: we use a one-liner to not insert a \ccc{} call inside an another one.
|
||||
$buf =~ s/\'(((::|\w)+(<.*?>)?)+)\'/\\ccc\{$1\}/g;
|
||||
|
||||
# Add carriage returns around \ccc{} for the line by line substitution below.
|
||||
# Note: make sure to insert only one \n before and after each \ccc{} call.
|
||||
$buf =~ s/(\\ccc\{.*?\})/\n$1\n/g;
|
||||
|
||||
# \ccInclude, \ccHeading, \ccNestedType, \ccEnum, \ccConstructor, \ccMethod, \ccVariable & \ccFunction
|
||||
# first curly braces pair must contain plain C++ code.
|
||||
# \subsubsection must protect _ as \_.
|
||||
# For the other lines, we wrap C++ types by \ccc{}.
|
||||
# 2) Try to be smart: wrap C++ types, including template params, by \ccc{}.
|
||||
@lines = split(/\n/, $buf);
|
||||
$buf = "";
|
||||
foreach $line (@lines) {
|
||||
|
|
@ -296,22 +298,18 @@ sub latex_mangle
|
|||
}
|
||||
else
|
||||
{
|
||||
#
|
||||
# Try to be smart
|
||||
#
|
||||
|
||||
# Wrap C++ types, including template params, by \ccc{}.
|
||||
# Note: we use a one-liner to not insert a \ccc{} call inside an another one.
|
||||
$line =~ s/((\w*(_|::)\w*(<.*?>)?)+)/\\ccc\{$1\}/g;
|
||||
|
||||
# Add carriage returns around \ccc{} for the line by line substitution below.
|
||||
# Note: make sure to insert only one \n before and after each \ccc{} call.
|
||||
$line =~ s/(\\ccc\{.*?\})/\n$1\n/g;
|
||||
}
|
||||
$buf = $buf . $line . "\n"; # concat lines back to $buf
|
||||
}
|
||||
|
||||
# \ccInclude, \ccHeading, \ccNestedType, \ccEnum, \ccConstructor, \ccMethod, \ccVariable & \ccFunction
|
||||
# first curly braces pair and \ccc expressions must contain plain C++ code.
|
||||
# For the other lines, we wrap concepts name by \ccc{}.
|
||||
# 3) Try to be smart: concepts name by \ccc{}.
|
||||
@lines = split(/\n/, $buf);
|
||||
$buf = "";
|
||||
foreach $line (@lines) {
|
||||
|
|
@ -321,29 +319,24 @@ sub latex_mangle
|
|||
{
|
||||
# nothing to do
|
||||
}
|
||||
elsif ($line =~ /\\subsubsection/)
|
||||
{
|
||||
# nothing to do
|
||||
}
|
||||
else
|
||||
{
|
||||
#
|
||||
# Try to be smart
|
||||
#
|
||||
|
||||
# Wrap concepts name by \ccc{}.
|
||||
# TODO: replace hard coded list of concepts by regex like [A-Z][a-z]+[A-Z]\w*
|
||||
$line =~ s/\b(PolylineSimplificationCostFunction)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(PolylineSimplificationStopPredicate)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(PolylineSimplificationVertex)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(ImplicitFunction)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(InputIterator)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(OutputIterator)\b/\\ccc{$1\}/g;
|
||||
$line =~ s/\b(ForwardIterator)\b/\\ccc{$1\}/g;
|
||||
# Note: we use a one-liner to not insert a \ccc{} call inside an another one.
|
||||
$line =~ s/\b([A-Z][a-z]+[A-Z]\w*)\b/\\ccc{$1\}/g;
|
||||
|
||||
# Add carriage returns around \ccc{} for the line by line substitution below.
|
||||
# Note: make sure to insert only one \n before and after each \ccc{} call.
|
||||
$line =~ s/(\\ccc\{.*?\})/\n$1\n/g;
|
||||
}
|
||||
$buf = $buf . $line . "\n"; # concat lines back to $buf
|
||||
}
|
||||
|
||||
# \ccInclude, \ccHeading, \ccNestedType, \ccEnum, \ccConstructor, \ccMethod, \ccVariable & \ccFunction
|
||||
# 4) \ccInclude, \ccHeading, \ccNestedType, \ccEnum, \ccConstructor, \ccMethod, \ccVariable & \ccFunction
|
||||
# first curly braces pair and \ccc expressions must contain plain C++ code.
|
||||
# The other lines must contain regular latex text => we mangle back
|
||||
# ~, <, >, *, &, [] characters (see latex_unmangle() above).
|
||||
|
|
@ -375,7 +368,7 @@ sub latex_mangle
|
|||
$buf = $buf . $line . "\n"; # concat lines back to $buf
|
||||
}
|
||||
|
||||
# Remove extra carriage returns around \ccc{} expressions
|
||||
# 5) Remove extra carriage returns around \ccc{} expressions
|
||||
$buf =~ s/\n(\\ccc{.*?\})\n/$1/smg;
|
||||
|
||||
# Return the formatted string
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Computes average spacing from k nearest neighbors.
|
|||
\ccPrecond k $>$= 2.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} average spacing (scalar).
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ This method modifies the order of input points so as to pack all remaining point
|
|||
\ccPrecond epsilon $>$ 0.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} iterator over the first point to remove.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Estimates normal directions of the [first, beyond) range of points using jet fit
|
|||
\ccPrecond k $>$= 2.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}. \end{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}. \end{description}
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{first}: iterator over the first input point. \item \ccc{beyond}: past-the-end iterator over the input points. \item \ccc{point_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Point_3}. \item \ccc{normal_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Vector_3}. \item \ccc{k}: number of neighbors. \item \ccc{kernel}: geometric traits. \end{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Smoothes the [first, beyond) range of points using jet fitting on the k nearest
|
|||
\ccPrecond k $>$= 2.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}. \end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}. \end{description}
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{first}: iterator over the first input point. \item \ccc{beyond}: past-the-end iterator over the input points. \item \ccc{point_pmap}: property map \ccc{ForwardIterator} -$>$ \ccc{Point_3}. \item \ccc{k}: number of neighbors. \item \ccc{kernel}: geometric traits. \end{description}
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ Orients the normals of the [first, beyond) range of points using the propagation
|
|||
\item Normals must be unit vectors.\item k $>$= 2.\end{itemize}
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::ReadWritePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{IndexPMap}: must be a model of \ccc{boost::ReadablePropertyMap} with an integral \ccc{value_type}. It can be omitted and will default to a \ccc{std::map<ForwardIterator, int>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::ReadWritePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{IndexPMap}: must be a model of \ccc{boost::ReadablePropertyMap} with an integral \ccc{value_type}. It can be omitted and will default to a \ccc{std::map<ForwardIterator, int>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} iterator over the first point with an unoriented normal.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Estimates normal directions of the [first, beyond) range of points by linear lea
|
|||
\ccPrecond k $>$= 2.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}. \end{description}
|
||||
\item \ccc{InputIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{NormalPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Vector_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}. \end{description}
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{first}: iterator over the first input point. \item \ccc{beyond}: past-the-end iterator over the input points. \item \ccc{point_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Point_3}. \item \ccc{normal_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Vector_3}. \item \ccc{k}: number of neighbors. \item \ccc{kernel}: geometric traits. \end{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Randomly deletes a user-specified fraction of the input points.
|
|||
This method modifies the order of input points so as to pack all remaining points first, and returns an iterator over the first point to remove (see erase-remove idiom). For this reason it should not be called on sorted containers.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} iterator over the first point to remove.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ Faces are ignored.
|
|||
Reads points (positions only) from a .off ASCII stream. Faces are ignored.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{OutputIterator}: iterator over output points. \item \ccc{PointPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{OutputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{OutputIterator}: iterator over output points. \item \ccc{PointPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{OutputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} true on success.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
Reads points (positions only) from a .xyz ASCII stream.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{OutputIterator}: iterator over output points. \item \ccc{PointPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{OutputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{OutputIterator}: iterator over output points. \item \ccc{PointPMap}: is a model of \ccc{boost::WritablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{OutputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} true on success.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ This method modifies the order of input points so as to pack all remaining point
|
|||
\ccPrecond k $>$= 2.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} iterator over the first point to remove.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
Saves the [first, beyond) range of points (positions only) to a .off ASCII stream.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} true on success.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
Saves the [first, beyond) range of points (positions only) to a .xyz ASCII stream.
|
||||
\ccCommentHeading{Template Parameters}
|
||||
\begin{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from PointPMap \ccc{value_type}.\end{description}
|
||||
\item \ccc{ForwardIterator}: iterator over input points. \item \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \item \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.\end{description}
|
||||
\ccCommentHeading{Returns} true on success.
|
||||
\ccCommentHeading{Parameters}
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ Optimization:\begin{itemize}
|
|||
|
||||
\ccc{Taucs_matrix<T>} \\
|
||||
\ccc{Taucs_symmetric_matrix<T>} \\
|
||||
\ccc{OpenNL::SparseMatrix<T>} in OpenNL package
|
||||
\ccc{OpenNL::SparseMatrix<T>} in \ccc{OpenNL} package
|
||||
|
||||
%END-AUTO(\ccHasModels)
|
||||
|
||||
|
|
|
|||
|
|
@ -142,7 +142,7 @@ Iterator over vertices of the mesh {\em main border}. Model of the \ccc{ForwardI
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_circulator}
|
||||
{
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the BidirectionalCirculator concept.
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_const_circulator}
|
||||
|
|
@ -151,7 +151,7 @@ Counter-clockwise circulator over a facet's vertices. Model of the Bidirectional
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_circulator}
|
||||
{
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the BidirectionalCirculator concept.
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_const_circulator}
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ Iterator over vertices of the mesh {\em main border}. Model of the \ccc{ForwardI
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_circulator}
|
||||
{
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the BidirectionalCirculator concept.
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_const_circulator}
|
||||
|
|
@ -187,7 +187,7 @@ Counter-clockwise circulator over a facet's vertices. Model of the Bidirectional
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_circulator}
|
||||
{
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the BidirectionalCirculator concept.
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_const_circulator}
|
||||
|
|
|
|||
|
|
@ -180,7 +180,7 @@ Iterator over vertices of the mesh {\em main border}. Model of the \ccc{ForwardI
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_circulator}
|
||||
{
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the BidirectionalCirculator concept.
|
||||
Counter-clockwise circulator over a facet's vertices. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_facet_const_circulator}
|
||||
|
|
@ -189,7 +189,7 @@ Counter-clockwise circulator over a facet's vertices. Model of the Bidirectional
|
|||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_circulator}
|
||||
{
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the BidirectionalCirculator concept.
|
||||
Clockwise circulator over the vertices incident to a vertex. Model of the \ccc{BidirectionalCirculator} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vertex_around_vertex_const_circulator}
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ Read/write access to a vector coefficient.
|
|||
%START-AUTO(\ccHasModels)
|
||||
|
||||
\ccc{Taucs_vector<T>} \\
|
||||
\ccc{OpenNL::FullVector<T>} in OpenNL package
|
||||
\ccc{OpenNL::FullVector<T>} in \ccc{OpenNL} package
|
||||
|
||||
%END-AUTO(\ccHasModels)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue