gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Move the doc of the nauty group to groups.dox (#55)
0 2 0
default
2 files changed with 9 insertions and 9 deletions:
↑ Collapse diff ↑
Ignore white space 6 line context
... ...
@@ -443,66 +443,73 @@
443 443

	
444 444
This group describes simple tools for measuring the performance
445 445
of algorithms.
446 446
*/
447 447

	
448 448
/**
449 449
@defgroup exceptions Exceptions
450 450
@ingroup utils
451 451
\brief Exceptions defined in LEMON.
452 452

	
453 453
This group describes the exceptions defined in LEMON.
454 454
*/
455 455

	
456 456
/**
457 457
@defgroup io_group Input-Output
458 458
\brief Graph Input-Output methods
459 459

	
460 460
This group describes the tools for importing and exporting graphs
461 461
and graph related data. Now it supports the \ref lgf-format
462 462
"LEMON Graph Format", the \c DIMACS format and the encapsulated
463 463
postscript (EPS) format.
464 464
*/
465 465

	
466 466
/**
467
@defgroup lemon_io LEMON Input-Output
467
@defgroup lemon_io LEMON Graph Format
468 468
@ingroup io_group
469 469
\brief Reading and writing LEMON Graph Format.
470 470

	
471 471
This group describes methods for reading and writing
472 472
\ref lgf-format "LEMON Graph Format".
473 473
*/
474 474

	
475 475
/**
476 476
@defgroup eps_io Postscript Exporting
477 477
@ingroup io_group
478 478
\brief General \c EPS drawer and graph exporter
479 479

	
480 480
This group describes general \c EPS drawing methods and special
481 481
graph exporting tools.
482 482
*/
483 483

	
484 484
/**
485
@defgroup nauty_group NAUTY Format
486
@ingroup io_group
487
\brief Read \e Nauty format
488
Tool to read graphs from \e Nauty format data.
489
*/
490

	
491
/**
485 492
@defgroup concept Concepts
486 493
\brief Skeleton classes and concept checking classes
487 494

	
488 495
This group describes the data/algorithm skeletons and concept checking
489 496
classes implemented in LEMON.
490 497

	
491 498
The purpose of the classes in this group is fourfold.
492 499

	
493 500
- These classes contain the documentations of the %concepts. In order
494 501
  to avoid document multiplications, an implementation of a concept
495 502
  simply refers to the corresponding concept class.
496 503

	
497 504
- These classes declare every functions, <tt>typedef</tt>s etc. an
498 505
  implementation of the %concepts should provide, however completely
499 506
  without implementations and real data structures behind the
500 507
  interface. On the other hand they should provide nothing else. All
501 508
  the algorithms working on a data structure meeting a certain concept
502 509
  should compile with these classes. (Though it will not run properly,
503 510
  of course.) In this way it is easily to check if an algorithm
504 511
  doesn't use any extra feature of a certain implementation.
505 512

	
506 513
- The concept descriptor classes also provide a <em>checker class</em>
507 514
  that makes it possible to check whether a certain implementation of a
508 515
  concept indeed provides all the required features.
Ignore white space 48 line context
... ...
@@ -2,59 +2,52 @@
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_NAUTY_READER_H
20 20
#define LEMON_NAUTY_READER_H
21 21

	
22 22
#include <vector>
23 23
#include <iostream>
24 24
#include <string>
25 25

	
26
/// \ingroup io_group
27
///
28
/// @defgroup nauty_group NAUTY format
29
///
30
/// \brief Read \e Nauty format
31
///
32
/// Tool to read graphs from \e Nauty format data
33

	
34 26
/// \ingroup nauty_group
35 27
/// \file
36 28
/// \brief Nauty file reader.
29

	
37 30
namespace lemon {
38 31

	
39 32
  /// \ingroup nauty_group
40 33
  ///
41 34
  /// \brief Nauty file reader
42 35
  ///
43 36
  /// The \e geng program is in the \e gtools suite of the nauty
44 37
  /// package. This tool can generate all non-isomorphic undirected
45 38
  /// graphs with given node number from several classes (for example,
46 39
  /// general, connected, biconnected, triangle-free, 4-cycle-free,
47 40
  /// bipartite and graphs with given edge number and degree
48 41
  /// constraints). This function reads a \e nauty \e graph6 \e format
49 42
  /// line from the given stream and builds it in the given graph.
50 43
  ///
51 44
  /// The site of nauty package: http://cs.anu.edu.au/~bdm/nauty/
52 45
  ///
53 46
  /// For example, the number of all non-isomorphic connected graphs
54 47
  /// can be computed with following code.
55 48
  ///\code
56 49
  /// int num = 0;
57 50
  /// SmartGraph graph;
58 51
  /// while (readNauty(graph, std::cin)) {
59 52
  ///   PlanarityChecking<SmartGraph> pc(graph);
60 53
  ///   if (pc.run()) ++num;
0 comments (0 inline)