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