mirror of https://github.com/CGAL/cgal
Merge pull request #5596 from sloriot/Doc-precompiled_demos
Add doc for precompiled demos
This commit is contained in:
Sebastien Loriot
GitHub
commit
0c6404d1bc
|
|
@ -37,7 +37,7 @@ does not make sense if the traits class already provides exact constructions.
|
|||
<ul>
|
||||
<li>When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink,
|
||||
the class `Cartesian_converter` is used internally to switch between the traits class
|
||||
and the %CGAL kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
|
||||
and the \cgal kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
|
||||
`CGAL::Exact_rational`. `Cartesian_converter` must thus offer the necessary functors
|
||||
to convert a two-dimensional point of the traits class to a two-dimensional point
|
||||
of `CGAL::Simple_cartesian<NT>`. However, these functors are not necessarily provided by
|
||||
|
|
@ -106,7 +106,7 @@ allowing filtered exact comparisons (that is, interval arithmetic is first used
|
|||
resorting to exact arithmetic). Access to the interval containing the exact value is provided through the function
|
||||
`FT::Approximate_nt approx() const` where `FT::Approximate_nt` is `CGAL::Interval_nt<Protected>`
|
||||
with `Protected=true`. Access to the exact value is provided through the function
|
||||
`FT::Exact_nt exact() const` where `FT::Exact_nt` depends on the configuration of %CGAL
|
||||
`FT::Exact_nt exact() const` where `FT::Exact_nt` depends on the configuration of \cgal
|
||||
(it is `Gmpq` if `gmp` is available and `Quotient<CGAL::MP_Float>` otherwise).
|
||||
An overload for the function `double to_double(FT)` is also available. Its
|
||||
precision is controlled through `FT::set_relative_precision_of_to_double()` in
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ meaning in particular that the alpha complex may have
|
|||
singular faces. For \f$ 0 \leq k \leq d-1\f$,
|
||||
a \f$ k\f$-simplex of the alpha complex is said to be
|
||||
singular if it is not a facet of a \f$ (k+1)\f$-simplex of the complex.
|
||||
%CGAL provides two versions of alpha shapes. In the general mode,
|
||||
\cgal provides two versions of alpha shapes. In the general mode,
|
||||
the alpha shapes correspond strictly to the above definition.
|
||||
The regularized mode provides a regularized version of the alpha shapes.
|
||||
It corresponds to the domain covered by a regularized version
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ does not make sense if the traits class already provides exact constructions.
|
|||
<ul>
|
||||
<li>When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink,
|
||||
the class `Cartesian_converter` is used internally to switch between the traits class
|
||||
and the %CGAL kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
|
||||
and the \cgal kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
|
||||
`CGAL::Exact_rational`. `Cartesian_converter` must thus offer the necessary functors
|
||||
to convert a three-dimensional point of the traits class to a three-dimensional point
|
||||
of `CGAL::Simple_cartesian<NT>`. However, these functors are not necessarily provided by
|
||||
|
|
@ -103,7 +103,7 @@ allowing filtered exact comparisons (that is, interval arithmetic is first used
|
|||
resorting to exact arithmetic). Access to the interval containing the exact value is provided through the function
|
||||
`FT::Approximate_nt approx() const` where `FT::Approximate_nt` is `Interval_nt<Protected>`
|
||||
with `Protected=true`. Access to the exact value is provided through the function
|
||||
`FT::Exact_nt exact() const` where `FT::Exact_nt` depends on the configuration of %CGAL
|
||||
`FT::Exact_nt exact() const` where `FT::Exact_nt` depends on the configuration of \cgal
|
||||
(it may be `mpq_class`, `Gmpq`, `Quotient<CGAL::MP_Float>`, etc).
|
||||
An overload for the function `double to_double(FT)` is also available. Its
|
||||
precision is controlled through `FT::set_relative_precision_of_to_double()` in
|
||||
|
|
|
|||
|
|
@ -246,7 +246,7 @@ void box_intersection_all_pairs_d(
|
|||
|
||||
The first template parameter of the function enables to choose whether
|
||||
the algorithm is to be run in parallel, if `CGAL::Parallel_tag` is specified
|
||||
and %CGAL has been linked with the Intel TBB library, or sequentially,
|
||||
and \cgal has been linked with the Intel TBB library, or sequentially,
|
||||
if `CGAL::Sequential_tag` - the default value - is specified.
|
||||
The parallelization of the algorithm is based on a divide-and-conquer
|
||||
approach: the two ranges are split in a number of smaller ranges, and
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ public:
|
|||
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
algorithm. Possible values are `Parallel_tag` (default value if
|
||||
%CGAL is linked with TBB) or `Sequential_tag` (default value
|
||||
\cgal is linked with TBB) or `Sequential_tag` (default value
|
||||
otherwise).
|
||||
|
||||
\param ground_truth vector of label indices. It should contain for
|
||||
|
|
|
|||
|
|
@ -226,7 +226,7 @@ public:
|
|||
is `CGAL::Point_3`.
|
||||
\tparam NeighborQuery model of `NeighborQuery`
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
algorithm. Possible values are `Parallel_tag` (default value if %CGAL
|
||||
algorithm. Possible values are `Parallel_tag` (default value if \cgal
|
||||
is linked with TBB) or `Sequential_tag` (default value otherwise).
|
||||
\tparam DiagonalizeTraits model of `DiagonalizeTraits` used for
|
||||
matrix diagonalization. It can be omitted if Eigen 3 (or greater)
|
||||
|
|
@ -308,7 +308,7 @@ public:
|
|||
\tparam FaceListGraph model of `FaceListGraph`.
|
||||
\tparam NeighborQuery model of `NeighborQuery`
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
algorithm. Possible values are `Parallel_tag` (default value if %CGAL
|
||||
algorithm. Possible values are `Parallel_tag` (default value if \cgal
|
||||
is linked with TBB) or `Sequential_tag` (default value otherwise).
|
||||
\tparam DiagonalizeTraits model of `DiagonalizeTraits` used for
|
||||
matrix diagonalization. It can be omitted: if Eigen 3 (or greater)
|
||||
|
|
@ -392,7 +392,7 @@ public:
|
|||
`RandomAccessIterator` and its value type is the key type of
|
||||
`PointMap`.
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
algorithm. Possible values are `Parallel_tag` (default value if %CGAL
|
||||
algorithm. Possible values are `Parallel_tag` (default value if \cgal
|
||||
is linked with TBB) or `Sequential_tag` (default value otherwise).
|
||||
\tparam DiagonalizeTraits model of `DiagonalizeTraits` used for
|
||||
matrix diagonalization. It can be omitted: if Eigen 3 (or greater)
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ namespace Classification {
|
|||
is `GeomTraits::Point_3`.
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
computation of `CGAL::Classification::Local_eigen_analysis`
|
||||
objects. Possible values are `Parallel_tag` (default value if %CGAL
|
||||
objects. Possible values are `Parallel_tag` (default value if \cgal
|
||||
is linked with TBB) or `Sequential_tag` (default value otherwise).
|
||||
\tparam DiagonalizeTraits model of `DiagonalizeTraits` used for
|
||||
matrix diagonalization. It can be omitted: if Eigen 3 (or greater)
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ namespace Classification {
|
|||
is `GeomTraits::Point_3`.
|
||||
\tparam ConcurrencyTag enables sequential versus parallel
|
||||
computation of `CGAL::Classification::Local_eigen_analysis`
|
||||
objects. Possible values are `Parallel_tag` (default value is %CGAL
|
||||
objects. Possible values are `Parallel_tag` (default value is \cgal
|
||||
is linked with TBB) or `Sequential_tag` (default value otherwise).
|
||||
\tparam DiagonalizeTraits model of `DiagonalizeTraits` used for
|
||||
matrix diagonalization. It can be omitted: if Eigen 3 (or greater)
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ namespace CGAL {
|
|||
\cgalAutoToc
|
||||
\author %CGAL Editorial Board
|
||||
|
||||
This tutorial is for the %CGAL newbie, who knows \CC and has
|
||||
This tutorial is for the \cgal newbie, who knows \CC and has
|
||||
a basic knowledge of geometric algorithms. The first section
|
||||
shows how to define a point and segment class, and how to
|
||||
apply geometric predicates on them. The section further raises
|
||||
|
|
@ -241,7 +241,7 @@ ch_graham_andrew( InputIterator first,
|
|||
There are two obvious questions: What can be used as argument for
|
||||
this template parameter? And why do we have template parameters at all?
|
||||
|
||||
To answer the first question, any model of the %CGAL concept `Kernel` provides
|
||||
To answer the first question, any model of the \cgal concept `Kernel` provides
|
||||
what is required by the concept `ConvexHullTraits_2`.
|
||||
|
||||
As for the second question, think about an application where we want to
|
||||
|
|
@ -252,7 +252,7 @@ of the previous example.
|
|||
\cgalExample{Convex_hull_2/convex_hull_yz.cpp}
|
||||
|
||||
Another example would be about a user defined point type, or a point
|
||||
type coming from a third party library other than %CGAL. Put the point
|
||||
type coming from a third party library other than \cgal. Put the point
|
||||
type together with the required predicates for this point type in the
|
||||
scope of a class, and you can run `convex_hull_2()` with these
|
||||
points.
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ Note that some libraries have specific dependencies in addition to the essential
|
|||
|
||||
| Library | CMake Variable | Functionality | Dependencies |
|
||||
| :-------- | :------------- | :------------ | :----------- |
|
||||
| `%CGAL` | none | Main library | \gmp, \mpfr, \boost (headers) |
|
||||
| \cgal | none | Main library | \gmp, \mpfr, \boost (headers) |
|
||||
| `CGAL_Core` | `WITH_CGAL_Core` | The %CORE library for algebraic numbers.\cgalFootnote{CGAL_Core is not part of \cgal, but a custom version of the \core library distributed by \cgal for the user convenience and it has it's own license.} | \gmp and \mpfr |
|
||||
| `CGAL_ImageIO` | `WITH_CGAL_ImageIO` | Utilities to read and write image files | \zlib, \vtk (optional) |
|
||||
| `CGAL_Qt5` | `WITH_CGAL_Qt5` | `QGraphicsView` support for \qt5-based demos | \qt5 |
|
||||
|
|
|
|||
|
|
@ -32,8 +32,8 @@ Head over to \ref general_intro to learn how to obtain, install, and use \cgal.
|
|||
|
||||
<h2>License</h2>
|
||||
|
||||
%CGAL is distributed under a dual-license scheme. %CGAL can be used
|
||||
together with Open Source software free of charge. Using %CGAL in
|
||||
\cgal is distributed under a dual-license scheme. \cgal can be used
|
||||
together with Open Source software free of charge. Using \cgal in
|
||||
other contexts can be done by obtaining a commercial license from
|
||||
[GeometryFactory](http://www.geometryfactory.com). For more details
|
||||
see the \ref license "License" page.
|
||||
|
|
|
|||
|
|
@ -279,4 +279,11 @@ you are advised to look at the `CMakeLists.txt` files in the example
|
|||
folder of the package(s) that you are using to learn how to specify \cgal and additional third party
|
||||
dependencies.
|
||||
|
||||
\section sec-win-demo Trying CGAL algorithms using a Precompiled Demo
|
||||
\cgal provides a few demos offering a graphical user interface for some \cgal algorithms.
|
||||
All precompiled demos are available for download on the \ref packages page.
|
||||
Two links are provided in the column on the right: the demo itself (under **Windows Demo**) and a set of dlls (under **Common Demo Dlls**)
|
||||
that contains dlls files that must be placed in the same directory as the `.exe` of the demo.
|
||||
See for example the \ref PkgConvexHull3 package.
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -228,7 +228,7 @@ TAB_SIZE = 4
|
|||
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
||||
# newlines.
|
||||
|
||||
ALIASES = "cgal=CGAL" \
|
||||
ALIASES = "cgal=%CGAL" \
|
||||
"protocgal=C++gal" \
|
||||
"plageo=Plageo" \
|
||||
"stl=STL" \
|
||||
|
|
|
|||
|
|
@ -229,7 +229,7 @@ TAB_SIZE = 4
|
|||
# newlines (in the resulting output). You can put ^^ in the value part of an
|
||||
# alias to insert a newline as if a physical newline was in the original file.
|
||||
|
||||
ALIASES = "cgal=CGAL" \
|
||||
ALIASES = "cgal=%CGAL" \
|
||||
"protocgal=C++gal" \
|
||||
"plageo=Plageo" \
|
||||
"stl=STL" \
|
||||
|
|
|
|||
|
|
@ -251,7 +251,7 @@ TAB_SIZE = 4
|
|||
# commands \{ and \} for these it is advised to use the version @{ and @} or use
|
||||
# a double escape (\\{ and \\})
|
||||
|
||||
ALIASES = "cgal=CGAL" \
|
||||
ALIASES = "cgal=%CGAL" \
|
||||
"protocgal=C++gal" \
|
||||
"plageo=Plageo" \
|
||||
"stl=STL" \
|
||||
|
|
|
|||
|
|
@ -197,7 +197,7 @@ TAB_SIZE = 4
|
|||
# will result in a user-defined paragraph with heading "Side Effects:".
|
||||
# You can put \n's in the value part of an alias to insert newlines.
|
||||
|
||||
ALIASES = "cgal=CGAL"
|
||||
ALIASES = "cgal=%CGAL"
|
||||
ALIASES += "protocgal=C++gal"
|
||||
ALIASES += "plageo=Plageo"
|
||||
ALIASES += "stl=STL"
|
||||
|
|
|
|||
|
|
@ -23,35 +23,35 @@ result_txt=r"""// This file was generated by generate_how_to_cite.py. You should
|
|||
/*!
|
||||
\page how_to_cite_cgal Acknowledging %CGAL
|
||||
|
||||
\details %CGAL is implemented for the most part by researchers. The
|
||||
\details \cgal is implemented for the most part by researchers. The
|
||||
academic world evaluates and rewards researchers for a good part by
|
||||
the analysis of the number of published papers and the number of
|
||||
citations of their papers, which measures their impact. In order to
|
||||
make the %CGAL project attractive for researchers to contribute their
|
||||
make the \cgal project attractive for researchers to contribute their
|
||||
work (which allows users to benefit from new contributions), we are
|
||||
pushing a model where the %CGAL manual chapters are considered like
|
||||
pushing a model where the \cgal manual chapters are considered like
|
||||
publications, and can be cited in articles as such.
|
||||
|
||||
We therefore kindly ask users to cite %CGAL as appropriately as
|
||||
possible in their papers, and to mention the use of %CGAL on the web
|
||||
pages of their projects using %CGAL and provide us with links to these
|
||||
We therefore kindly ask users to cite \cgal as appropriately as
|
||||
possible in their papers, and to mention the use of \cgal on the web
|
||||
pages of their projects using \cgal and provide us with links to these
|
||||
web pages. Feel free to contact us in case you have any question or
|
||||
remark on this topic.
|
||||
|
||||
We provide bibtex entries for the chapters of the User and Reference
|
||||
Manual, as well as for publications directly related to the %CGAL
|
||||
Manual, as well as for publications directly related to the \cgal
|
||||
software.
|
||||
|
||||
## Citing the %CGAL Library or the %CGAL project ##
|
||||
|
||||
If you want to cite the %CGAL Library or project as a whole, please
|
||||
If you want to cite the \cgal Library or project as a whole, please
|
||||
|
||||
- cite: %CGAL, Computational Geometry Algorithms Library, https://www.cgal.org
|
||||
- cite: \cgal, Computational Geometry Algorithms Library, https://www.cgal.org
|
||||
- use the first bibtex entry from the file <a href="how_to_cite_cgal.bib">how_to_cite_cgal.bib</a>.
|
||||
|
||||
## Citing the User and Reference Manual ##
|
||||
|
||||
If you want to refer to %CGAL manual, please cite the appropriate
|
||||
If you want to refer to \cgal manual, please cite the appropriate
|
||||
entry from the bibliographic entries for individual chapters listed
|
||||
in the table below.
|
||||
|
||||
|
|
@ -62,9 +62,9 @@ If you want to refer to %CGAL manual, please cite the appropriate
|
|||
[<a name="cgal:eb-${CGAL_RELEASE_YEAR_ID}">1</a>]
|
||||
</td>
|
||||
<td class="bibtexitem">
|
||||
The %CGAL Project.
|
||||
<em>%CGAL User and Reference Manual</em>.
|
||||
%CGAL Editorial Board, ${CGAL_CREATED_VERSION_NUM} edition, ${CGAL_BUILD_YEAR4}.
|
||||
The \cgal Project.
|
||||
<em>\cgal User and Reference Manual</em>.
|
||||
\cgal Editorial Board, ${CGAL_CREATED_VERSION_NUM} edition, ${CGAL_BUILD_YEAR4}.
|
||||
[ <a href="how_to_cite.html#cgal:eb-${CGAL_RELEASE_YEAR_ID}">bib</a> |
|
||||
<a href="packages.html">http</a> ]
|
||||
|
||||
|
|
@ -123,14 +123,14 @@ def gen_bib_entry(title, authors, bib, anchor):
|
|||
return res
|
||||
|
||||
def gen_txt_entry(title, authors, bib, anchor,k):
|
||||
title_r=title.replace("Kernel","%Kernel").replace("Interval","%Interval").replace("Matrix","%Matrix").replace("Kinetic","%Kinetic").replace("CGAL","%CGAL").replace("Range","%Range")
|
||||
authors=authors.replace("CGAL","%CGAL")
|
||||
title_r=title.replace("Kernel","%Kernel").replace("Interval","%Interval").replace("Matrix","%Matrix").replace("Kinetic","%Kinetic").replace("CGAL","\cgal").replace("Range","%Range")
|
||||
authors=authors.replace("CGAL","\cgal")
|
||||
res="<tr valign=\"top\">\n\
|
||||
<td align=\"right\" class=\"bibtexnumber\">\n\
|
||||
[<a name=\""+bib+"-${CGAL_RELEASE_YEAR_ID}\">"+str(k)+"</a>]\n\
|
||||
</td>\n\
|
||||
<td class=\"bibtexitem\">\n "+authors+".\n "+title_r+".\n\
|
||||
In <em>%CGAL User and Reference Manual</em>. %CGAL Editorial Board,\n\
|
||||
In <em>\cgal User and Reference Manual</em>. \cgal Editorial Board,\n\
|
||||
${CGAL_CREATED_VERSION_NUM} edition, ${CGAL_BUILD_YEAR4}.\n\
|
||||
[ <a href=\"how_to_cite.html#"+bib+"-${CGAL_RELEASE_YEAR_ID}\">bib</a> | \n\
|
||||
<a href=\"packages.html#"+anchor+"\">http</a> ]\n\
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ namespace CGAL {
|
|||
|
||||
The class `Hyperbolic_Delaunay_triangulation_CK_traits_2` is designed as one of the
|
||||
default models for the traits concept `HyperbolicDelaunayTriangulationTraits_2`
|
||||
offered by %CGAL.
|
||||
offered by \cgal.
|
||||
|
||||
\tparam K must be a model of `CircularKernel`.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ namespace CGAL {
|
|||
|
||||
The class `Hyperbolic_Delaunay_triangulation_traits_2` is designed as one of the
|
||||
default models for the traits concept `HyperbolicDelaunayTriangulationTraits_2`
|
||||
offered by %CGAL.
|
||||
offered by \cgal.
|
||||
|
||||
\tparam K must be a model of `Kernel`.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ namespace CGAL {
|
|||
|
||||
The class `Hyperbolic_triangulation_face_base_2` is designed as the
|
||||
default model for the face concept `HyperbolicTriangulationFaceBase_2`
|
||||
offered by %CGAL.
|
||||
offered by \cgal.
|
||||
|
||||
\tparam Gt must be a model of `HyperbolicDelaunayTriangulationTraits_2`.
|
||||
\tparam Fb must be a model of `TriangulationFaceBase_2`. %Defaults to `Triangulation_face_base_2<Gt>`.
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ Moreover, it is connected \cgalCite{cgal:bdt-hdcvd-14}.
|
|||
From what was said above, it is natural that the class
|
||||
`Hyperbolic_Delaunay_triangulation_2` privately inherits from the class
|
||||
`Delaunay_triangulation_2`. Consequently, users are encouraged to look at Chapter
|
||||
\ref Chapter_2D_Triangulations "2D Triangulation" of the %CGAL manual to
|
||||
\ref Chapter_2D_Triangulations "2D Triangulation" of the \cgal manual to
|
||||
know more in particular about the representation of triangulations in
|
||||
CGAL and the flexibility of the design.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,8 +10,8 @@ maximum value of the `z`-coordinate of a face of a triangulation.
|
|||
the value type `Face`, which must have a
|
||||
nested type `Vertex`, which must have a nested type `Point`,
|
||||
whose `Kernel_traits<Point>::Kernel` must have a nested type `FT`.
|
||||
These requirements are fulfilled, if one uses a %CGAL triangulation
|
||||
and a %CGAL `Kernel`.
|
||||
These requirements are fulfilled, if one uses a \cgal triangulation
|
||||
and a \cgal `Kernel`.
|
||||
|
||||
\cgalModels `Interval`
|
||||
|
||||
|
|
|
|||
|
|
@ -704,7 +704,7 @@ for 3D triangles and efficient intersection tests for bounding boxes.
|
|||
This work was supported
|
||||
by the Graduiertenkolleg 'Algorithmische Diskrete Mathematik',
|
||||
under grant DFG We 1265/2-1,
|
||||
and by ESPRIT IV Long Term Research Projects No. 21957 (%CGAL)
|
||||
and by ESPRIT IV Long Term Research Projects No. 21957 (\cgal)
|
||||
and No. 28155 (GALIA).
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ speed thanks to a lazy mechanism, similar to
|
|||
`Exact_predicates_exact_constructions_kernel`. A construction creates an
|
||||
approximate object, and stores a directed acyclic graph (DAG) of the operation
|
||||
and arguments used. When an operation needs more precision on an object than is
|
||||
currently available, which should be rare, %CGAL reconstructs exactly all the
|
||||
currently available, which should be rare, \cgal reconstructs exactly all the
|
||||
ancestors of the object and replaces this part of the graph with exact objects.
|
||||
This should be transparent for users, those details do not affect the
|
||||
functionality, but they can cause surprising running time where the costly part
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
/// \defgroup PkgMesh2IO I/O Functions
|
||||
/// \ingroup PkgMesh2Ref
|
||||
/// In addition to the stream extraction and insertion operators for
|
||||
/// %CGAL 2D triangulations, the following functions can be used.
|
||||
/// \cgal 2D triangulations, the following functions can be used.
|
||||
|
||||
/*!
|
||||
\addtogroup PkgMesh2Ref
|
||||
|
|
|
|||
|
|
@ -902,7 +902,7 @@ a dedicated function computes the 1D-features, and adds them to the domain.
|
|||
\snippet Mesh_3/mesh_3D_image_with_features.cpp Call add_1D_features
|
||||
|
||||
The function template `%add_1D_features()` is defined in the example
|
||||
file. It uses non-documented code from %CGAL, that should be copy-pasted in
|
||||
file. It uses non-documented code from \cgal, that should be copy-pasted in
|
||||
any user-code willing to use similar code. It uses the undocumented
|
||||
function template `%CGAL::polylines_to_protect` that computes the
|
||||
1D-features that correspond to the intersection of the bounding box of the
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ of the class, that is, `Residue` is not thread-safe in this case.
|
|||
In case `CGAL_HAS_THREADS`
|
||||
the implementation of the class is thread safe using
|
||||
`boost::thread_specific_ptr`. However, this may cause some performance
|
||||
penalty. Hence, it may be advisable to configure %CGAL with
|
||||
penalty. Hence, it may be advisable to configure \cgal with
|
||||
`CGAL_HAS_NO_THREADS`. See Section \ref Preliminaries_thread_safety "Thread Safety"
|
||||
in the preliminaries.
|
||||
|
||||
|
|
|
|||
|
|
@ -78,7 +78,7 @@ qualified as being positively or negatively oriented.
|
|||
|
||||
\subsection Nef_S2FirstExample First Example
|
||||
|
||||
In this first example `Nef_polyhedron_S2` is parametrized with a %CGAL
|
||||
In this first example `Nef_polyhedron_S2` is parametrized with a \cgal
|
||||
Kernel as traits class. The types comprising the spherical geometry can be
|
||||
retrieved from the type `Nef_polyhedron_S2<Traits>` as is done in the example
|
||||
with the type
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ namespace CGAL {
|
|||
`Exact_algebraic` is an exact algebraic number type, constructible from `double`.
|
||||
|
||||
It is a typedef of another number type. Its exact definition depends on
|
||||
the availability the third-party libraries %CORE, and %LEDA. %CGAL must
|
||||
the availability the third-party libraries \core, and \leda. \cgal must
|
||||
be configured with at least one of those libraries.
|
||||
|
||||
\cgalModels `FieldWithSqrt`
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ namespace CGAL {
|
|||
`Exact_integer` is an exact integer number type.
|
||||
|
||||
It is a typedef of another number type. Its exact definition depends on
|
||||
the availability the third-party libraries %GMP, %CORE, and %LEDA. %CGAL must
|
||||
the availability the third-party libraries \gmp, \core, and \leda. \cgal must
|
||||
be configured with at least one of those libraries.
|
||||
|
||||
\cgalModels `EuclideanRing`
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ namespace CGAL {
|
|||
`Exact_rational` is an exact rational number type, constructible from `double`.
|
||||
|
||||
It is a typedef of another number type. Its exact definition depends on
|
||||
the availability the third-party libraries %GMP, %CORE, and %LEDA. %CGAL must
|
||||
the availability the third-party libraries \gmp, \core, and \leda. \cgal must
|
||||
be configured with at least one of those libraries.
|
||||
|
||||
\cgalModels `Field`
|
||||
|
|
|
|||
|
|
@ -53,10 +53,10 @@ of the package \ref PkgPeriodic3Triangulation3).
|
|||
By identifying a single copy of the flat torus \f$ \mathbb T_c^3\f$ (where `c`
|
||||
denotes the period) with a cube of side `c` in \f$ \mathbb R^3\f$, the meshing process
|
||||
can be exclusively conducted within a cube of side `c`.
|
||||
The mesh within a single copy is created using %CGAL's \ref PkgMesh3 package, but
|
||||
because %CGAL's \ref PkgMesh3 package aims to mesh traditional (non-periodic)
|
||||
domains, an interface is necessary between %CGAL's \ref PkgMesh3 package
|
||||
and %CGAL's \ref PkgPeriodic3Triangulation3.
|
||||
The mesh within a single copy is created using \cgal's \ref PkgMesh3 package, but
|
||||
because \cgal's \ref PkgMesh3 package aims to mesh traditional (non-periodic)
|
||||
domains, an interface is necessary between \cgal's \ref PkgMesh3 package
|
||||
and \cgal's \ref PkgPeriodic3Triangulation3.
|
||||
This package offers these interfaces.
|
||||
|
||||
\cgalClassifedRefPages
|
||||
|
|
@ -73,8 +73,8 @@ and `MeshDomainWithFeatures_3` in the package \ref PkgMesh3 :
|
|||
|
||||
\cgalCRPSection{Classes}
|
||||
|
||||
The following class provides the interface between %CGAL's periodic triangulation
|
||||
and %CGAL's three-dimensional mesh generator:
|
||||
The following class provides the interface between \cgal's periodic triangulation
|
||||
and \cgal's three-dimensional mesh generator:
|
||||
- `CGAL::Periodic_3_mesh_triangulation_3<MD, K, Vertex_base, Cell_base>`
|
||||
|
||||
The following class allows to construct a periodic implicit function from an implicit function that is not periodic:
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ by a mesh optimization phase to remove slivers and provide a good quality mesh.
|
|||
|
||||
This package is fundamentally linked to the package \ref PkgMesh3,
|
||||
which is devoted to the generation of isotropic simplicial
|
||||
meshes discretizing (non-periodic) 3D domains and to the \ref PkgPeriodic3Triangulation3 of %CGAL,
|
||||
meshes discretizing (non-periodic) 3D domains and to the \ref PkgPeriodic3Triangulation3 of \cgal,
|
||||
which are used as underlying triangulation structures of the mesh.
|
||||
|
||||
A periodic mesh extends, by definition, infinitely in space. We consider the flat torus \f$ \mathbb T_c^3\f$,
|
||||
|
|
@ -75,7 +75,7 @@ of the periodic triangulation into the flat torus \f$ \mathbb T_c^3\f$ forms at
|
|||
of the manual of 3D periodic triangulations).
|
||||
Thanks to this construction, the meshing process can be exclusively conducted
|
||||
within the canonical cube.
|
||||
The mesh can then be created using the \ref PkgMesh3 package of %CGAL.
|
||||
The mesh can then be created using the \ref PkgMesh3 package of \cgal.
|
||||
As this package originally aims to mesh non-periodic domains of \f$ \mathbb R^3\f$, an interface
|
||||
is necessary between the packages \ref PkgMesh3 and \ref PkgPeriodic3Triangulation3.
|
||||
This package provides this interface.
|
||||
|
|
|
|||
|
|
@ -640,7 +640,7 @@ Periodic_tetrahedron periodic_tetrahedron(const Cell_handle c, Offset offset) co
|
|||
/// @}
|
||||
|
||||
/// \name
|
||||
/// \warning The following functions were renamed with %CGAL 4.11 to clarify
|
||||
/// \warning The following functions were renamed with \cgal 4.11 to clarify
|
||||
/// that they return geometric objects with inner type `Point_3`.
|
||||
///
|
||||
/// Note that a traits class providing exact constructions should be
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
/**
|
||||
* \ingroup PkgSTLExtensionRef
|
||||
*
|
||||
* A define for the allocator used by %CGAL. This is only defined if
|
||||
* A define for the allocator used by \cgal. This is only defined if
|
||||
* there is no user defined version before `memory.h` is included
|
||||
* the first time.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ namespace CGAL {
|
|||
\authors Thijs van Lankveld
|
||||
|
||||
|
||||
This %CGAL package implements a surface reconstruction method which takes as input an unordered point set and computes a triangulated surface mesh interpolating the point set. We assume that the input points were sampled from the surface of an object. The method can also process point sets sampled from the interior of the object, although we cannot provide guarantees on the output. This method can handle a decent amount of noise and outliers. The point set may greatly undersample the object in occluded regions, although no surface will be reconstructed to fill these regions.
|
||||
This \cgal package implements a surface reconstruction method which takes as input an unordered point set and computes a triangulated surface mesh interpolating the point set. We assume that the input points were sampled from the surface of an object. The method can also process point sets sampled from the interior of the object, although we cannot provide guarantees on the output. This method can handle a decent amount of noise and outliers. The point set may greatly undersample the object in occluded regions, although no surface will be reconstructed to fill these regions.
|
||||
|
||||
\cgalFigureBegin{chapterScaleSpaceReconstruction3figIntro, knot2_pts_surf.png}
|
||||
Left: 5760 points on a synthetic knot data set. Right: reconstructed surface mesh.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace CGAL {
|
|||
///
|
||||
/// The class `Default_diagonalize_traits` is a wrapper designed to automatically
|
||||
/// use `Eigen_diagonalize_traits` if Eigen is available and otherwise use
|
||||
/// the fallback `Diagonalize_traits` class of %CGAL.
|
||||
/// the fallback `Diagonalize_traits` class of \cgal.
|
||||
///
|
||||
/// \tparam FT Number type
|
||||
/// \tparam dim Dimension of the matrices and vectors
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ OutputIterator search(OutputIterator it, FuzzyQueryItem q) const;
|
|||
|
||||
/*!
|
||||
Returns a const iterator to the first point in the tree.
|
||||
\note Starting with %CGAL 4.6, the order of the points in the iterator range
|
||||
\note Starting with \cgal 4.6, the order of the points in the iterator range
|
||||
`[begin() , end())` is not the order of insertion of the points into the tree.
|
||||
This was not guaranteed before but might have beeen observed and exploited.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -496,7 +496,7 @@ Other data structures of \cgal have their own I/O functions, see their respectiv
|
|||
|
||||
\subsection IOstreamOther Reading Unsupported Formats
|
||||
|
||||
If %CGAL does not support the file format of your data, the
|
||||
If \cgal does not support the file format of your data, the
|
||||
<a href="https://www.boost.org/doc/libs/release/libs/property_tree/">`boost::property_tree`</a>
|
||||
might come in handy if your data has a simple-enough structure.
|
||||
The following small example shows how to parse an <a href="https://en.wikipedia.org/wiki/XML">XML</a> file,
|
||||
|
|
|
|||
Loading…
Reference in New Issue