mirror of https://github.com/CGAL/cgal
68 lines
2.3 KiB
Plaintext
68 lines
2.3 KiB
Plaintext
/*!
|
|
|
|
\mainpage
|
|
|
|
The Computational Geometry Algorithms Library (\cgal) is a software project
|
|
that provides easy access to efficient and reliable geometric algorithms
|
|
in the form of a C++ library.
|
|
|
|
<h2>Package Overview</h2>
|
|
|
|
\cgal offers data structures and algorithms like \ref PartTriangulationsAndDelaunayTriangulations "triangulations",
|
|
\ref PartVoronoiDiagrams "Voronoi diagrams", \ref PartPolygons, \ref PartPolyhedra,
|
|
\ref PartArrangements "arrangements of curves", \ref PartMeshing "mesh generation",
|
|
\ref PartGeometryProcessing "geometry processing", \ref PartConvexHullAlgorithms "convex hull algorithms",
|
|
to name just a few.
|
|
|
|
All these data structures and algorithms operate on geometric objects
|
|
like points and segments, and perform geometric tests on them. These
|
|
objects and predicates are regrouped in \ref PartKernels "CGAL Kernels".
|
|
|
|
Finally, the \ref PartSupportLibrary "Support Library" offers geometric object generators and
|
|
spatial sorting functions, as well as a matrix search framework and a
|
|
solver for linear and quadratic programs. It further offers interfaces
|
|
to third party software such as the GUI libraries Qt, and
|
|
the Boost Graph Library.
|
|
|
|
The complete list of packages is available on the page \ref packages.
|
|
|
|
<h2>Getting Started</h2>
|
|
|
|
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
|
|
other contexts can be done by obtaining a commercial license from
|
|
[GeometryFactory](https://www.geometryfactory.com). For more details
|
|
see the \ref license "License" page.
|
|
|
|
<h2>Acknowledgment</h2>
|
|
|
|
We provide bibtex entries for each package so that you can cite \cgal correctly in your publications,
|
|
see the page \ref how_to_cite_cgal.
|
|
|
|
<h2>Manuals for the Previous Releases</h2>
|
|
|
|
For releases >= 4.2, visit [https://doc.cgal.org/X.Y](https://doc.cgal.org/4.2)
|
|
|
|
For releases X.Y, with 3.1 <= X.Y <= 4.1 visit
|
|
[https://doc.cgal.org/Manual/X.Y/doc_html/cgal_manual/packages.html](https://doc.cgal.org/Manual/3.1/doc_html/cgal_manual/packages.html)
|
|
|
|
\htmlonly[block]
|
|
<div style="display:none">
|
|
\endhtmlonly
|
|
|
|
\subpage general_intro
|
|
\subpage tutorials
|
|
\subpage packages
|
|
\subpage dev_manual
|
|
\subpage license
|
|
|
|
\htmlonly[block]
|
|
</div>
|
|
\endhtmlonly
|
|
|
|
*/
|