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