# HG changeset patch # User marci # Date 1112192951 0 # Node ID b143e42c44dee9cc599456a0439530e3e36b4545 # Parent 16980bf77bd30a76107a7f02443484f057cb215e latex documentation for TightEdgeFilterMap, including amsmath and amssymb latex packages for latex documentation diff -r 16980bf77bd3 -r b143e42c44de doc/Doxyfile --- a/doc/Doxyfile Wed Mar 30 13:01:58 2005 +0000 +++ b/doc/Doxyfile Wed Mar 30 14:29:11 2005 +0000 @@ -462,6 +462,7 @@ gwrappers.dox \ ../src/lemon \ ../src/lemon/concept \ + ../src/demo \ ../src/test/test_tools.h # If the value of the INPUT tag contains directories, you can use the @@ -766,7 +767,8 @@ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = amsmath \ + amssymb # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until diff -r 16980bf77bd3 -r b143e42c44de src/demo/tight_edge_filter_map.h --- a/src/demo/tight_edge_filter_map.h Wed Mar 30 13:01:58 2005 +0000 +++ b/src/demo/tight_edge_filter_map.h Wed Mar 30 14:29:11 2005 +0000 @@ -25,19 +25,25 @@ namespace lemon { - /// \brief A map for filtering the edge-set to those edges - /// which are tight w.r.t. some node_potential map and - /// edge_distance map. - /// - /// A node-map node_potential is said to be a potential w.r.t. - /// an edge-map edge_distance - /// if and only if for each edge e, node_potential[g.target(e)] - /// <= edge_distance[e]+node_potential[g.source(e)] - /// (or the reverse inequality holds for each edge). - /// An edge is said to be tight if this inequality holds with equality, - /// and the map returns true exactly for those edges. - /// To avoid rounding errors, it is recommended to use this class with exact - /// types, e.g. with int. + /*! + \brief A map for filtering the edge-set to those edges + which are tight w.r.t. a node-potential and + edge-distance. + + Let \f$G=(V,A)\f$ be a directed graph (graph for short) and + let \f$\mathbb{F}\f$ be a number type. + Given a distance function + \f$d:E\to\mathbb{F}\f$, + \f$\pi:V\to\mathbb{F}\f$ is said to be a potetial + w.r.t. \f$d\f$ + if and only if + \f$\pi(v)\le d(uv)+\pi(u)\f$ holds for each edge \f$uv\in E\f$ + (or the reverse inequality holds for each edge). + An edge is said to be tight if this inequality holds with equality, + and the map returns \c true exactly for those edges. + To avoid rounding errors, it is recommended to use this class with exact + number types, e.g. with \c int. + */ template class TightEdgeFilterMap : public MapBase { @@ -59,5 +65,3 @@ } //namespace lemon #endif //LEMON_TIGHT_EDGE_FILTER_MAP_H - -