doc/etikol.texi
changeset 18 7c88989ea45b
child 27 318e79d80819
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/etikol.texi	Tue Jan 20 11:21:42 2004 +0000
     1.3 @@ -0,0 +1,188 @@
     1.4 +\input texinfo   @c -*-texinfo-*-
     1.5 +@comment $Id: etikol.texi,v 1.1 2004/01/20 11:21:42 alpar Exp $
     1.6 +@comment %**start of header
     1.7 +@setfilename etikol.info
     1.8 +@include version.texi
     1.9 +@settitle GNU ETIK-OL Optimization Library @value{VERSION}
    1.10 +@syncodeindex pg cp
    1.11 +
    1.12 +@c @ifnottex
    1.13 +@c @macro mref { nn, txt }
    1.14 +@c @ref{\nn\,\txt\}
    1.15 +@c @end macro
    1.16 +@c @end ifnottex
    1.17 +@c @iftex
    1.18 +@macro mref { nn, txt }
    1.19 +@ifnottex
    1.20 +@ref{\nn\,\txt\}
    1.21 +@end ifnottex
    1.22 +@tex
    1.23 +\txt\
    1.24 +@end tex
    1.25 +@end macro
    1.26 +@c @href{\nn\}{\txt\}
    1.27 +
    1.28 +
    1.29 +
    1.30 +@c @ifplaintext
    1.31 +@c Whereas this text will only appear in plain text.
    1.32 +@c @end ifplaintext
    1.33 +@c @ifxml
    1.34 +@c And this will only appear in XML output.
    1.35 +@c @end ifxm
    1.36 +@c @ref{\nn\,\txt\}
    1.37 +
    1.38 +
    1.39 +@comment %**end of header
    1.40 +@copying
    1.41 +This manual is for GNU ETIL-OL Optimization Library
    1.42 +(version @value{VERSION}, @value{UPDATED}).
    1.43 +
    1.44 +Copyright @copyright{} 2003 ETIK.
    1.45 +
    1.46 +@quotation
    1.47 +Permission is granted to copy, distribute and/or modify this document
    1.48 +under the terms of the GNU Free Documentation License, Version 1.1 or
    1.49 +any later version published by the Free Software Foundation; with no
    1.50 +Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
    1.51 +and with the Back-Cover Texts as in (a) below.  A copy of the
    1.52 +license is included in the section entitled ``GNU Free Documentation
    1.53 +License.''
    1.54 +
    1.55 +(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
    1.56 +this GNU Manual, like GNU software.  Copies published by the Free
    1.57 +Software Foundation raise funds for GNU development.''
    1.58 +@end quotation
    1.59 +@end copying
    1.60 +
    1.61 +@dircategory Texinfo documentation system
    1.62 +@direntry
    1.63 +* ETIK-OL: ETIK-OL Optimization Library.
    1.64 +@end direntry
    1.65 +
    1.66 +@titlepage
    1.67 +@title GNU  ETIL-OL Optimization Library
    1.68 +@subtitle for version @value{VERSION}, @value{UPDATED}
    1.69 +@author ETIK Group
    1.70 +@page
    1.71 +@vskip 0pt plus 1filll
    1.72 +@insertcopying
    1.73 +@end titlepage
    1.74 +
    1.75 +@contents
    1.76 +
    1.77 +@ifnottex
    1.78 +@node Top
    1.79 +@top GNU ETIK-OL Library
    1.80 +
    1.81 +@insertcopying
    1.82 +@end ifnottex
    1.83 +
    1.84 +@menu
    1.85 +* Basic Concepts::
    1.86 +* Copying This Manual::
    1.87 +* Index::
    1.88 +@end menu
    1.89 +
    1.90 +
    1.91 +@node Basic Concepts
    1.92 +@chapter Basic Concepts
    1.93 +
    1.94 +@menu
    1.95 +* The Full Feature Graph Class::
    1.96 +* The BFS algorithm::
    1.97 +@end menu
    1.98 +
    1.99 +@include flf-graph.texi
   1.100 +
   1.101 +@c @node A Full Feature Graph
   1.102 +@c @section A Full Feature Graph
   1.103 +@c @cindex Full Feature Graph
   1.104 +
   1.105 +@node The BFS algorithm
   1.106 +@section The BFS algorithm
   1.107 +@cindex The BFS algorithm
   1.108 +
   1.109 +@menu
   1.110 +* Iterator style BFS class::
   1.111 +* The BFS funcion::
   1.112 +@end menu
   1.113 +
   1.114 +bla2 
   1.115 +
   1.116 +@node Iterator style BFS class
   1.117 +@subsection Iterator style BFS class
   1.118 +@cindex BFS algorithm
   1.119 +@cindex BFS concept
   1.120 +
   1.121 +Here is a code example.
   1.122 +
   1.123 +
   1.124 +@quotation
   1.125 +@verbatim
   1.126 +class 
   1.127 +{
   1.128 +public:
   1.129 +  bfs_node_data<G> NodeType::*d;
   1.130 +  typedef typename G::EdgeIterator value_type;
   1.131 +  void Put(typename G::NodeIterator &i,
   1.132 +           const value_type &t);
   1.133 +  value_type Get(const typename G::NodeIterator &i) const;
   1.134 +} tree;    
   1.135 +@end verbatim
   1.136 +@end quotation
   1.137 +
   1.138 +
   1.139 +The same code with a remark.
   1.140 +
   1.141 +@comment @quotation
   1.142 +@example
   1.143 +class 
   1.144 +@{
   1.145 +public:
   1.146 +  bfs_node_data<G> NodeType::*d;
   1.147 +  typedef typename G::EdgeIterator value_type;
   1.148 +  void Put(typename G::NodeIterator &i,
   1.149 +           const value_type &t);        @r{This is a long funcion declaration.}
   1.150 +  value_type Get(const typename G::NodeIterator &i) const;
   1.151 +@} tree;    
   1.152 +@end example
   1.153 +@comment @end quotation
   1.154 +
   1.155 +@node The BFS funcion
   1.156 +@subsection The BFS funcion
   1.157 +@cindex BFS algorithm
   1.158 +
   1.159 +@enumerate
   1.160 +@item
   1.161 +This is the first item.
   1.162 +
   1.163 +@item
   1.164 +This is the second item.
   1.165 +@end enumerate
   1.166 +
   1.167 +
   1.168 +@node Copying This Manual
   1.169 +@appendix Copying This Manual
   1.170 +
   1.171 +@menu
   1.172 +* GNU Free Documentation License::  License for copying this manual.
   1.173 +@end menu
   1.174 +
   1.175 +@include fdl.texi
   1.176 +
   1.177 +
   1.178 +@node Index
   1.179 +@unnumbered Concept Index
   1.180 +@printindex cp
   1.181 +
   1.182 +@c @node Function Index
   1.183 +@unnumbered Function Index
   1.184 +@printindex fn
   1.185 +
   1.186 +@c @node Type Index
   1.187 +@unnumbered Type Index
   1.188 +@printindex tp
   1.189 +
   1.190 +@bye
   1.191 +