lemon/bits/invalid.h
author Peter Kovacs <kpeter@inf.elte.hu>
Sun, 03 Aug 2008 13:34:57 +0200
changeset 244 c30731a37f91
parent 49 9a556af88710
permissions -rw-r--r--
Many improvements in bfs.h, dfs.h and dijkstra.h
- Add run() function to Bfs and run(s,t) function to DfsVisit.
- Add debug checking to addSource() function of Dfs and DfsVisit.
- Add a few missing named parameters (according to \todo notes).
- Small fixes in the code (e.g. missing derivations).
- Many doc improvements.
- Remove \todo and \warning comments which are no longer valid.
- Remove \author commands (see ticket #39).
- Fixes in the the doc (e.g. wrong references).
- Hide the doc of most of the private and protected members.
- Use public typedefs instead of template parameters in public functions.
- Use better parameter names for some functions.
- Other small changes to make the doc more uniform.
     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_INVALID_H
    20 #define LEMON_BITS_INVALID_H
    21 
    22 ///\file
    23 ///\brief Definition of INVALID.
    24 
    25 namespace lemon {
    26 
    27   /// \brief Dummy type to make it easier to create invalid iterators.
    28   ///
    29   /// Dummy type to make it easier to create invalid iterators.
    30   /// See \ref INVALID for the usage.
    31   struct Invalid {
    32   public:
    33     bool operator==(Invalid) { return true;  }
    34     bool operator!=(Invalid) { return false; }
    35     bool operator< (Invalid) { return false; }
    36   };
    37 
    38   /// \brief Invalid iterators.
    39   ///
    40   /// \ref Invalid is a global type that converts to each iterator
    41   /// in such a way that the value of the target iterator will be invalid.
    42 
    43   //Some people didn't like this:
    44   //const Invalid &INVALID = *(Invalid *)0;
    45 
    46 #ifdef LEMON_ONLY_TEMPLATES
    47   const Invalid INVALID = Invalid();
    48 #else
    49   extern const Invalid INVALID;
    50 #endif
    51 
    52 } //namespace lemon
    53 
    54 #endif
    55