lemon/bits/utility.h
author deba
Tue, 21 Nov 2006 18:29:31 +0000
changeset 2307 558cc308a4bd
parent 2151 38ec4a930c05
child 2386 81b47fc5c444
permissions -rw-r--r--
Some doc fix
     1 /* -*- C++ -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2003-2006
     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 // This file contains a modified version of the enable_if library from BOOST.
    20 // See the appropriate copyright notice below.
    21 
    22 // Boost enable_if library
    23 
    24 // Copyright 2003 © The Trustees of Indiana University.
    25 
    26 // Use, modification, and distribution is subject to the Boost Software
    27 // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
    28 // http://www.boost.org/LICENSE_1_0.txt)
    29 
    30 //    Authors: Jaakko Järvi (jajarvi at osl.iu.edu)
    31 //             Jeremiah Willcock (jewillco at osl.iu.edu)
    32 //             Andrew Lumsdaine (lums at osl.iu.edu)
    33 
    34 
    35 #ifndef LEMON_BITS_UTILITY_H
    36 #define LEMON_BITS_UTILITY_H
    37 
    38 ///\file
    39 ///\brief Miscellaneous basic utilities
    40 ///
    41 ///\todo Please rethink the organisation of the basic files like this.
    42 ///E.g. this file might be merged with invalid.h.
    43 
    44 
    45 namespace lemon
    46 {
    47 
    48   /// Basic type for defining "tags". A "YES" condition for \c enable_if.
    49 
    50   /// Basic type for defining "tags". A "YES" condition for \c enable_if.
    51   ///
    52   ///\sa False
    53   ///
    54   /// \todo This should go to a separate "basic_types.h" (or something)
    55   /// file.
    56   struct True {
    57     ///\e
    58     static const bool value = true;
    59   };
    60 
    61   /// Basic type for defining "tags". A "NO" condition for \c enable_if.
    62 
    63   /// Basic type for defining "tags". A "NO" condition for \c enable_if.
    64   ///
    65   ///\sa True
    66   struct False {
    67     ///\e
    68     static const bool value = false;
    69   };
    70 
    71 
    72   class InvalidType {
    73   private:
    74     InvalidType();
    75   };
    76 
    77   template <typename T>
    78   struct Wrap {
    79     const T &value;
    80     Wrap(const T &t) : value(t) {}
    81   };
    82 
    83   /**************** dummy class to avoid ambiguity ****************/
    84 
    85   template<int T> struct dummy { dummy(int) {} };
    86 
    87   /**************** enable_if from BOOST ****************/
    88  
    89   template <bool B, class T = void>
    90   struct enable_if_c {
    91     typedef T type;
    92   };
    93 
    94   template <class T>
    95   struct enable_if_c<false, T> {};
    96 
    97   template <class Cond, class T = void> 
    98   struct enable_if : public enable_if_c<Cond::value, T> {};
    99 
   100   template <bool B, class T>
   101   struct lazy_enable_if_c {
   102     typedef typename T::type type;
   103   };
   104 
   105   template <class T>
   106   struct lazy_enable_if_c<false, T> {};
   107 
   108   template <class Cond, class T> 
   109   struct lazy_enable_if : public lazy_enable_if_c<Cond::value, T> {};
   110 
   111 
   112   template <bool B, class T = void>
   113   struct disable_if_c {
   114     typedef T type;
   115   };
   116 
   117   template <class T>
   118   struct disable_if_c<true, T> {};
   119 
   120   template <class Cond, class T = void> 
   121   struct disable_if : public disable_if_c<Cond::value, T> {};
   122 
   123   template <bool B, class T>
   124   struct lazy_disable_if_c {
   125     typedef typename T::type type;
   126   };
   127 
   128   template <class T>
   129   struct lazy_disable_if_c<true, T> {};
   130 
   131   template <class Cond, class T> 
   132   struct lazy_disable_if : public lazy_disable_if_c<Cond::value, T> {};
   133 
   134 } // namespace lemon
   135 
   136 #endif