doc/etikol.texi
author alpar
Sun, 04 Apr 2004 09:17:58 +0000
changeset 289 98adf9276de0
parent 29 c7ac1a6fb05c
permissions -rw-r--r--
Some improvements and proposals in map.doc.
demo -> work in Doxyfile.
alpar@18
     1
\input texinfo   @c -*-texinfo-*-
alpar@70
     2
@comment $Id: etikol.texi,v 1.5 2004/02/10 13:29:15 alpar Exp $
alpar@18
     3
@comment %**start of header
alpar@18
     4
@setfilename etikol.info
alpar@18
     5
@include version.texi
alpar@18
     6
@settitle GNU ETIK-OL Optimization Library @value{VERSION}
alpar@18
     7
@syncodeindex pg cp
alpar@18
     8
alpar@18
     9
@c @ifnottex
alpar@18
    10
@c @macro mref { nn, txt }
alpar@18
    11
@c @ref{\nn\,\txt\}
alpar@18
    12
@c @end macro
alpar@18
    13
@c @end ifnottex
alpar@18
    14
@c @iftex
alpar@18
    15
@macro mref { nn, txt }
alpar@18
    16
@ifnottex
alpar@18
    17
@ref{\nn\,\txt\}
alpar@18
    18
@end ifnottex
alpar@18
    19
@tex
alpar@18
    20
\txt\
alpar@18
    21
@end tex
alpar@18
    22
@end macro
alpar@18
    23
@c @href{\nn\}{\txt\}
alpar@18
    24
alpar@18
    25
alpar@18
    26
alpar@18
    27
@c @ifplaintext
alpar@18
    28
@c Whereas this text will only appear in plain text.
alpar@18
    29
@c @end ifplaintext
alpar@18
    30
@c @ifxml
alpar@18
    31
@c And this will only appear in XML output.
alpar@18
    32
@c @end ifxm
alpar@18
    33
@c @ref{\nn\,\txt\}
alpar@18
    34
alpar@18
    35
alpar@18
    36
@comment %**end of header
alpar@18
    37
alpar@70
    38
@copying
alpar@70
    39
This manual is for GNU ETIL-OL Optimization Library
alpar@70
    40
(version @value{VERSION}, @value{UPDATED}).
alpar@18
    41
alpar@70
    42
Copyright @copyright{} 2003 ETIK.
alpar@18
    43
alpar@70
    44
@quotation
alpar@70
    45
Permission is granted to copy, distribute and/or modify this document
alpar@70
    46
under the terms of the GNU Free Documentation License, Version 1.1 or
alpar@70
    47
any later version published by the Free Software Foundation; with no
alpar@70
    48
Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
alpar@70
    49
and with the Back-Cover Texts as in (a) below.  A copy of the
alpar@70
    50
license is included in the section entitled ``GNU Free Documentation
alpar@70
    51
License.''
alpar@27
    52
alpar@70
    53
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
alpar@70
    54
this GNU Manual, like GNU software.  Copies published by the Free
alpar@70
    55
Software Foundation raise funds for GNU development.''
alpar@70
    56
@end quotation
alpar@70
    57
@end copying
alpar@18
    58
alpar@18
    59
@dircategory Texinfo documentation system
alpar@18
    60
@direntry
alpar@18
    61
* ETIK-OL: ETIK-OL Optimization Library.
alpar@18
    62
@end direntry
alpar@18
    63
alpar@18
    64
@titlepage
alpar@18
    65
@title GNU  ETIL-OL Optimization Library
alpar@18
    66
@subtitle for version @value{VERSION}, @value{UPDATED}
alpar@18
    67
@author ETIK Group
alpar@18
    68
@page
alpar@18
    69
@vskip 0pt plus 1filll
alpar@28
    70
@c @insertcopying
alpar@18
    71
@end titlepage
alpar@18
    72
alpar@18
    73
@contents
alpar@18
    74
alpar@18
    75
@ifnottex
alpar@18
    76
@node Top
alpar@18
    77
@top GNU ETIK-OL Library
alpar@18
    78
alpar@29
    79
@c @insertcopying
alpar@18
    80
@end ifnottex
alpar@18
    81
alpar@18
    82
@menu
alpar@18
    83
* Basic Concepts::
alpar@18
    84
* Copying This Manual::
alpar@18
    85
* Index::
alpar@18
    86
@end menu
alpar@18
    87
alpar@18
    88
alpar@18
    89
@node Basic Concepts
alpar@18
    90
@chapter Basic Concepts
alpar@18
    91
alpar@18
    92
@menu
alpar@18
    93
* The Full Feature Graph Class::
alpar@18
    94
* The BFS algorithm::
alpar@18
    95
@end menu
alpar@18
    96
alpar@18
    97
@include flf-graph.texi
alpar@18
    98
alpar@18
    99
@c @node A Full Feature Graph
alpar@18
   100
@c @section A Full Feature Graph
alpar@18
   101
@c @cindex Full Feature Graph
alpar@18
   102
alpar@18
   103
@node The BFS algorithm
alpar@18
   104
@section The BFS algorithm
alpar@18
   105
@cindex The BFS algorithm
alpar@18
   106
alpar@18
   107
@menu
alpar@18
   108
* Iterator style BFS class::
alpar@18
   109
* The BFS funcion::
alpar@18
   110
@end menu
alpar@18
   111
alpar@18
   112
bla2 
alpar@18
   113
alpar@18
   114
@node Iterator style BFS class
alpar@18
   115
@subsection Iterator style BFS class
alpar@18
   116
@cindex BFS algorithm
alpar@18
   117
@cindex BFS concept
alpar@18
   118
alpar@18
   119
Here is a code example.
alpar@18
   120
alpar@18
   121
alpar@18
   122
@quotation
alpar@18
   123
@verbatim
alpar@18
   124
class 
alpar@18
   125
{
alpar@18
   126
public:
alpar@18
   127
  bfs_node_data<G> NodeType::*d;
alpar@18
   128
  typedef typename G::EdgeIterator value_type;
alpar@18
   129
  void Put(typename G::NodeIterator &i,
alpar@18
   130
           const value_type &t);
alpar@18
   131
  value_type Get(const typename G::NodeIterator &i) const;
alpar@18
   132
} tree;    
alpar@18
   133
@end verbatim
alpar@18
   134
@end quotation
alpar@18
   135
alpar@18
   136
alpar@18
   137
The same code with a remark.
alpar@18
   138
alpar@18
   139
@comment @quotation
alpar@18
   140
@example
alpar@18
   141
class 
alpar@18
   142
@{
alpar@18
   143
public:
alpar@18
   144
  bfs_node_data<G> NodeType::*d;
alpar@18
   145
  typedef typename G::EdgeIterator value_type;
alpar@18
   146
  void Put(typename G::NodeIterator &i,
alpar@18
   147
           const value_type &t);        @r{This is a long funcion declaration.}
alpar@18
   148
  value_type Get(const typename G::NodeIterator &i) const;
alpar@18
   149
@} tree;    
alpar@18
   150
@end example
alpar@18
   151
@comment @end quotation
alpar@18
   152
alpar@18
   153
@node The BFS funcion
alpar@18
   154
@subsection The BFS funcion
alpar@18
   155
@cindex BFS algorithm
alpar@18
   156
alpar@18
   157
@enumerate
alpar@18
   158
@item
alpar@18
   159
This is the first item.
alpar@18
   160
alpar@18
   161
@item
alpar@18
   162
This is the second item.
alpar@18
   163
@end enumerate
alpar@18
   164
alpar@18
   165
alpar@18
   166
@node Copying This Manual
alpar@18
   167
@appendix Copying This Manual
alpar@18
   168
alpar@18
   169
@menu
alpar@18
   170
* GNU Free Documentation License::  License for copying this manual.
alpar@18
   171
@end menu
alpar@18
   172
alpar@18
   173
@include fdl.texi
alpar@18
   174
alpar@18
   175
alpar@18
   176
@node Index
alpar@18
   177
@unnumbered Concept Index
alpar@18
   178
@printindex cp
alpar@18
   179
alpar@18
   180
@c @node Function Index
alpar@18
   181
@unnumbered Function Index
alpar@18
   182
@printindex fn
alpar@18
   183
alpar@18
   184
@c @node Type Index
alpar@18
   185
@unnumbered Type Index
alpar@18
   186
@printindex tp
alpar@18
   187
alpar@18
   188
@bye
alpar@18
   189