lemon/bits/traits.h
author Peter Kovacs <kpeter@inf.elte.hu>
Thu, 09 Oct 2008 13:27:35 +0200
changeset 314 2cc60866a0c9
parent 220 a5d8c039f218
child 360 75cf49ce5390
permissions -rw-r--r--
Doc reorganization + improvements

- Reorganize several tools (move them to other modules).
- Add new module for map concepts.
- Remove the doc of all tools in lemon/bits.
- Improvements in groups.dox.
- Fix some doxygen warnings.
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2008
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 #ifndef LEMON_BITS_TRAITS_H
    20 #define LEMON_BITS_TRAITS_H
    21 
    22 //\file
    23 //\brief Traits for graphs and maps
    24 //
    25 
    26 #include <lemon/bits/enable_if.h>
    27 
    28 namespace lemon {
    29 
    30   struct InvalidType {};
    31 
    32   template <typename _Graph, typename _Item>
    33   class ItemSetTraits {};
    34 
    35 
    36   template <typename Graph, typename Enable = void>
    37   struct NodeNotifierIndicator {
    38     typedef InvalidType Type;
    39   };
    40   template <typename Graph>
    41   struct NodeNotifierIndicator<
    42     Graph,
    43     typename enable_if<typename Graph::NodeNotifier::Notifier, void>::type
    44   > {
    45     typedef typename Graph::NodeNotifier Type;
    46   };
    47 
    48   template <typename _Graph>
    49   class ItemSetTraits<_Graph, typename _Graph::Node> {
    50   public:
    51 
    52     typedef _Graph Graph;
    53 
    54     typedef typename Graph::Node Item;
    55     typedef typename Graph::NodeIt ItemIt;
    56 
    57     typedef typename NodeNotifierIndicator<Graph>::Type ItemNotifier;
    58 
    59     template <typename _Value>
    60     class Map : public Graph::template NodeMap<_Value> {
    61     public:
    62       typedef typename Graph::template NodeMap<_Value> Parent;
    63       typedef typename Graph::template NodeMap<_Value> Type;
    64       typedef typename Parent::Value Value;
    65 
    66       Map(const Graph& _digraph) : Parent(_digraph) {}
    67       Map(const Graph& _digraph, const Value& _value)
    68         : Parent(_digraph, _value) {}
    69 
    70      };
    71 
    72   };
    73 
    74   template <typename Graph, typename Enable = void>
    75   struct ArcNotifierIndicator {
    76     typedef InvalidType Type;
    77   };
    78   template <typename Graph>
    79   struct ArcNotifierIndicator<
    80     Graph,
    81     typename enable_if<typename Graph::ArcNotifier::Notifier, void>::type
    82   > {
    83     typedef typename Graph::ArcNotifier Type;
    84   };
    85 
    86   template <typename _Graph>
    87   class ItemSetTraits<_Graph, typename _Graph::Arc> {
    88   public:
    89 
    90     typedef _Graph Graph;
    91 
    92     typedef typename Graph::Arc Item;
    93     typedef typename Graph::ArcIt ItemIt;
    94 
    95     typedef typename ArcNotifierIndicator<Graph>::Type ItemNotifier;
    96 
    97     template <typename _Value>
    98     class Map : public Graph::template ArcMap<_Value> {
    99     public:
   100       typedef typename Graph::template ArcMap<_Value> Parent;
   101       typedef typename Graph::template ArcMap<_Value> Type;
   102       typedef typename Parent::Value Value;
   103 
   104       Map(const Graph& _digraph) : Parent(_digraph) {}
   105       Map(const Graph& _digraph, const Value& _value)
   106         : Parent(_digraph, _value) {}
   107     };
   108 
   109   };
   110 
   111   template <typename Graph, typename Enable = void>
   112   struct EdgeNotifierIndicator {
   113     typedef InvalidType Type;
   114   };
   115   template <typename Graph>
   116   struct EdgeNotifierIndicator<
   117     Graph,
   118     typename enable_if<typename Graph::EdgeNotifier::Notifier, void>::type
   119   > {
   120     typedef typename Graph::EdgeNotifier Type;
   121   };
   122 
   123   template <typename _Graph>
   124   class ItemSetTraits<_Graph, typename _Graph::Edge> {
   125   public:
   126 
   127     typedef _Graph Graph;
   128 
   129     typedef typename Graph::Edge Item;
   130     typedef typename Graph::EdgeIt ItemIt;
   131 
   132     typedef typename EdgeNotifierIndicator<Graph>::Type ItemNotifier;
   133 
   134     template <typename _Value>
   135     class Map : public Graph::template EdgeMap<_Value> {
   136     public:
   137       typedef typename Graph::template EdgeMap<_Value> Parent;
   138       typedef typename Graph::template EdgeMap<_Value> Type;
   139       typedef typename Parent::Value Value;
   140 
   141       Map(const Graph& _digraph) : Parent(_digraph) {}
   142       Map(const Graph& _digraph, const Value& _value)
   143         : Parent(_digraph, _value) {}
   144     };
   145 
   146   };
   147 
   148   template <typename Map, typename Enable = void>
   149   struct MapTraits {
   150     typedef False ReferenceMapTag;
   151 
   152     typedef typename Map::Key Key;
   153     typedef typename Map::Value Value;
   154 
   155     typedef Value ConstReturnValue;
   156     typedef Value ReturnValue;
   157   };
   158 
   159   template <typename Map>
   160   struct MapTraits<
   161     Map, typename enable_if<typename Map::ReferenceMapTag, void>::type >
   162   {
   163     typedef True ReferenceMapTag;
   164 
   165     typedef typename Map::Key Key;
   166     typedef typename Map::Value Value;
   167 
   168     typedef typename Map::ConstReference ConstReturnValue;
   169     typedef typename Map::Reference ReturnValue;
   170 
   171     typedef typename Map::ConstReference ConstReference;
   172     typedef typename Map::Reference Reference;
   173  };
   174 
   175   template <typename MatrixMap, typename Enable = void>
   176   struct MatrixMapTraits {
   177     typedef False ReferenceMapTag;
   178 
   179     typedef typename MatrixMap::FirstKey FirstKey;
   180     typedef typename MatrixMap::SecondKey SecondKey;
   181     typedef typename MatrixMap::Value Value;
   182 
   183     typedef Value ConstReturnValue;
   184     typedef Value ReturnValue;
   185   };
   186 
   187   template <typename MatrixMap>
   188   struct MatrixMapTraits<
   189     MatrixMap, typename enable_if<typename MatrixMap::ReferenceMapTag,
   190                                   void>::type >
   191   {
   192     typedef True ReferenceMapTag;
   193 
   194     typedef typename MatrixMap::FirstKey FirstKey;
   195     typedef typename MatrixMap::SecondKey SecondKey;
   196     typedef typename MatrixMap::Value Value;
   197 
   198     typedef typename MatrixMap::ConstReference ConstReturnValue;
   199     typedef typename MatrixMap::Reference ReturnValue;
   200 
   201     typedef typename MatrixMap::ConstReference ConstReference;
   202     typedef typename MatrixMap::Reference Reference;
   203  };
   204 
   205   // Indicators for the tags
   206 
   207   template <typename Graph, typename Enable = void>
   208   struct NodeNumTagIndicator {
   209     static const bool value = false;
   210   };
   211 
   212   template <typename Graph>
   213   struct NodeNumTagIndicator<
   214     Graph,
   215     typename enable_if<typename Graph::NodeNumTag, void>::type
   216   > {
   217     static const bool value = true;
   218   };
   219 
   220   template <typename Graph, typename Enable = void>
   221   struct EdgeNumTagIndicator {
   222     static const bool value = false;
   223   };
   224 
   225   template <typename Graph>
   226   struct EdgeNumTagIndicator<
   227     Graph,
   228     typename enable_if<typename Graph::EdgeNumTag, void>::type
   229   > {
   230     static const bool value = true;
   231   };
   232 
   233   template <typename Graph, typename Enable = void>
   234   struct FindEdgeTagIndicator {
   235     static const bool value = false;
   236   };
   237 
   238   template <typename Graph>
   239   struct FindEdgeTagIndicator<
   240     Graph,
   241     typename enable_if<typename Graph::FindEdgeTag, void>::type
   242   > {
   243     static const bool value = true;
   244   };
   245 
   246   template <typename Graph, typename Enable = void>
   247   struct UndirectedTagIndicator {
   248     static const bool value = false;
   249   };
   250 
   251   template <typename Graph>
   252   struct UndirectedTagIndicator<
   253     Graph,
   254     typename enable_if<typename Graph::UndirectedTag, void>::type
   255   > {
   256     static const bool value = true;
   257   };
   258 
   259   template <typename Graph, typename Enable = void>
   260   struct BuildTagIndicator {
   261     static const bool value = false;
   262   };
   263 
   264   template <typename Graph>
   265   struct BuildTagIndicator<
   266     Graph,
   267     typename enable_if<typename Graph::BuildTag, void>::type
   268   > {
   269     static const bool value = true;
   270   };
   271 
   272 }
   273 
   274 #endif