diff -r 8b29d935f1a6 -r 7c88989ea45b doc/etikol.texi --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/etikol.texi Tue Jan 20 11:21:42 2004 +0000 @@ -0,0 +1,188 @@ +\input texinfo @c -*-texinfo-*- +@comment $Id: etikol.texi,v 1.1 2004/01/20 11:21:42 alpar Exp $ +@comment %**start of header +@setfilename etikol.info +@include version.texi +@settitle GNU ETIK-OL Optimization Library @value{VERSION} +@syncodeindex pg cp + +@c @ifnottex +@c @macro mref { nn, txt } +@c @ref{\nn\,\txt\} +@c @end macro +@c @end ifnottex +@c @iftex +@macro mref { nn, txt } +@ifnottex +@ref{\nn\,\txt\} +@end ifnottex +@tex +\txt\ +@end tex +@end macro +@c @href{\nn\}{\txt\} + + + +@c @ifplaintext +@c Whereas this text will only appear in plain text. +@c @end ifplaintext +@c @ifxml +@c And this will only appear in XML output. +@c @end ifxm +@c @ref{\nn\,\txt\} + + +@comment %**end of header +@copying +This manual is for GNU ETIL-OL Optimization Library +(version @value{VERSION}, @value{UPDATED}). + +Copyright @copyright{} 2003 ETIK. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the +license is included in the section entitled ``GNU Free Documentation +License.'' + +(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify +this GNU Manual, like GNU software. Copies published by the Free +Software Foundation raise funds for GNU development.'' +@end quotation +@end copying + +@dircategory Texinfo documentation system +@direntry +* ETIK-OL: ETIK-OL Optimization Library. +@end direntry + +@titlepage +@title GNU ETIL-OL Optimization Library +@subtitle for version @value{VERSION}, @value{UPDATED} +@author ETIK Group +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top GNU ETIK-OL Library + +@insertcopying +@end ifnottex + +@menu +* Basic Concepts:: +* Copying This Manual:: +* Index:: +@end menu + + +@node Basic Concepts +@chapter Basic Concepts + +@menu +* The Full Feature Graph Class:: +* The BFS algorithm:: +@end menu + +@include flf-graph.texi + +@c @node A Full Feature Graph +@c @section A Full Feature Graph +@c @cindex Full Feature Graph + +@node The BFS algorithm +@section The BFS algorithm +@cindex The BFS algorithm + +@menu +* Iterator style BFS class:: +* The BFS funcion:: +@end menu + +bla2 + +@node Iterator style BFS class +@subsection Iterator style BFS class +@cindex BFS algorithm +@cindex BFS concept + +Here is a code example. + + +@quotation +@verbatim +class +{ +public: + bfs_node_data NodeType::*d; + typedef typename G::EdgeIterator value_type; + void Put(typename G::NodeIterator &i, + const value_type &t); + value_type Get(const typename G::NodeIterator &i) const; +} tree; +@end verbatim +@end quotation + + +The same code with a remark. + +@comment @quotation +@example +class +@{ +public: + bfs_node_data NodeType::*d; + typedef typename G::EdgeIterator value_type; + void Put(typename G::NodeIterator &i, + const value_type &t); @r{This is a long funcion declaration.} + value_type Get(const typename G::NodeIterator &i) const; +@} tree; +@end example +@comment @end quotation + +@node The BFS funcion +@subsection The BFS funcion +@cindex BFS algorithm + +@enumerate +@item +This is the first item. + +@item +This is the second item. +@end enumerate + + +@node Copying This Manual +@appendix Copying This Manual + +@menu +* GNU Free Documentation License:: License for copying this manual. +@end menu + +@include fdl.texi + + +@node Index +@unnumbered Concept Index +@printindex cp + +@c @node Function Index +@unnumbered Function Index +@printindex fn + +@c @node Type Index +@unnumbered Type Index +@printindex tp + +@bye +