mirror of https://github.com/CGAL/cgal
first pass over KDS
This commit is contained in:
parent
3cc7c5871f
commit
e1b5921470
|
|
@ -1329,6 +1329,8 @@ namespace for the XML file to be processed properly. -->
|
|||
<string name="EXAMPLE_PATH">../Kinetic_data_structures/examples/Kinetic_data_structures</string>
|
||||
<list name="TAGFILES" append="true">
|
||||
<item>./tags/Kinetic_framework.tag=../../CGAL.CGAL.Kinetic-Framework/html</item>
|
||||
<item>./tags/Triangulation_2.tag=../../CGAL.CGAL.2D-Triangulation/html</item>
|
||||
<item>./tags/Triangulation_3.tag=../../CGAL.CGAL.3D-Triangulations/html</item>
|
||||
</list>
|
||||
</doxygen>
|
||||
</project>
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ whenever the triangulation changes.
|
|||
\sa `Kinetic::Delaunay_triangulation_default_visitor_2`
|
||||
\sa `Kinetic::Delaunay_triangulation_recent_edges_visitor_2<Triangulation>`
|
||||
\sa `Kinetic::Delaunay_triangulation_event_log_visitor_2`
|
||||
\sa `Kinetic::Qt_Delaunay_triangulation_2`
|
||||
\sa `Kinetic::Qt_triangulation_2`
|
||||
|
||||
*/
|
||||
template< typename Traits, typename Visitor, typename Triangulation >
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri2
|
||||
|
||||
The concept `Kinetic::Delaunay_triangulation_event_log_visitor_2` provides a model of
|
||||
The class `Kinetic::Delaunay_triangulation_event_log_visitor_2` provides a model of
|
||||
`Kinetic::DelaunayTriangulationVisitor_2` and `Kinetic::EventLogVisitor` which logs edge flip events.
|
||||
|
||||
\cgalModels `Kinetic::DelaunayTriangulationVisitor_2`
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri3
|
||||
|
||||
The concept `Kinetic::Delaunay_triangulation_event_log_visitor_3` provides a model of
|
||||
The class `Kinetic::Delaunay_triangulation_event_log_visitor_3` provides a model of
|
||||
`Kinetic::DelaunayTriangulationVisitor_3` and
|
||||
`Kinetic::EventLogVisitor` which logs edge and facet flip events.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri2
|
||||
|
||||
The concept `Kinetic::Delaunay_triangulation_recent_edges_visitor_2` provides a model of
|
||||
The class `Kinetic::Delaunay_triangulation_recent_edges_visitor_2` provides a model of
|
||||
`Kinetic::DelaunayTriangulationVisitor_2` which tracks which edges were created in
|
||||
the most recent change.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri2
|
||||
|
||||
The concept `Kinetic::Delaunay_triangulation_visitor_base_2` provides a model of
|
||||
The class `Kinetic::Delaunay_triangulation_visitor_base_2` provides a model of
|
||||
`Kinetic::DelaunayTriangulationVisitor_2`. You can extend this class if you only
|
||||
want to implement a few methods from `Kinetic::DelaunayTriangulationVisitor_2`.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri3
|
||||
|
||||
The concept `Kinetic::Delaunay_triangulation_visitor_base_3` provides a model of
|
||||
The class `Kinetic::Delaunay_triangulation_visitor_base_3` provides a model of
|
||||
`Kinetic::DelaunayTriangulationVisitor_3`. You can extend this class if you only
|
||||
want to implement a few methods from `Kinetic::DelaunayTriangulationVisitor_3`.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri3
|
||||
|
||||
The concept `Kinetic::Regular_triangulation_event_log_visitor_3` provides a model of
|
||||
The class `Kinetic::Regular_triangulation_event_log_visitor_3` provides a model of
|
||||
`Kinetic::RegularTriangulationVisitor_3` and `EventLogVisitor` which logs edge flip events.
|
||||
|
||||
\cgalModels `Kinetic::RegularTriangulationVisitor_3`
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsTri3
|
||||
|
||||
The concept `Kinetic::Regular_triangulation_visitor_base_3` provides a model of
|
||||
The class `Kinetic::Regular_triangulation_visitor_base_3` provides a model of
|
||||
`Kinetic::RegularTriangulationVisitor_3`. You can extend this class if you only
|
||||
want to implement a few methods from `Kinetic::RegularTriangulationVisitor_3`.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsSorting
|
||||
|
||||
The concept `Kinetic::Sort_event_log_visitor` provides a model of
|
||||
The class `Kinetic::Sort_event_log_visitor` provides a model of
|
||||
`SortVisitor` and `EventLogVisitor` which logs changes to the structure.
|
||||
|
||||
\cgalModels `Kinetic::SortVisitor`
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ namespace CGAL { namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsSorting
|
||||
|
||||
The concept `Kinetic::Sort_visitor_base` provides a model of
|
||||
The class `Kinetic::Sort_visitor_base` provides a model of
|
||||
`Kinetic::SortVisitor`. You can extend this class if you only
|
||||
want to implement a few methods from `Kinetic::SortVisitor`.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ structure which is maintained changes at discrete times (events) even
|
|||
though the basic building blocks are changing continuously.
|
||||
|
||||
This chapter describes a number of such kinetic data structures
|
||||
implemented using the Kinetic framework described in
|
||||
implemented using the %Kinetic framework described in
|
||||
Chapter \ref chapterkinetic "Kinetic Framework". We first, in
|
||||
Section \ref seckds_intro introduce kinetic data structures and
|
||||
sweepline algorithms. This section can be skipped if the reader is
|
||||
|
|
@ -62,7 +62,7 @@ We are working on that one, but you will have to wait.
|
|||
|
||||
\section seckds_intro An Overview of Kinetic Data Structures and Sweep Algorithms
|
||||
|
||||
Kinetic data structures were first introduced in by Basch et. al. in
|
||||
%Kinetic data structures were first introduced in by Basch et. al. in
|
||||
1997 \cite cgal:bgh-dsmd-97. The idea stems from the observation that
|
||||
most, if not all, computational geometry structures are built using
|
||||
<I>predicates</I> - functions on quantities defining the geometric
|
||||
|
|
|
|||
|
|
@ -34,9 +34,6 @@
|
|||
\cgalPkgShortInfoEnd
|
||||
\cgalPkgDescriptionEnd
|
||||
|
||||
%Kinetic data structures are a way of adding motion to classical
|
||||
geometric data structures. \cgal provides several prepackaged kinetic
|
||||
data structures. Here we present those kinetic data structures and the
|
||||
helper classes that allow their activity to be monitored.
|
||||
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ namespace Kinetic {
|
|||
/*!
|
||||
\ingroup PkgKdsFrameworkClasses
|
||||
|
||||
This class provides a model of `Kinetic::Kernel` for use with general Cartesian geometry.
|
||||
This class provides a model of `Kinetic::Kernel` for use with general %Cartesian geometry.
|
||||
|
||||
The IO format for points is currently \f$ p_0\f$, \f$ p_1\f$, ... \f$ w\f$. \f$ p_i\f$ and \f$ w\f$ are instances of Function. There IO format is typically \f$ c_0+c_1t+c_2t^2+...\f$. Beware of issues with \cgal IO of the coeffients as exact number typles often require that the coefficents be expressed as \f$ a/b\f$ even when \f$ b\f$ is 1.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ namespace Kinetic {
|
|||
\ingroup PkgKdsFrameworkClasses
|
||||
|
||||
This class provides a model of the `Kinetic::InstantaneousKernel` for
|
||||
use with general Cartesian Geometry. It provides all the predicates
|
||||
use with general %Cartesian Geometry. It provides all the predicates
|
||||
needed for Delaunay triangulations and regular triangulations.
|
||||
|
||||
\cgalModels `Kinetic::InstantaneousKernel`
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ namespace Kinetic {
|
|||
\cgalConcept
|
||||
|
||||
The concept `Kinetic::InstantaneousKernel` covers models that act as adaptors allowing
|
||||
CGAL static data structures to act on snapshots of kinetic
|
||||
%CGAL static data structures to act on snapshots of kinetic
|
||||
data. Different methods for evaluating predicates are used depending
|
||||
on whether time is set using an `NT` or a `Time`
|
||||
object. Evaluating predicates when time is the former is much cheaper.
|
||||
|
|
|
|||
|
|
@ -4,15 +4,7 @@ namespace Kinetic {
|
|||
\cgalConcept
|
||||
|
||||
This concept ties together the parts needed in order to run a kinetic
|
||||
data structure. We provide several models of this concept:
|
||||
<UL>
|
||||
<LI>`Kinetic::Exact_simulation_traits`
|
||||
<LI>`Kinetic::Inexact_simulation_traits`
|
||||
<LI>`Kinetic::Regular_triangulation_exact_simulation_traits`
|
||||
<LI>`Kinetic::Regular_triangulation_inexact_simulation_traits`
|
||||
</UL>
|
||||
|
||||
All support trajectories defined by polynomial coordinates. The
|
||||
data structure. All support trajectories defined by polynomial coordinates. The
|
||||
`Exact` vs `Inexect` picks whether the roots of the
|
||||
certificate functions are compared exactly or approximated
|
||||
numerically. The regular triangulation models have weighted points of
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@ implementation of kinetic data structures.
|
|||
|
||||
There are three levels at which the user can interact with the
|
||||
package. The user can use an existing kinetic data structure, write a
|
||||
new kinetic data structure, or replace parts of the framework.The
|
||||
first level is covered in the Chapter \ref Chapter_Kinetic_Framework.
|
||||
new kinetic data structure, or replace parts of the framework. The
|
||||
first level is covered in this Chapter.
|
||||
|
||||
## Example ##
|
||||
The simulation traits class is simply there for convenience in order to bundle a set of related typedefs and create a few objects. As a resulting, creating your own requires little though, and just copying and changing a few lines. An example is below which sets up to use the CORE Sturm sequences to solve polynomials rather than our own (faster) solvers. It can be found in examples/Kinetic\_framework/defining\_a\_simulation\_traits.cpp.
|
||||
|
|
|
|||
Loading…
Reference in New Issue