COIN-OR::LEMON - Graph Library

Changeset 2081:94a7deb46c07 in lemon-0.x for demo/tight_edge_filter_map.h


Ignore:
Timestamp:
05/12/06 17:29:42 (14 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2744
Message:

New demo file for computing disjoint paths

Doc review

Correcting misformatting in adaptors
Adding header to demos

File:
1 edited

Legend:

Unmodified
Added
Removed
  • demo/tight_edge_filter_map.h

    r2042 r2081  
    1717 */
    1818
    19 #ifndef LEMON_TIGHT_EDGE_FILTER_MAP_H
    20 #define LEMON_TIGHT_EDGE_FILTER_MAP_H
     19#ifndef DEMO_TIGHT_EDGE_FILTER_MAP_H
     20#define DEMO_TIGHT_EDGE_FILTER_MAP_H
    2121
    2222#include <lemon/maps.h>
    2323
    24 // /// \file
    25 // /// \brief Maximum flow algorithms.
    26 // /// \ingroup galgs
     24/// \file
     25/// \brief Tight edge filter map.
     26///
     27/// Tight edge filter map is bool map on the edges of the graph
     28/// which filters the edges which are not tight for a node-potential.
     29/// It is used in the \ref sub_graph_adaptor_demo.cc file.
     30///
     31/// \include tight_edge_filter_map.h
    2732
    2833namespace lemon {
    2934
    30   /*!
    31     \brief A map for filtering the edge-set to those edges
    32     which are tight w.r.t. a node-potential and
    33     edge-distance.
    34    
    35     Let \f$ G=(V,A) \f$ be a directed graph (graph for short) and
    36     let \f$ \mathbb{F} \f$ be a number type.
    37     Given a distance function
    38     \f$ d:E\to\mathbb{F} \f$,
    39     \f$ \pi:V\to\mathbb{F} \f$ is said to be a potetial
    40     w.r.t. \f$ d \f$
    41     if and only if
    42     \f$ \pi(v)\le d(uv)+\pi(u) \f$ holds for each edge \f$ uv\in E \f$
    43     (or the reverse inequality holds for each edge).
    44     An edge is said to be tight if this inequality holds with equality,
    45     and the map returns \c true exactly for those edges.
    46     To avoid rounding errors, it is recommended to use this class with exact
    47     number types, e.g. with \c int.
    48   */
     35  /// \brief A map for filtering the edge-set to those edges
     36  /// which are tight w.r.t. a node-potential and
     37  /// edge-distance.
     38  ///
     39  /// Let \f$ G=(V,A) \f$ be a directed graph (graph for short) and
     40  /// let \f$ \mathbb{F} \f$ be a number type.
     41  /// Given a distance function
     42  /// \f$ d:E\to\mathbb{F} \f$,
     43  /// \f$ \pi:V\to\mathbb{F} \f$ is said to be a potetial
     44  /// w.r.t. \f$ d \f$
     45  /// if and only if
     46  /// \f$ \pi(v)\le d(uv)+\pi(u) \f$ holds for each edge \f$ uv\in E \f$
     47  /// (or the reverse inequality holds for each edge).
     48  /// An edge is said to be tight if this inequality holds with equality,
     49  /// and the map returns \c true exactly for those edges.
     50  /// To avoid rounding errors, it is recommended to use this class with exact
     51  /// number types, e.g. with \c int.
    4952  template<typename Graph,
    5053           typename NodePotentialMap, typename EdgeDistanceMap>
     
    6770} //namespace lemon
    6871
    69 #endif //LEMON_TIGHT_EDGE_FILTER_MAP_H
     72#endif //DEMO_TIGHT_EDGE_FILTER_MAP_H
Note: See TracChangeset for help on using the changeset viewer.