2123: Misc. fixes in graph and line graph entities.
https://svn.lrde.epita.fr/svn/oln/trunk/milena Index: ChangeLog from Roland Levillain <roland@lrde.epita.fr> Misc. fixes in graph and line graph entities. * mln/core/graph_psite.hh, mln/core/line_graph_psite.hh, * mln/core/p_graph_piter.hh, mln/core/p_line_graph_piter.hh: Fix spacing in template definitions. * mln/core/p_graph.hh, mln/core/p_line_graph.hh: Likewise. Fix documentation. graph_psite.hh | 5 ++++- p_graph.hh | 22 ++++++++++++++-------- p_line_graph.hh | 10 ++++++---- 3 files changed, 24 insertions(+), 13 deletions(-) Index: mln/core/line_graph_psite.hh Index: mln/core/p_graph_piter.hh Index: mln/core/p_line_graph.hh --- mln/core/p_line_graph.hh (revision 2122) +++ mln/core/p_line_graph.hh (working copy) @@ -74,12 +74,14 @@ /// Backward Point_Iterator associated type. typedef p_line_graph_bkd_piter_<P> bkd_piter; - /// Return The number of points (sites) of the set, i.e., the - /// number of \em edges, since this is a point set based on a line - /// graph. + /// \brief Return The number of points (sites) of the set, i.e., + /// the number of \em edges, since this is a point set based on a + /// line graph. + /// + /// Required by the mln::Point_Set concept. std::size_t npoints() const; - /// Return The number of vertices (vertices) in the graph. + /// Return The number of vertices in the graph. std::size_t nvertices() const; /// Return The number of edges in the graph. std::size_t nedges() const; Index: mln/core/p_line_graph_piter.hh Index: mln/core/graph_psite.hh --- mln/core/graph_psite.hh (revision 2122) +++ mln/core/graph_psite.hh (working copy) @@ -31,13 +31,15 @@ /// \file mln/core/graph_psite.hh /// \brief Definition of a graph-based point site. +# include <mln/core/concept/point_site.hh> + # include <mln/core/p_graph.hh> namespace mln { - // Fwd decl. + // Forward declaration. template<typename P> class p_graph; @@ -113,6 +115,7 @@ /// \} + # ifndef MLN_INCLUDE_ONLY template<typename P> Index: mln/core/p_graph.hh --- mln/core/p_graph.hh (revision 2122) +++ mln/core/p_graph.hh (working copy) @@ -28,16 +28,18 @@ #ifndef MLN_CORE_P_GRAPH_HH # define MLN_CORE_P_GRAPH_HH -# include <mln/core/concept/point_site.hh> +/// \file mln/core/p_graph.hh +/// \brief Definition of a point set based on graph. + # include <mln/core/internal/point_set_base.hh> + # include <mln/accu/bbox.hh> # include <mln/util/tracked_ptr.hh> # include <mln/util/graph.hh> + # include <mln/core/graph_psite.hh> # include <mln/core/p_graph_piter.hh> -/// \file mln/core/p_graph.hh -/// \brief Definition of a point set based on graph. namespace mln { @@ -68,11 +70,13 @@ /// Backward Point_Iterator associated type. typedef p_graph_bkd_piter_<P> bkd_piter; - /// Return The number of points (sites) of the set, i.e., the - /// number of \em vertices. + /// \brief Return The number of points (sites) of the set, i.e., + /// the number of \em vertices. + /// + /// Required by the mln::Point_Set concept. std::size_t npoints() const; - /// Return The number of vertices (vertices) in the graph. + /// Return The number of vertices in the graph. std::size_t nvertices() const; /// Return The number of edges in the graph. std::size_t nedges() const; @@ -110,7 +114,8 @@ const util::vertex_id& rhs) const; /// \} - /// Return the graph associated to the p_graph domain: + /// Return the graph associated to the p_graph domain. + // FIXME: Rename as something else (graph() ?). const graph& to_graph() const; graph& to_graph(); @@ -138,7 +143,7 @@ /// \brief Inclusion of a mln::p_graph in another one. /// /// This inclusion relation is very strict for the moment, since our - /// infrastrure for graphs i simple: a mln::p_graph is included + /// infrastrure for graphs is simple: a mln::p_graph is included /// in another one if their are equal. /// /// \todo Refine this later, when we are able to express subgraph @@ -148,6 +153,7 @@ operator<=(const p_graph<P>& lhs, const p_graph<P>& rhs); + # ifndef MLN_INCLUDE_ONLY template<typename P>
participants (1)
-
Roland Levillain