RhodeCode

EXTRA_DIST += \

	doc/Doxyfile.in \

	doc/coding_style.dox \

	doc/dirs.dox \

	doc/groups.dox \

	doc/license.dox \

	doc/mainpage.dox \

	doc/namespaces.dox \

	doc/html

DOC_EPS_IMAGES18 = \

	nodeshape_0.eps \

	nodeshape_1.eps \

	nodeshape_2.eps \

	nodeshape_3.eps \

	nodeshape_4.eps

DOC_EPS_IMAGES = \

	$(DOC_EPS_IMAGES18)

DOC_PNG_IMAGES = \

	$(DOC_EPS_IMAGES:%.eps=doc/gen-images/%.png)

EXTRA_DIST += $(DOC_EPS_IMAGES:%=doc/images/%)

doc/html:

	$(MAKE) $(AM_MAKEFLAGS) html

GS_COMMAND=gs -dNOPAUSE -dBATCH -q -dEPSCrop -dTextAlphaBits=4 -dGraphicsAlphaBits=4

$(DOC_EPS_IMAGES18:%.eps=doc/gen-images/%.png): doc/gen-images/%.png: doc/images/%.eps

	-mkdir doc/gen-images

	if test ${gs_found} = yes; then \

	  $(GS_COMMAND) -sDEVICE=pngalpha -r18 -sOutputFile=$@ $<; \

	else \

	  echo; \

	  echo "Ghostscript not found."; \

	  echo; \

	  exit 1; \

	fi

html-local: $(DOC_PNG_IMAGES)

	if test ${doxygen_found} = yes; then \

	  cd doc; \

	  doxygen Doxyfile; \

	  cd ..; \

	else \

	  echo; \

	  echo "Doxygen not found."; \

	  echo; \

	  exit 1; \

	fi

clean-local:

	-rm -rf doc/html

	-rm -f doc/doxygen.log

	-rm -f $(DOC_PNG_IMAGES)

	-rm -rf doc/gen-images

update-external-tags:

	wget -O doc/libstdc++.tag.tmp http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/libstdc++.tag && \

	mv doc/libstdc++.tag.tmp doc/libstdc++.tag || \

	rm doc/libstdc++.tag.tmp

install-html-local: doc/html

	@$(NORMAL_INSTALL)

	$(mkinstalldirs) $(DESTDIR)$(htmldir)/docs

	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

	  f="`echo $$p | sed -e 's|^.*/||'`"; \

	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/docs/$$f"; \

	  $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/docs/$$f; \

	done

uninstall-local:

	@$(NORMAL_UNINSTALL)

	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

	  f="`echo $$p | sed -e 's|^.*/||'`"; \

	  echo " rm -f $(DESTDIR)$(htmldir)/docs/$$f"; \

	  rm -f $(DESTDIR)$(htmldir)/docs/$$f; \

	done

.PHONY: update-external-tags

\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \qquad \forall u \in V \setminus \{s,t\}\f]

\f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]

LEMON contains several algorithms for solving maximum flow problems:

- \ref lemon::EdmondsKarp "Edmonds-Karp" 

- \ref lemon::Preflow "Goldberg's Preflow algorithm"

- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"

- \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees"

In most cases the \ref lemon::Preflow "Preflow" algorithm provides the

fastest method to compute the maximum flow. All impelementations

provides functions to query the minimum cut, which is the dual linear

programming problem of the maximum flow.

*/

/**

@defgroup min_cost_flow Minimum Cost Flow algorithms

@ingroup algs

\brief Algorithms for finding minimum cost flows and circulations.

This group describes the algorithms for finding minimum cost flows and

circulations.  

*/

/**

@defgroup min_cut Minimum Cut algorithms 

@ingroup algs 

\brief Algorithms for finding minimum cut in graphs.

This group describes the algorithms for finding minimum cut in graphs.

The minimum cut problem is to find a non-empty and non-complete

\f$X\f$ subset of the vertices with minimum overall capacity on

outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an

\f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum

cut is the \f$X\f$ solution of the next optimization problem:

\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}\sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]

LEMON contains several algorithms related to minimum cut problems:

- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut

  in directed graphs  

- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to

  calculate minimum cut in undirected graphs

- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all

  pairs minimum cut in undirected graphs

If you want to find minimum cut just between two distinict nodes,

please see the \ref max_flow "Maximum Flow page".

*/

/**

@defgroup graph_prop Connectivity and other graph properties

@ingroup algs

\brief Algorithms for discovering the graph properties

This group describes the algorithms for discovering the graph properties

like connectivity, bipartiteness, euler property, simplicity etc.

\image html edge_biconnected_components.png

\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth

*/

/**

@defgroup planar Planarity embedding and drawing

@ingroup algs

\brief Algorithms for planarity checking, embedding and drawing

This group describes the algorithms for planarity checking, embedding and drawing.

\image html planar.png

\image latex planar.eps "Plane graph" width=\textwidth

*/

/**

@defgroup matching Matching algorithms 

@ingroup algs

\brief Algorithms for finding matchings in graphs and bipartite graphs.

This group contains algorithm objects and functions to calculate

matchings in graphs and bipartite graphs. The general matching problem is

finding a subset of the arcs which does not shares common endpoints.

There are several different algorithms for calculate matchings in

graphs.  The matching problems in bipartite graphs are generally

easier than in general graphs. The goal of the matching optimization

can be the finding maximum cardinality, maximum weight or minimum cost

matching. The search can be constrained to find perfect or

maximum cardinality matching.

Lemon contains the next algorithms:

- \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp 

  augmenting path algorithm for calculate maximum cardinality matching in 

  bipartite graphs

- \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel 

  algorithm for calculate maximum cardinality matching in bipartite graphs 

- \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching" 

  Successive shortest path algorithm for calculate maximum weighted matching 

  and maximum weighted bipartite matching in bipartite graph

- \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching" 

  Successive shortest path algorithm for calculate minimum cost maximum 

  matching in bipartite graph

- \ref lemon::MaxMatching "MaxMatching" Edmond's blossom shrinking algorithm

  for calculate maximum cardinality matching in general graph

- \ref lemon::MaxWeightedMatching "MaxWeightedMatching" Edmond's blossom

  shrinking algorithm for calculate maximum weighted matching in general

  graph

- \ref lemon::MaxWeightedPerfectMatching "MaxWeightedPerfectMatching"

  Edmond's blossom shrinking algorithm for calculate maximum weighted

  perfect matching in general graph

\image html bipartite_matching.png

\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth

*/

/**

@defgroup spantree Minimum Spanning Tree algorithms

@ingroup algs

\brief Algorithms for finding a minimum cost spanning tree in a graph.

This group describes the algorithms for finding a minimum cost spanning

tree in a graph

*/

/**

@defgroup auxalg Auxiliary algorithms

@ingroup algs

\brief Auxiliary algorithms implemented in LEMON.

This group describes some algorithms implemented in LEMON

in order to make it easier to implement complex algorithms.

*/

/**

@defgroup approx Approximation algorithms

\brief Approximation algorithms.

This group describes the approximation and heuristic algorithms

implemented in LEMON.

*/

/**

@defgroup gen_opt_group General Optimization Tools

\brief This group describes some general optimization frameworks

implemented in LEMON.

This group describes some general optimization frameworks

implemented in LEMON.

*/

/**

@defgroup lp_group Lp and Mip solvers

@ingroup gen_opt_group

\brief Lp and Mip solver interfaces for LEMON.

This group describes Lp and Mip solver interfaces for LEMON. The

various LP solvers could be used in the same manner with this

interface.

*/

/** 

@defgroup lp_utils Tools for Lp and Mip solvers 

@ingroup lp_group

\brief Helper tools to the Lp and Mip solvers.

This group adds some helper tools to general optimization framework

implemented in LEMON.

*/

/**

@defgroup metah Metaheuristics

@ingroup gen_opt_group

\brief Metaheuristics for LEMON library.

This group describes some metaheuristic optimization tools.

*/

/**

@defgroup utils Tools and Utilities 

\brief Tools and utilities for programming in LEMON

Tools and utilities for programming in LEMON.

*/

/**

@defgroup gutils Basic Graph Utilities

@ingroup utils

\brief Simple basic graph utilities.

This group describes some simple basic graph utilities.

*/

/**

@defgroup misc Miscellaneous Tools

@ingroup utils

\brief Tools for development, debugging and testing.

This group describes several useful tools for development,

debugging and testing.

*/

/**

@defgroup timecount Time measuring and Counting

@ingroup misc

\brief Simple tools for measuring the performance of algorithms.

This group describes simple tools for measuring the performance

of algorithms.

*/

/**

@defgroup graphbits Tools for Graph Implementation

@ingroup utils

\brief Tools to make it easier to create graphs.

This group describes the tools that makes it easier to create graphs and

the maps that dynamically update with the graph changes.

*/

/**

@defgroup exceptions Exceptions

@ingroup utils

\brief Exceptions defined in LEMON.

This group describes the exceptions defined in LEMON.

*/

/**

@defgroup io_group Input-Output

\brief Graph Input-Output methods

This group describes the tools for importing and exporting graphs 

and graph related data. Now it supports the LEMON format, the

\c DIMACS format and the encapsulated postscript (EPS) format.

*/

/**

@defgroup lemon_io Lemon Input-Output

@ingroup io_group

\brief Reading and writing LEMON format

This group describes methods for reading and writing LEMON format. 

You can find more about this format on the \ref graph-io-page "Graph Input-Output"

tutorial pages.

*/

/**

@defgroup eps_io Postscript exporting

@ingroup io_group

\brief General \c EPS drawer and graph exporter

This group describes general \c EPS drawing methods and special

graph exporting tools. 

*/

/**

@defgroup concept Concepts

\brief Skeleton classes and concept checking classes

This group describes the data/algorithm skeletons and concept checking

classes implemented in LEMON.

The purpose of the classes in this group is fourfold.

- These classes contain the documentations of the concepts. In order

  to avoid document multiplications, an implementation of a concept

  simply refers to the corresponding concept class.

- These classes declare every functions, <tt>typedef</tt>s etc. an

  implementation of the concepts should provide, however completely

  without implementations and real data structures behind the

  interface. On the other hand they should provide nothing else. All

  the algorithms working on a data structure meeting a certain concept

  should compile with these classes. (Though it will not run properly,

  of course.) In this way it is easily to check if an algorithm

  doesn't use any extra feature of a certain implementation.

- The concept descriptor classes also provide a <em>checker class</em>

  that makes it possible to check whether a certain implementation of a

  concept indeed provides all the required features.

- Finally, They can serve as a skeleton of a new implementation of a concept.

*/

/**

@defgroup graph_concepts Graph Structure Concepts

@ingroup concept

\brief Skeleton and concept checking classes for graph structures

This group describes the skeletons and concept checking classes of LEMON's

graph structures and helper classes used to implement these.

*/

/* --- Unused group

@defgroup experimental Experimental Structures and Algorithms

This group describes some Experimental structures and algorithms.

The stuff here is subject to change.

*/

/**

\anchor demoprograms

@defgroup demos Demo programs

Some demo programs are listed here. Their full source codes can be found in

the \c demo subdirectory of the source tree.

It order to compile them, use <tt>--enable-demo</tt> configure option when

build the library.

*/

/**

@defgroup tools Standalone utility applications

Some utility applications are listed here. 

The standard compilation procedure (<tt>./configure;make</tt>) will compile

them, as well. 

*/

 * purpose.

 *

 */

///\ingroup lemon_io

///\file

///\brief Lemon Graph Format reader.

#ifndef LEMON_LGF_READER_H

#define LEMON_LGF_READER_H

#include <iostream>

#include <fstream>

#include <sstream>

#include <set>

#include <map>

#include <lemon/assert.h>

#include <lemon/graph_utils.h>

#include <lemon/lgf_writer.h>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

namespace lemon {

  namespace _reader_bits {

    template <typename Value>

    struct DefaultConverter {

      Value operator()(const std::string& str) {

	std::istringstream is(str);

	Value value;

	is >> value;

	char c;

	if (is >> std::ws >> c) {

	  throw DataFormatError("Remaining characters in token");

	}

	return value;

      }

    };

    template <>

    struct DefaultConverter<std::string> {

      std::string operator()(const std::string& str) {

	return str;

      }

    };

    template <typename _Item>    

    class MapStorageBase {

    public:

      typedef _Item Item;

    public:

      MapStorageBase() {}

      virtual ~MapStorageBase() {}

      virtual void set(const Item& item, const std::string& value) = 0;

    };

    template <typename _Item, typename _Map, 

	      typename _Converter = DefaultConverter<typename _Map::Value> >

    class MapStorage : public MapStorageBase<_Item> {

    public:

      typedef _Map Map;

      typedef _Converter Converter;

      typedef _Item Item;

    private:

      Map& _map;

      Converter _converter;

    public:

      MapStorage(Map& map, const Converter& converter = Converter()) 

	: _map(map), _converter(converter) {}

      virtual ~MapStorage() {}

      virtual void set(const Item& item ,const std::string& value) {

	_map.set(item, _converter(value));

      }

    };

    class ValueStorageBase {

    public:

      ValueStorageBase() {}

      virtual ~ValueStorageBase() {}

      virtual void set(const std::string&) = 0;

    };

    template <typename _Value, typename _Converter = DefaultConverter<_Value> >

    class ValueStorage : public ValueStorageBase {

    public:

      typedef _Value Value;

      typedef _Converter Converter;

    private:

      Value& _value;

      Converter _converter;

    public:

      ValueStorage(Value& value, const Converter& converter = Converter())

 	: _value(value), _converter(converter) {}

      virtual void set(const std::string& value) {

	_value = _converter(value);

      }

    };

    template <typename Value>

    struct MapLookUpConverter {

      const std::map<std::string, Value>& _map;

      MapLookUpConverter(const std::map<std::string, Value>& map)

        : _map(map) {}

      Value operator()(const std::string& str) {

        typename std::map<std::string, Value>::const_iterator it =

          _map.find(str);

        if (it == _map.end()) {

          std::ostringstream msg;

          msg << "Item not found: " << str;

          throw DataFormatError(msg.str().c_str());

        }

        return it->second;

      }

    };

    bool isWhiteSpace(char c) {

      return c == ' ' || c == '\t' || c == '\v' || 

        c == '\n' || c == '\r' || c == '\f'; 

    }

    bool isOct(char c) {

      return '0' <= c && c <='7'; 

    }

    int valueOct(char c) {

      LEMON_ASSERT(isOct(c), "The character is not octal.");

      return c - '0';

    }

    bool isHex(char c) {

      return ('0' <= c && c <= '9') || 

	('a' <= c && c <= 'z') || 

	('A' <= c && c <= 'Z'); 

    }

    int valueHex(char c) {

      LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");

      if ('0' <= c && c <= '9') return c - '0';

      if ('a' <= c && c <= 'z') return c - 'a' + 10;

      return c - 'A' + 10;

    }

    bool isIdentifierFirstChar(char c) {

      return ('a' <= c && c <= 'z') ||

	('A' <= c && c <= 'Z') || c == '_';

    }

    bool isIdentifierChar(char c) {

      return isIdentifierFirstChar(c) ||

	('0' <= c && c <= '9');

    }

    char readEscape(std::istream& is) {

      char c;

      if (!is.get(c))

	throw DataFormatError("Escape format error");

      switch (c) {

      case '\\':

	return '\\';

      case '\"':

	return '\"';

      case '\'':

	return '\'';

      case '\?':

	return '\?';

      case 'a':

	return '\a';

      case 'b':

	return '\b';

      case 'f':

	return '\f';

      case 'n':

	return '\n';

      case 'r':

	return '\r';

      case 't':

	return '\t';

      case 'v':

	return '\v';

      case 'x':

	{

	  int code;

	  if (!is.get(c) || !isHex(c)) 

	    throw DataFormatError("Escape format error");

	  else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);

	  else code = code * 16 + valueHex(c);

	  return code;

	}

      default:

	{

	  int code;

	  if (!isOct(c)) 

	    throw DataFormatError("Escape format error");

	  else if (code = valueOct(c), !is.get(c) || !isOct(c)) 

	    is.putback(c);

	  else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c)) 

	    is.putback(c);

	  else code = code * 8 + valueOct(c);

	  return code;

	}	      

      } 

    }

    std::istream& readToken(std::istream& is, std::string& str) {

      std::ostringstream os;

      char c;

      is >> std::ws;

      if (!is.get(c)) 

	return is;

      if (c == '\"') {

	while (is.get(c) && c != '\"') {

	  if (c == '\\') 

	    c = readEscape(is);

	  os << c;

	}

	if (!is) 

	  throw DataFormatError("Quoted format error");

      } else {

	is.putback(c);

	while (is.get(c) && !isWhiteSpace(c)) {

	  if (c == '\\') 

	    c = readEscape(is);

	  os << c;

	}

	if (!is) {

	  is.clear();

	} else {

	  is.putback(c);

	}

      }

      str = os.str();

      return is;

    }

  }

  template <typename _Digraph>

  class DigraphReader {

  public:

    typedef _Digraph Digraph;

    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);

  private:

    std::istream* _is;

    bool local_is;

    Digraph& _digraph;

    std::string _nodes_caption;

    std::string _arcs_caption;

    std::string _attributes_caption;

    typedef std::map<std::string, Node> NodeIndex;

    NodeIndex _node_index;

    typedef std::map<std::string, Arc> ArcIndex;

    ArcIndex _arc_index;

    typedef std::vector<std::pair<std::string, 

      _reader_bits::MapStorageBase<Node>*> > NodeMaps;    

    NodeMaps _node_maps; 

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Arc>*> >ArcMaps;

    ArcMaps _arc_maps;

    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*> 

      Attributes;

    Attributes _attributes;

    bool _use_nodes;

    bool _use_arcs;

    int line_num;

    std::istringstream line;

  public:

    DigraphReader(std::istream& is, Digraph& digraph) 

      : _is(&is), local_is(false), _digraph(digraph),

	_use_nodes(false), _use_arcs(false) {}

    DigraphReader(const std::string& fn, Digraph& digraph) 

      : _is(new std::ifstream(fn.c_str())), local_is(true), _digraph(digraph),

    	_use_nodes(false), _use_arcs(false) {}

    DigraphReader(const char* fn, Digraph& digraph) 

      : _is(new std::ifstream(fn)), local_is(true), _digraph(digraph),

    	_use_nodes(false), _use_arcs(false) {}

    DigraphReader(DigraphReader& other) 

      : _is(other._is), local_is(other.local_is), _digraph(other._digraph),

	_use_nodes(other._use_nodes), _use_arcs(other._use_arcs) {

      other.is = 0;

      other.local_is = false;

      _node_index.swap(other._node_index);

      _arc_index.swap(other._arc_index);

      _node_maps.swap(other._node_maps);

      _arc_maps.swap(other._arc_maps);

      _attributes.swap(other._attributes);

      _nodes_caption = other._nodes_caption;

      _arcs_caption = other._arcs_caption;

      _attributes_caption = other._attributes_caption;

    }

    ~DigraphReader() {

      for (typename NodeMaps::iterator it = _node_maps.begin(); 

	   it != _node_maps.end(); ++it) {

	delete it->second;

      }

      for (typename ArcMaps::iterator it = _arc_maps.begin(); 

	   it != _arc_maps.end(); ++it) {

	delete it->second;

      }

      for (typename Attributes::iterator it = _attributes.begin(); 

	   it != _attributes.end(); ++it) {

	delete it->second;

      }

      if (local_is) {

	delete _is;

      }

    }

  private:

    DigraphReader& operator=(const DigraphReader&);

  public:

    template <typename Map>

    DigraphReader& nodeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage = 

	new _reader_bits::MapStorage<Node, Map>(map);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    template <typename Map, typename Converter>

    DigraphReader& nodeMap(const std::string& caption, Map& map, 

			   const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage = 

	new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    template <typename Map>

    DigraphReader& arcMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Arc>* storage = 

	new _reader_bits::MapStorage<Arc, Map>(map);

      _arc_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    template <typename Map, typename Converter>

    DigraphReader& arcMap(const std::string& caption, Map& map, 

			  const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Arc>* storage = 

	new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);

      _arc_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    template <typename Value>

    DigraphReader& attribute(const std::string& caption, Value& value) {

      _reader_bits::ValueStorageBase* storage = 

	new _reader_bits::ValueStorage<Value>(value);

      _attributes.insert(std::make_pair(caption, storage));

      return *this;

    }

    template <typename Value, typename Converter>

    DigraphReader& attribute(const std::string& caption, Value& value, 

			     const Converter& converter = Converter()) {

      _reader_bits::ValueStorageBase* storage = 

	new _reader_bits::ValueStorage<Value, Converter>(value, converter);

      _attributes.insert(std::make_pair(caption, storage));

      return *this;

    }

    DigraphReader& node(const std::string& caption, Node& node) {

      typedef _reader_bits::MapLookUpConverter<Node> Converter;

      Converter converter(_node_index);

      _reader_bits::ValueStorageBase* storage = 

	new _reader_bits::ValueStorage<Node, Converter>(node, converter);

      _attributes.insert(std::make_pair(caption, storage));

      return *this;

    }

    DigraphReader& arc(const std::string& caption, Arc& arc) {

      typedef _reader_bits::MapLookUpConverter<Arc> Converter;

      Converter converter(_arc_index);

      _reader_bits::ValueStorageBase* storage = 

	new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);