Description added.

This commit is contained in:
Weisheng Si 2015-02-12 10:31:01 +11:00
parent c386c64255
commit 27b1b49337
1 changed files with 7 additions and 2 deletions

View File

@ -15,11 +15,11 @@
\todo check generated documentation
\cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeBasedSpannersSummary}
\cgalPkgPicture{pkg-small.png}
\cgalPkgPicture{Logo-ConeSpanners.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Weisheng Si and Quincy Tse}
\cgalPkgDesc{This package provides ... }
\cgalPkgDesc{This package provides classes for constructing two kinds of cone-based spanners (Yao graph and Theta graph) given a set of vertices on the plane. Both exact and inexact constructions are implemented. In exact construction, the cone boundaries are calculated using roots of polynomials (requiring `CORE::Expr` or `LEDA::real`). In inexact construction, the cone boundaries are calculated using the constant Pi (3.14159265358979323846), which is still accurate enough for most applications. Moreover, for visualization purpose, this package provides functions to generate the data and script files used by Gnuplot to plot the constructed graphs. }
\cgalPkgManuals{Chapter_ConeBasedSpanners,PkgConeBasedSpanners}
\cgalPkgSummaryEnd
@ -41,4 +41,9 @@
## Classes ##
- `CGAL::Yao_graph_2`
- `CGAL::Theta_graph_2`
## Functions to generate Gnuplot files ##
- `CGAL::gnuplot_output_2()`
*/