diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_constructors.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_constructors.h index b91112d1dff..41b6e029142 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_constructors.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex_constructors.h @@ -28,15 +28,15 @@ Here a small example: \sa `CGAL::polyhedron_3_to_lcc` */ template -typename LCC::Dart_descriptor plane_graph_to_lcc(LCC& lcc, +typename LCC::Dart_descriptor read_plane_graph_in_lcc(LCC& lcc, std::istream& ais); /*! \ingroup PkgLinearCellComplexConstructions -\deprecated Use `plane_graph_to_lcc()` instead. +\deprecated Use `read_plane_graph_in_lcc()` instead. */ template -[[deprecated("Use plane_graph_to_lcc instead")]] +[[deprecated("Use read_plane_graph_in_lcc instead")]] typename LCC::Dart_descriptor import_from_plane_graph(LCC& lcc, std::istream& ais); } /* namespace CGAL */ diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Polyhedron_3_to_lcc.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Polyhedron_3_to_lcc.h index ce0dc47401f..88660898143 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Polyhedron_3_to_lcc.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Polyhedron_3_to_lcc.h @@ -5,7 +5,7 @@ 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` +\sa `CGAL::read_plane_graph_in_lcc` \sa `CGAL::triangulation_3_to_lcc` */ template diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Triangulation_3_to_lcc.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Triangulation_3_to_lcc.h index aa86e5e6ffa..4234cc98cab 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Triangulation_3_to_lcc.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Triangulation_3_to_lcc.h @@ -8,7 +8,7 @@ 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::plane_graph_to_lcc` +\sa `CGAL::read_plane_graph_in_lcc` \sa `CGAL::polyhedron_3_to_lcc` */ diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h index e6a6f767393..391c1ad8ece 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/Concepts/LinearCellComplexTraits.h @@ -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`). +and `CGAL::read_plane_graph_in_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`). +a model of \link Kernel::ConstructDirection_2 `ConstructDirection_2`\endlink (used in `CGAL::read_plane_graph_in_lcc`). */ typedef unspecified_type Construct_direction_2; diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt index 7d2db0cbfd7..de286dedf78 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt @@ -109,7 +109,7 @@ There are two functions allowing to build a linear cell complex from two other \
  • \link ::polyhedron_3_to_lcc `polyhedron_3_to_lcc(lcc,ap)`\endlink: adds in `lcc` all the cells present in `ap`, a `Polyhedron_3`. -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). +Lastly, the function \link ::read_plane_graph_in_lcc `read_plane_graph_in_lcc(lcc,ais)`\endlink adds in `lcc` all the cells reconstructed from the planar graph read in `ais`, a `std::istream` (see the \link ::read_plane_graph_in_lcc `reference manual`\endlink for the file format). \subsection Linear_cell_complexModificationOperations Modification Operations \anchor ssecmodifop diff --git a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt index 0a521ff5a3c..f0f70d53797 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt @@ -62,7 +62,7 @@ \cgalCRPSection{Global Functions} \cgalCRPSubsection{Constructions for Linear Cell Complex} -- `CGAL::plane_graph_to_lcc` (formerly `import_from_plane_graph`) +- `CGAL::read_plane_graph_in_lcc` (formerly `import_from_plane_graph`) - `CGAL::triangulation_3_to_lcc` (formerly `import_from_triangulation_3`) - `CGAL::polyhedron_3_to_lcc` (formerly `import_from_polyhedron_3`) diff --git a/Linear_cell_complex/examples/Linear_cell_complex/CMakeLists.txt b/Linear_cell_complex/examples/Linear_cell_complex/CMakeLists.txt index e9604793e4b..d5b66adf6fa 100644 --- a/Linear_cell_complex/examples/Linear_cell_complex/CMakeLists.txt +++ b/Linear_cell_complex/examples/Linear_cell_complex/CMakeLists.txt @@ -24,7 +24,7 @@ create_single_source_cgal_program( "linear_cell_complex_3_with_colored_vertices.cpp") create_single_source_cgal_program("linear_cell_complex_3_with_mypoint.cpp") create_single_source_cgal_program("linear_cell_complex_4.cpp") -create_single_source_cgal_program("plane_graph_to_lcc_2.cpp") +create_single_source_cgal_program("read_plane_graph_in_lcc_2.cpp") create_single_source_cgal_program("voronoi_2.cpp") create_single_source_cgal_program("voronoi_3.cpp") diff --git a/Linear_cell_complex/examples/Linear_cell_complex/README.txt b/Linear_cell_complex/examples/Linear_cell_complex/README.txt index e461312f2dd..9184123bfeb 100644 --- a/Linear_cell_complex/examples/Linear_cell_complex/README.txt +++ b/Linear_cell_complex/examples/Linear_cell_complex/README.txt @@ -8,7 +8,7 @@ Examples for Linear_cell_complex package: Three "basic" examples, detailed in the user manual. -* plane_graph_to_lcc_2.cpp +* read_plane_graph_in_lcc_2.cpp Program allowing to transform a planar graph into a 2D linear cell complex. diff --git a/Linear_cell_complex/examples/Linear_cell_complex/plane_graph_to_lcc_2.cpp b/Linear_cell_complex/examples/Linear_cell_complex/read_plane_graph_in_lcc_2.cpp similarity index 97% rename from Linear_cell_complex/examples/Linear_cell_complex/plane_graph_to_lcc_2.cpp rename to Linear_cell_complex/examples/Linear_cell_complex/read_plane_graph_in_lcc_2.cpp index 4aa82742a06..c6ef3bac676 100644 --- a/Linear_cell_complex/examples/Linear_cell_complex/plane_graph_to_lcc_2.cpp +++ b/Linear_cell_complex/examples/Linear_cell_complex/read_plane_graph_in_lcc_2.cpp @@ -42,7 +42,7 @@ int main(int narg, char** argv) std::ifstream is(filename.c_str()); std::cout<<"Import plane graph from "< - typename LCC::Dart_descriptor plane_graph_to_lcc(LCC& alcc, + typename LCC::Dart_descriptor read_plane_graph_in_lcc(LCC& alcc, const std::vector& vertices, const std::vector& edge_indices) { @@ -131,13 +131,13 @@ namespace CGAL { } template< class LCC > -[[deprecated("Use plane_graph_to_lcc instead")]] +[[deprecated("Use read_plane_graph_in_lcc instead")]] typename LCC::Dart_descriptor import_from_plane_graph(LCC& alcc, const std::vector& vertices, const std::vector& edge_indices) { - return plane_graph_to_lcc(alcc, vertices, edge_indices); + return read_plane_graph_in_lcc(alcc, vertices, edge_indices); } /** @@ -148,7 +148,7 @@ import_from_plane_graph(LCC& alcc, * @return A dart created during the conversion. */ template< class LCC > - typename LCC::Dart_descriptor plane_graph_to_lcc(LCC& alcc, + typename LCC::Dart_descriptor read_plane_graph_in_lcc(LCC& alcc, std::istream& ais) { using FT = typename LCC::FT; @@ -195,32 +195,32 @@ import_from_plane_graph(LCC& alcc, edge_indices.push_back(v2); } - return plane_graph_to_lcc(alcc, vertices, edge_indices); + return read_plane_graph_in_lcc(alcc, vertices, edge_indices); } template -[[deprecated("Use plane_graph_to_lcc instead")]] +[[deprecated("Use read_plane_graph_in_lcc instead")]] typename LCC::Dart_descriptor import_from_plane_graph(LCC& alcc, std::istream& ais) { - return plane_graph_to_lcc(alcc, ais); + return read_plane_graph_in_lcc(alcc, ais); } template < class LCC > typename LCC::Dart_descriptor - plane_graph_to_lcc(LCC& alcc, const char* filename) + read_plane_graph_in_lcc(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 read_plane_graph_in_lcc(alcc, input); } template -[[deprecated("Use plane_graph_to_lcc instead")]] +[[deprecated("Use read_plane_graph_in_lcc instead")]] typename LCC::Dart_descriptor import_from_plane_graph(LCC& alcc, const char* filename) { - return plane_graph_to_lcc(alcc, filename); + return read_plane_graph_in_lcc(alcc, filename); } template < class LCC > diff --git a/Linear_cell_complex/test/Linear_cell_complex/Linear_cell_complex_2_test.h b/Linear_cell_complex/test/Linear_cell_complex/Linear_cell_complex_2_test.h index 122163f433f..c1a80876d35 100644 --- a/Linear_cell_complex/test/Linear_cell_complex/Linear_cell_complex_2_test.h +++ b/Linear_cell_complex/test/Linear_cell_complex/Linear_cell_complex_2_test.h @@ -382,7 +382,7 @@ bool test_LCC_2() std::cout<<"Error: impossible to open 'data/graph.txt'"<(lcc,in); + CGAL::read_plane_graph_in_lcc(lcc,in); if ( !check_number_of_cells_2(lcc, 66, 166, 104, 2) ) return false; lcc.clear(); @@ -431,7 +431,7 @@ struct Test_change_orientation_LCC_2 std::cout<<"Error: impossible to open 'data/graph.txt'"<(lcc,in); + CGAL::read_plane_graph_in_lcc(lcc,in); trace_test_begin(); diff --git a/Linear_cell_complex/test/Linear_cell_complex/test_plane_graph_alias.cpp b/Linear_cell_complex/test/Linear_cell_complex/test_plane_graph_alias.cpp index 9ecc3e3a694..905a17f1409 100644 --- a/Linear_cell_complex/test/Linear_cell_complex/test_plane_graph_alias.cpp +++ b/Linear_cell_complex/test/Linear_cell_complex/test_plane_graph_alias.cpp @@ -15,7 +15,7 @@ int main() input << "3 3\n0.0 0.0\n1.0 0.0\n0.0 1.0\n0 1\n1 2\n2 0\n"; // Test new function - auto d1 = CGAL::plane_graph_to_lcc(lcc1, input); + auto d1 = CGAL::read_plane_graph_in_lcc(lcc1, input); assert(d1 != LCC::null_descriptor); // Rewind input stream for second test