cgal/Envelope_2/doc/Envelope_2/PackageDescription.txt

45 lines
1.5 KiB
Plaintext

/// \defgroup PkgEnvelope2 2D Envelopes Reference
/// \defgroup PkgEnvelope2Concepts Concepts
/// \ingroup PkgEnvelope2
/*!
\addtogroup PkgEnvelope2
\todo check generated documentation
\cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary}
\cgalPkgPicture{Envelope_2/fig/Envelope_2.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Ron Wein}
\cgalPkgDesc{This package consits of functions that computes the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is represented as an envelope diagram, namely a subdivision of the \f$ x\f$-axis into intervals, such that the identity of the curves that induce the envelope on each interval is unique.}
\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgArrangement2Summary}
\cgalPkgBib{cgal:w-e2}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
This package consists of functions that compute the lower (or upper)
envelope of a set of arbitrary curves in 2D. The output is
represented as an envelope diagram, namely a subdivision of the
\f$ x\f$-axis into intervals, such that the identity of the curves that
induce the envelope over each interval is unique.
\cgalClassifedRefPages
## Functions ##
- `CGAL::lower_envelope_2`
- `CGAL::upper_envelope_2`
- `CGAL::lower_envelope_x_monotone_2`
- `CGAL::upper_envelope_x_monotone_2`
## Concepts ##
- `EnvelopeDiagram_1`
- `EnvelopeDiagramVertex`
- `EnvelopeDiagramEdge`
## Classes ##
- `CGAL::Envelope_diagram_1<Traits> `
*/