songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation of helper functions

This commit is contained in:
Andreas Fabri 2015-03-17 18:41:14 +01:00
parent 39f0768623
commit 020d2ff054
3 changed files with 43 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
BGL/doc/BGL/Doxyfile.in
View File

@ -4,6 +4,7 @@ PROJECT_NAME = "CGAL ${CGAL_CREATED_VERSION_NUM} - CGAL a
INPUT = ${CMAKE_SOURCE_DIR}/BGL/doc/BGL/ \
${CMAKE_SOURCE_DIR}/BGL/include/CGAL/boost/graph/Euler_operations.h \
${CMAKE_SOURCE_DIR}/BGL/include/CGAL/boost/graph/iterator.h \
${CMAKE_SOURCE_DIR}/BGL/include/CGAL/boost/graph/Graph_geometry.h
${CMAKE_SOURCE_DIR}/BGL/include/CGAL/boost/graph/Graph_geometry.h \
${CMAKE_SOURCE_DIR}/BGL/include/CGAL/boost/graph/helpers.h
ALIASES += "bgllink{1}=<a href=\"http://www.boost.org/libs/graph/doc/\1.html\"><code>\1</code></a>"

6
BGL/doc/BGL/PackageDescription.txt
View File

@ -37,6 +37,9 @@
/// \defgroup PkgBGLHelper Helper Classes
/// \ingroup PkgBGL
/// \defgroup PkgBGLHelperFct Helper Functions
/// \ingroup PkgBGL
/// \defgroup PkgBGLIterators Iterators and Circulators
/// \ingroup PkgBGL
@ -120,6 +123,9 @@ user might encounter.
- `CGAL::HalfedgeDS_face_max_base_with_id`
- `CGAL::Polyhedron_items_with_id_3`
## Helper Fnuctions ##
- `CGAL::is_border()`
## Iterators ##
- `CGAL::Halfedge_around_source_iterator`
- `CGAL::Halfedge_around_target_iterator`

48
BGL/include/CGAL/boost/graph/helpers.h
View File

@ -27,45 +27,60 @@
namespace CGAL {
/*!
\ingroup PkgBGLHelperFct
returns `true` if the halfedge `hd` is on a border.
*/
template <typename FaceGraph>
bool is_border(typename boost::graph_traits<FaceGraph>::halfedge_descriptor hd, const FaceGraph& g)
{
return face(hd,g) == boost::graph_traits<FaceGraph>::null_face();
}
/*!
\ingroup PkgBGLHelperFct
returns `true` if the halfedge `hd` or the opposite halfedge is on a border.
*/
template <typename FaceGraph>
bool is_border_edge(typename boost::graph_traits<FaceGraph>::halfedge_descriptor hd, const FaceGraph& g)
{
return is_border(hd, g) || is_border(opposite(hd,g), g);
}
/*!
\ingroup PkgBGLHelperFct
returns `true` if the edge `e` is on a border.
*/
template <typename FaceGraph>
bool is_border(typename boost::graph_traits<FaceGraph>::edge_descriptor ed, const FaceGraph& g)
{
return is_border_edge(halfedge(ed,g), g);
}
template <typename Graph>
boost::optional<typename boost::graph_traits<Graph>::halfedge_descriptor>
is_border(typename boost::graph_traits<Graph>::vertex_descriptor v,
const Graph& g)
/*!
\ingroup PkgBGLHelperFct
returns a halfedge which is on a border and whose target vertex is `vd`, if such a halfedge exists.
*/
template <typename FaceGraph>
boost::optional<typename boost::graph_traits<FaceGraph>::halfedge_descriptor>
is_border(typename boost::graph_traits<FaceGraph>::vertex_descriptor vd,
const FaceGraph& g)
{
CGAL::Halfedge_around_target_iterator<Graph> havib, havie;
for(boost::tie(havib, havie) = halfedges_around_target(halfedge(v, g), g); havib != havie; ++havib) {
CGAL::Halfedge_around_target_iterator<FaceGraph> havib, havie;
for(boost::tie(havib, havie) = halfedges_around_target(halfedge(vd, g), g); havib != havie; ++havib) {
if(is_border(*havib,g)) {
typename boost::graph_traits<Graph>::halfedge_descriptor h = *havib;
typename boost::graph_traits<FaceGraph>::halfedge_descriptor h = *havib;
return h;
}
}
// empty
return boost::optional<typename boost::graph_traits<Graph>::halfedge_descriptor>();
return boost::optional<typename boost::graph_traits<FaceGraph>::halfedge_descriptor>();
}
/*!
returns `true` if there are no
border edges.
\ingroup PkgBGLHelperFct
returns `true` if there are no border edges.
*/
template <typename FaceGraph>
bool is_closed(const FaceGraph& g)
@ -87,8 +102,8 @@ bool is_bivalent(typename boost::graph_traits<FaceGraph>::halfedge_descriptor hd
}
/*!
returns `true` if all
vertices have exactly two incident edges.
\ingroup PkgBGLHelperFct
returns `true` if all vertices have exactly two incident edges.
*/
template <typename FaceGraph>
bool is_pure_bivalent(const FaceGraph& g)
@ -112,6 +127,7 @@ bool is_trivalent(typename boost::graph_traits<FaceGraph>::halfedge_descriptor h
}
/*!
\ingroup PkgBGLHelperFct
returns `true` if all
vertices have exactly three incident edges.
*/
@ -131,6 +147,7 @@ template <typename FaceGraph>
}
/*!
\ingroup PkgBGLHelperFct
returns `true` iff the connected component denoted by `h` is a triangle.
\pre `g` must be valid.
*/
@ -148,6 +165,7 @@ template <typename FaceGraph>
}
/*!
\ingroup PkgBGLHelperFct
returns `true` iff the face is a triangle, that is it has three incident halfedges.
*/
template <typename FaceGraph>
@ -159,6 +177,7 @@ bool is_triangle(typename boost::graph_traits<FaceGraph>::face_descriptor fd, co
}
/*!
\ingroup PkgBGLHelperFct
returns `true` if all faces are triangles.
*/
template <typename FaceGraph>
@ -175,6 +194,7 @@ template <typename FaceGraph>
/*!
\ingroup PkgBGLHelperFct
returns `true` iff the connected component denoted by `h` is a quadrilateral.
*/
template <typename FaceGraph>
@ -203,6 +223,7 @@ bool is_quad(typename boost::graph_traits<FaceGraph>::face_descriptor fd, const
}
/*!
\ingroup PkgBGLHelperFct
returns `true` if all faces are quadrilaterals.
*/
template <typename FaceGraph>
@ -218,6 +239,7 @@ template <typename FaceGraph>
}
/*!
\ingroup PkgBGLHelperFct
returns `true` iff the connected component denoted by `h` is a tetrahedron.
*/
template <typename FaceGraph>