RhodeCode

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 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 \ref lgf-format

"LEMON Graph Format", the \c DIMACS format and the encapsulated

postscript (EPS) format.

*/

/**

@ingroup io_group

\brief Reading and writing LEMON Graph Format.

This group describes methods for reading and writing

\ref lgf-format "LEMON Graph Format".

*/

/**

@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.

*/

/**

@defgroup map_concepts Map Concepts

@ingroup concept

\brief Skeleton and concept checking classes for maps

This group describes the skeletons and concept checking classes of maps.

*/

/**

\anchor demoprograms

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library.

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_NAUTY_READER_H

#define LEMON_NAUTY_READER_H

#include <vector>

#include <iostream>

#include <string>

/// \ingroup nauty_group

/// \file

/// \brief Nauty file reader.

namespace lemon {

  /// \ingroup nauty_group

  ///

  /// \brief Nauty file reader

  ///

  /// The \e geng program is in the \e gtools suite of the nauty

  /// package. This tool can generate all non-isomorphic undirected

  /// graphs with given node number from several classes (for example,

  /// general, connected, biconnected, triangle-free, 4-cycle-free,

  /// bipartite and graphs with given edge number and degree

  /// constraints). This function reads a \e nauty \e graph6 \e format

  /// line from the given stream and builds it in the given graph.

  ///

  /// The site of nauty package: http://cs.anu.edu.au/~bdm/nauty/

  ///

  /// For example, the number of all non-isomorphic connected graphs

  /// can be computed with following code.

  ///\code

  /// int num = 0;

  /// SmartGraph graph;

  /// while (readNauty(graph, std::cin)) {

  ///   PlanarityChecking<SmartGraph> pc(graph);

  ///   if (pc.run()) ++num;

  /// }

  /// std::cout << "Number of planar graphs: " << num << std::endl;

  ///\endcode

  ///

  /// The nauty files are quite huge, therefore instead of the direct

  /// file generation the pipelining is recommended.

  ///\code

  /// ./geng -c 10 | ./num_of_pg

  ///\endcode

  template <typename Graph>

  std::istream& readNauty(Graph& graph, std::istream& is) {

    graph.clear();

    std::string line;

    if (getline(is, line)) {

      int index = 0;

      int n;

      if (line[index] == '>') {

        index += 10;

      }

      char c = line[index++]; c -= 63;