[Small Feature] Apply review: cleanup doc, remove old alias, fix tests

This commit is contained in:
Yliess Bellargui 2025-07-01 17:30:00 +02:00
parent ff6a91eb61
commit e170d7b0de
12 changed files with 22 additions and 31 deletions

View File

@ -24,9 +24,8 @@ Here a small example:
<B>Middle</B>: the 2D linear cell complex reconstructed if combinatorial maps are the combinatorial data-structure.
<B>Right</B>: the 2D linear cell complex reconstructed if generalized maps are the combinatorial data-structure.
\sa `CGAL::triangulation_3_to_lcc<LCC,Triangulation>` (formerly `import_from_triangulation_3`)
\sa `CGAL::polyhedron_3_to_lcc<LCC,Polyhedron>` (formerly `import_from_polyhedron_3`)
\sa `CGAL::triangulation_3_to_lcc<LCC,Triangulation>`
\sa `CGAL::polyhedron_3_to_lcc<LCC,Polyhedron>`
*/
template<class LCC>
typename LCC::Dart_descriptor plane_graph_to_lcc(LCC& lcc,

View File

@ -5,8 +5,8 @@ namespace CGAL{
Imports `apoly` (a `Polyhedron_3`) into `lcc`, a model of the `LinearCellComplex` concept. Objects are added in `lcc`, existing darts are not modified. Returns a dart created during the import.
\pre \link GenericMap::dimension `LCC::dimension`\endlink \f$ \geq\f$ 2 and \link LinearCellComplex::ambient_dimension `LCC::ambient_dimension`\endlink==3.
\sa `CGAL::plane_graph_to_lcc<LCC>` (formerly `import_from_plane_graph`)
\sa `CGAL::triangulation_3_to_lcc<LCC,Triangulation>` (formerly `import_from_triangulation_3`)
\sa `CGAL::plane_graph_to_lcc<LCC>`
\sa `CGAL::triangulation_3_to_lcc<LCC,Triangulation>`
*/
template<class LCC,class Polyhedron>
typename LCC::Dart_descriptor polyhedron_3_to_lcc(LCC& lcc,

View File

@ -8,9 +8,8 @@ Objects are added in `lcc`, existing darts are not modified. Returns a dart crea
\pre \link GenericMap::dimension `LCC::dimension`\endlink \f$ \geq\f$ 3 and
\link LinearCellComplex::ambient_dimension `LCC::ambient_dimension`\endlink==3.
\sa `CGAL::triangulation_3_to_lcc<LCC,Triangulation>` (formerly `import_from_triangulation_3`)
\sa `CGAL::plane_graph_to_lcc<LCC>` (formerly `import_from_plane_graph`)
/// \sa `CGAL::polyhedron_3_to_lcc<LCC,Polyhedron>` (formerly `import_from_polyhedron_3`)
\sa `CGAL::plane_graph_to_lcc<LCC>`
\sa `CGAL::polyhedron_3_to_lcc<LCC,Polyhedron>`
*/
template <class LCC,class Triangulation_>

View File

@ -64,7 +64,7 @@ which constructs a vector as the difference of points `p2-p1`, and
\link LinearCellComplexTraits::Vector ` Vector `\endlink `operator() (const CGAL::Origin&, const ` \link Point ` Point`\endlink`& p)`
which constructs a vector as the difference of point `p` and a point at the origin
(used in \link CGAL::barycenter `barycenter`\endlink
and `CGAL::plane_graph_to_lcc`, formerly `import_from_plane_graph`).
and `CGAL::plane_graph_to_lcc`).
typedef unspecified_type Construct_vector;
/*!
@ -103,7 +103,7 @@ a model of \link Kernel::Direction_2 `Direction_2`\endlink.
typedef unspecified_type Direction_2;
/*!
a model of \link Kernel::ConstructDirection_2 `ConstructDirection_2`\endlink (used in `CGAL::plane_graph_to_lcc`, formerly `import_from_plane_graph`).
a model of \link Kernel::ConstructDirection_2 `ConstructDirection_2`\endlink (used in `CGAL::plane_graph_to_lcc`).
*/
typedef unspecified_type Construct_direction_2;

View File

@ -105,11 +105,11 @@ There are several member functions allowing to insert specific configurations of
There are two functions allowing to build a linear cell complex from two other \cgal data types:
<UL>
<LI>\link ::triangulation_3_to_lcc `triangulation_3_to_lcc(lcc,atr)`\endlink: adds in `lcc` all the tetrahedra present in `atr`, a \link CGAL::Triangulation_3 `Triangulation_3`\endlink; (formerly `import_from_triangulation_3`)
<LI>\link ::polyhedron_3_to_lcc `polyhedron_3_to_lcc(lcc,ap)`\endlink: adds in `lcc` all the cells present in `ap`, a `Polyhedron_3`. (formerly `import_from_polyhedron_3`)
<LI>\link ::triangulation_3_to_lcc `triangulation_3_to_lcc(lcc,atr)`\endlink: adds in `lcc` all the tetrahedra present in `atr`, a \link CGAL::Triangulation_3 `Triangulation_3`\endlink;
<LI>\link ::polyhedron_3_to_lcc `polyhedron_3_to_lcc(lcc,ap)`\endlink: adds in `lcc` all the cells present in `ap`, a `Polyhedron_3`.
</UL>
Lastly, the function \link ::plane_graph_to_lcc `plane_graph_to_lcc(lcc,ais)`\endlink (formerly `import_from_plane_graph`) adds in `lcc` all the cells reconstructed from the planar graph read in `ais`, a `std::istream` (see the \link ::plane_graph_to_lcc `reference manual`\endlink for the file format).
Lastly, the function \link ::plane_graph_to_lcc `plane_graph_to_lcc(lcc,ais)`\endlink adds in `lcc` all the cells reconstructed from the planar graph read in `ais`, a `std::istream` (see the \link ::plane_graph_to_lcc `reference manual`\endlink for the file format).
\subsection Linear_cell_complexModificationOperations Modification Operations
\anchor ssecmodifop

View File

@ -65,7 +65,6 @@
- `CGAL::plane_graph_to_lcc<LCC>` (formerly `import_from_plane_graph`)
- `CGAL::triangulation_3_to_lcc<LCC,Triangulation>` (formerly `import_from_triangulation_3`)
- `CGAL::polyhedron_3_to_lcc<LCC,Polyhedron>` (formerly `import_from_polyhedron_3`)
- `CGAL::polyhedron_3_flux_to_lcc<LCC>` (formerly `import_from_polyhedron_3_flux`)
\cgalCRPSubsection{Operations for Linear Cell Complex}
- `CGAL::compute_normal_of_cell_0<LCC>`

View File

@ -208,7 +208,7 @@ import_from_plane_graph(LCC& alcc, std::istream& ais)
template < class LCC >
typename LCC::Dart_descriptor
iplane_graph_to_lcc(LCC& alcc, const char* filename)
plane_graph_to_lcc(LCC& alcc, const char* filename)
{
std::ifstream input(filename);
if (!input.is_open()) return alcc.null_descriptor;
@ -220,9 +220,7 @@ template <class LCC>
typename LCC::Dart_descriptor
import_from_plane_graph(LCC& alcc, const char* filename)
{
std::ifstream input(filename);
if (!input.is_open()) return alcc.null_descriptor;
return plane_graph_to_lcc(alcc, input);
return plane_graph_to_lcc(alcc, filename);
}
template < class LCC >

View File

@ -997,7 +997,7 @@ bool test_LCC_3()
}
in >> P;
CGAL::polyhedron_3_flux_to_lcc<LCC>(lcc,P);
CGAL::polyhedron_3_to_lcc<LCC>(lcc,P);
if ( !check_number_of_cells_3(lcc, 1539, 4434, 2894, 2, 2) )
return false;

View File

@ -2,6 +2,7 @@
#include <CGAL/Linear_cell_complex_constructors.h>
#include <cassert>
#include <sstream>
#include <cstdlib>
typedef CGAL::Linear_cell_complex_for_combinatorial_map<2> LCC;
@ -25,5 +26,5 @@ int main()
auto d2 = CGAL::import_from_plane_graph(lcc2, input);
assert(d2 != LCC::null_descriptor);
return 0;
return EXIT_SUCCESS;
}

View File

@ -3,6 +3,7 @@
#include <CGAL/Polyhedron_3_to_lcc.h>
#include <sstream>
#include <cassert>
#include <cstdlib>
typedef CGAL::Linear_cell_complex_for_combinatorial_map<3> LCC;
typedef CGAL::Polyhedron_3<LCC::Traits> Polyhedron;
@ -22,5 +23,5 @@ int main()
auto d2 = CGAL::import_from_polyhedron_3<LCC>(lcc2, P);
assert(d2 == LCC::null_descriptor);
return 0;
return EXIT_SUCCESS;
}

View File

@ -2,6 +2,7 @@
#include <CGAL/Delaunay_triangulation_3.h>
#include <CGAL/Triangulation_3_to_lcc.h>
#include <cassert>
#include <cstdlib>
typedef CGAL::Linear_cell_complex_for_combinatorial_map<3> LCC_3;
typedef CGAL::Delaunay_triangulation_3<LCC_3::Traits> Triangulation;
@ -19,5 +20,6 @@ int main()
auto d2 = CGAL::import_from_triangulation_3(lcc2, T);
assert(d2 == LCC_3::null_descriptor);
return 0;
}
return EXIT_SUCCESS;
}

View File

@ -122,14 +122,6 @@ import_from_polyhedron_3(LCC& alcc, const Polyhedron &apoly)
<typename LCC::Traits> > (alcc, P);
}
template < class LCC >
[[deprecated("Use polyhedron_3_flux_to_lcc instead")]]
typename LCC::Dart_descriptor
import_from_polyhedron_3_flux(LCC& alcc, std::istream& ais)
{
return polyhedron_3_flux_to_lcc(alcc, ais);
}
} // namespace CGAL
#endif // CGAL_IMPORT_FROM_POLYHEDRON_3_H