diff --git a/Documentation/doxyassist.xml b/Documentation/doxyassist.xml index 9658c19da77..1a8ad0cdd4c 100644 --- a/Documentation/doxyassist.xml +++ b/Documentation/doxyassist.xml @@ -1329,6 +1329,8 @@ namespace for the XML file to be processed properly. --> ../Kinetic_data_structures/examples/Kinetic_data_structures ./tags/Kinetic_framework.tag=../../CGAL.CGAL.Kinetic-Framework/html + ./tags/Triangulation_2.tag=../../CGAL.CGAL.2D-Triangulation/html + ./tags/Triangulation_3.tag=../../CGAL.CGAL.3D-Triangulations/html diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h index eb4d88d5ab9..2b032976dfe 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h @@ -34,7 +34,7 @@ whenever the triangulation changes. \sa `Kinetic::Delaunay_triangulation_default_visitor_2` \sa `Kinetic::Delaunay_triangulation_recent_edges_visitor_2` \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 > diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h index 336eb180d33..cbd8907056b 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_2.h @@ -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` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h index 415bc5e59f7..69ee4d3cd5b 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_event_log_visitor_3.h @@ -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. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h index 19533fcab2d..7cf87a238dd 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h @@ -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. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h index 78b06642870..22c80411586 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h @@ -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`. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h index ec631e1023e..1ed05f07292 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h @@ -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`. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h index f706ad64052..4346c7b4e3f 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_event_log_visitor_3.h @@ -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` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h index a00f67cafc4..a1370f68f69 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h @@ -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`. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h index 16b421d1e9b..1f5d4be9d1c 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_event_log_visitor.h @@ -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` diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h index 19b5ac39a91..13d18bd2cc3 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h @@ -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`. diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt b/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt index 0854c8a5a6b..be590fc9ce8 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Kinetic_data_structures.txt @@ -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 predicates - functions on quantities defining the geometric diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt b/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt index dac65c39410..a418eb16287 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/PackageDescription.txt @@ -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. + */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h index 5eddb4cea98..333bd04796a 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h @@ -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. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h index ea5010a6416..3f45aa27d03 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h @@ -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` diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h index e5b38c68b82..4c7817ff51a 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h @@ -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. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h index 878c16015d6..4187ab67cbb 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h @@ -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: - - -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 diff --git a/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt b/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt index bc8cc6b02a6..1988a6764ab 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt +++ b/Kinetic_data_structures/doc/Kinetic_framework/PackageDescription.txt @@ -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.