From 6a72d70f23e8e3da57e23c38b5d2b58d2f2254ad Mon Sep 17 00:00:00 2001 From: jhumeau Date: Tue, 19 Jan 2010 15:26:51 +0000 Subject: [PATCH] Avancement de la doc git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1654 331e1502-861f-0410-8da2-ba01fb791d7f --- branches/newMo/doc/mo.doxyfile.cmake | 426 ++++- branches/newMo/doc/mo.doxytag | 1367 ----------------- branches/newMo/src/CMakeLists.txt | 1 + branches/newMo/src/algo/moLocalSearch.h | 40 +- branches/newMo/src/comparator/moComparator.h | 9 +- .../src/comparator/moNeighborComparator.h | 8 +- .../newMo/src/continuator/moContinuator.h | 4 +- .../newMo/src/continuator/moTrueContinuator.h | 4 +- branches/newMo/src/eval/moEval.h | 3 + .../newMo/src/eval/moFullEvalBitNeighbor.h | 6 +- branches/newMo/src/eval/moFullEvalByCopy.h | 4 + branches/newMo/src/eval/moFullEvalByModif.h | 2 +- .../src/explorer/moNeighborhoodExplorer.h | 18 +- .../src/neighborhood/moBackableNeighbor.h | 4 +- branches/newMo/src/neighborhood/moNeighbor.h | 60 +- .../newMo/src/neighborhood/moNeighborhood.h | 17 +- branches/newMo/src/old/moMove.h | 12 +- branches/newMo/src/old/moMoveIncrEval.h | 12 +- branches/newMo/src/old/moMoveInit.h | 10 +- branches/newMo/src/old/moNextMove.h | 10 +- 20 files changed, 487 insertions(+), 1530 deletions(-) delete mode 100644 branches/newMo/doc/mo.doxytag diff --git a/branches/newMo/doc/mo.doxyfile.cmake b/branches/newMo/doc/mo.doxyfile.cmake index 60e84efda..7a9448449 100644 --- a/branches/newMo/doc/mo.doxyfile.cmake +++ b/branches/newMo/doc/mo.doxyfile.cmake @@ -1,4 +1,4 @@ -# Doxyfile 1.5.2 +# Doxyfile 1.5.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English @@ -123,7 +124,7 @@ FULL_PATH_NAMES = NO # If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ +STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -143,11 +144,19 @@ SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explicit @brief command for a brief description. +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = YES + # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. @@ -190,14 +199,37 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -205,11 +237,26 @@ OPTIMIZE_OUTPUT_JAVA = NO BUILTIN_STL_SUPPORT = NO -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default @@ -225,6 +272,32 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -259,6 +332,14 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the @@ -301,7 +382,7 @@ INTERNAL_DOCS = NO # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. -CASE_SENSE_NAMES = NO +CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the @@ -334,11 +415,17 @@ SORT_MEMBER_DOCS = NO SORT_BRIEF_DOCS = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. @@ -395,9 +482,22 @@ SHOW_USED_FILES = YES SHOW_DIRECTORIES = NO +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -405,6 +505,15 @@ SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -465,12 +574,13 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @CMAKE_SOURCE_DIR@/src +INPUT = @CMAKE_SOURCE_DIR@ -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -479,10 +589,12 @@ INPUT_ENCODING = UTF-8 # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.cpp \ - *.h + *.h \ + NEWS \ + README # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -494,7 +606,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -508,14 +620,15 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = */tutorial/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = *::* # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see @@ -548,14 +661,17 @@ IMAGE_PATH = # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. @@ -590,22 +706,23 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) +# If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentstion. +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -644,7 +761,7 @@ COLS_IN_ALPHA_INDEX = 3 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = mo +IGNORE_PREFIX = moeo #--------------------------------------------------------------------------- # configuration options related to the HTML output @@ -694,9 +811,43 @@ HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO @@ -721,6 +872,12 @@ HHC_LOCATION = GENERATE_CHI = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. @@ -732,6 +889,55 @@ BINARY_TOC = NO TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -743,12 +949,20 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. GENERATE_TREEVIEW = YES @@ -758,6 +972,14 @@ GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -970,8 +1192,10 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. @@ -1058,18 +1282,20 @@ SKIP_FUNCTION_MACROS = YES # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: -# TAGFILES = file1 file2 ... +# +# TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... +# +# TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = @EO_BIN_DIR@/doc/eo.doxytag=http://eodev.sourceforge.net/eo/doc/html +TAGFILES = @PARADISEO_EO_BIN_DIR@/doc/eo.doxytag=http://eodev.sourceforge.net/eo/doc/html # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. @@ -1107,10 +1333,11 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1127,6 +1354,29 @@ HIDE_UNDOC_RELATIONS = YES HAVE_DOT = NO +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the @@ -1171,19 +1421,19 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO @@ -1194,13 +1444,13 @@ GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include +# in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif +# generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png @@ -1216,19 +1466,31 @@ DOT_PATH = DOTFILE_DIRS = -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen will always -# show the root nodes and its direct children regardless of this setting. +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO @@ -1252,7 +1514,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Options related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/branches/newMo/doc/mo.doxytag b/branches/newMo/doc/mo.doxytag deleted file mode 100644 index 7ca1a54d1..000000000 --- a/branches/newMo/doc/mo.doxytag +++ /dev/null @@ -1,1367 +0,0 @@ - - - - main - Welcome to PARADISEO-Moving Objects - main - Paradiseo - authors - Introduction - LICENSE - Installation - - - moAlgo - classmo_algo.html - EOT - eoMonOp< EOT > - - - moAspirCrit - classmo_aspir_crit.html - M - eoBF - - virtual void - init - classmo_aspir_crit.html - a8ce84510a5ec7c9078381e542c6d140 - ()=0 - - - - moBestImprSelect - classmo_best_impr_select.html - M - moMoveSelect - - M::EOType::Fitness - Fitness - classmo_best_impr_select.html - c4ae17435221fb0a8e8acd285210cfcb - - - - void - init - classmo_best_impr_select.html - 83f961549986b8ad94692e433aa79114 - (const Fitness &_fitness) - - - bool - update - classmo_best_impr_select.html - 5c0729fd316b0ef78406bce5ca91de2a - (const M &_move, const Fitness &_fitness) - - - void - operator() - classmo_best_impr_select.html - 33b3de7bd322f737eb97cce9a5404527 - (M &_move, Fitness &_fitness) - - - bool - first_time - classmo_best_impr_select.html - 352b14d206b0772eb9f40efb7beb0f13 - - - - M - best_move - classmo_best_impr_select.html - bd86f70519f954c07ff0d8a2a3a8ff6a - - - - Fitness - best_fitness - classmo_best_impr_select.html - e51345fe28ca7cbaca65bdad1aa8ecb7 - - - - - moComparator - classmo_comparator.html - EOT - eoBF - - - moCoolingSchedule - classmo_cooling_schedule.html - eoUF< double &, bool > - - - moExponentialCoolingSchedule - classmo_exponential_cooling_schedule.html - moCoolingSchedule - - - moExponentialCoolingSchedule - classmo_exponential_cooling_schedule.html - e60ce9eb5e632f4758ea96ae92a52774 - (double _threshold, double _ratio) - - - bool - operator() - classmo_exponential_cooling_schedule.html - 95b075e9786a5cc984ef1bb59a2107e4 - (double &_temperature) - - - double - threshold - classmo_exponential_cooling_schedule.html - 8d4327c0bb33b7121a322279eea97f84 - - - - double - ratio - classmo_exponential_cooling_schedule.html - e8f3f87417c1c7253efb938a740846fa - - - - - moFirstImprSelect - classmo_first_impr_select.html - M - moMoveSelect - - M::EOType::Fitness - Fitness - classmo_first_impr_select.html - 64763ce3e6d2873266624382b407fa5a - - - - virtual void - init - classmo_first_impr_select.html - a923437ecc3db50e7052b002a9a1bbf8 - (const Fitness &_fitness) - - - bool - update - classmo_first_impr_select.html - f68b7ee7b35bf7347c16006f0587d313 - (const M &_move, const Fitness &_fitness) - - - void - operator() - classmo_first_impr_select.html - 976569efd882886cb13184daeba79766 - (M &_move, Fitness &_fitness) - - - bool - valid - classmo_first_impr_select.html - a99c0586ba07449234705c17a258d58c - - - - M - best_move - classmo_first_impr_select.html - dfed419a608dd7c41f07fa1f1279cb8c - - - - Fitness - initial_fitness - classmo_first_impr_select.html - 669f8f2f74e71bf2b7fdabfc9cca2c0e - - - - Fitness - best_fitness - classmo_first_impr_select.html - 287937f5c059b078ccec94e86e0a8238 - - - - - moFitComparator - classmo_fit_comparator.html - EOT - moComparator - - bool - operator() - classmo_fit_comparator.html - c920d5a49deb16710daf1e5fcde6b16c - (const EOT &_solution1, const EOT &_solution2) - - - - moFitSolContinue - classmo_fit_sol_continue.html - EOT - moSolContinue - - EOT::Fitness - Fitness - classmo_fit_sol_continue.html - 369ed94a788d8bdc08d5554f7669376f - - - - - moFitSolContinue - classmo_fit_sol_continue.html - 5f0dc5e529e8cd307ff4a1ae982d5b84 - (Fitness _fitness) - - - bool - operator() - classmo_fit_sol_continue.html - ce4e02895c13bfd131fc759adf83798f - (const EOT &_solution) - - - void - init - classmo_fit_sol_continue.html - 670bd895b4edfcd3aebb40d2295d7f7c - () - - - Fitness - fitness - classmo_fit_sol_continue.html - 87d0ba8f2f76f61c89317eed5f094dfc - - - - - moGenSolContinue - classmo_gen_sol_continue.html - EOT - moSolContinue - - - moGenSolContinue - classmo_gen_sol_continue.html - 8e2456421b641d38e3f800f3bbe45159 - (unsigned int _generationMaximumNumber) - - - bool - operator() - classmo_gen_sol_continue.html - 2fd5f2f10b6d6208412582578fad48ea - (const EOT &_solution) - - - void - init - classmo_gen_sol_continue.html - 6c5db8182157584b56507cc9075602d4 - () - - - unsigned int - generationMaximumNumber - classmo_gen_sol_continue.html - c838d923436b71c584891c1cbe3f47ba - - - - unsigned int - generationNumber - classmo_gen_sol_continue.html - af0b3e5ca3ceee0d843670955c8f1e58 - - - - - moHC - classmo_h_c.html - M - moAlgo< M::EOType > - - - moHC - classmo_h_c.html - 44a35bd30df6e79cff95a31b84889bd7 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moMoveSelect< M > &_move_selection, eoEvalFunc< EOT > &_full_evaluation) - - - - moHC - classmo_h_c.html - 5002f969ef0a4d959610158fc62f137a - (moMoveExpl< M > &_move_explorer, eoEvalFunc< EOT > &_full_evaluation) - - - bool - operator() - classmo_h_c.html - b739f9586b647e32bf31605066f984ad - (EOT &_solution) - - - M::EOType - EOT - classmo_h_c.html - d219296ede03c679646bce2fe8ff96cb - - - - EOT::Fitness - Fitness - classmo_h_c.html - 56487c97a7cf0c423cc879d1bbd45027 - - - - moMoveExpl< M > & - move_explorer - classmo_h_c.html - ec4e702a6ec240f40ff9d262c36d080b - - - - eoEvalFunc< EOT > & - full_evaluation - classmo_h_c.html - 1175c588c19d3658cfc690d5f3f8d825 - - - - - moHCMoveLoopExpl - classmo_h_c_move_loop_expl.html - M - moMoveLoopExpl - - - moHCMoveLoopExpl - classmo_h_c_move_loop_expl.html - fac2eb6695ba1b797ffab4f290d760b8 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moMoveSelect< M > &_move_selection) - - - void - operator() - classmo_h_c_move_loop_expl.html - fe9362c10d74a5e6ed09b56345396192 - (const EOT &_old_solution, EOT &_new_solution) - - - M::EOType - EOT - classmo_h_c_move_loop_expl.html - 077befd4106c201eafd3ea22bcea2fe9 - - - - M::EOType::Fitness - Fitness - classmo_h_c_move_loop_expl.html - f24871224316d5549b9013a2d27ab465 - - - - moMoveInit< M > & - move_initializer - classmo_h_c_move_loop_expl.html - 17506f3f1172714f9adbfa4e8a15953a - - - - moNextMove< M > & - next_move_generator - classmo_h_c_move_loop_expl.html - fdc44d40d8859bae1d7b92e77f36aa30 - - - - moMoveIncrEval< M > & - incremental_evaluation - classmo_h_c_move_loop_expl.html - a044b28f972d007a22736b646d86f265 - - - - moMoveSelect< M > & - move_selection - classmo_h_c_move_loop_expl.html - 5f0532e0ee8ef8ecaeeb4e56342be443 - - - - - moILS - classmo_i_l_s.html - M - moAlgo< M::EOType > - - - moILS - classmo_i_l_s.html - c83f81ba0836ae262305efa15eeb3da2 - (moAlgo< EOT > &_algorithm, moSolContinue< EOT > &_continue, moComparator< EOT > &_acceptance_criterion, eoMonOp< EOT > &_perturbation, eoEvalFunc< EOT > &_full_evaluation) - - - - moILS - classmo_i_l_s.html - 6d684a1d13ad224a911c8b0277812297 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moMoveSelect< M > &_move_selection, moSolContinue< EOT > &_continue, moComparator< EOT > &_acceptance_criterion, eoMonOp< EOT > &_perturbation, eoEvalFunc< EOT > &_full_evaluation) - - - - moILS - classmo_i_l_s.html - 740ac81a0d06eb471592ba0861d3a6d7 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moTabuList< M > &_tabu_list, moAspirCrit< M > &_aspiration_criterion, moSolContinue< EOT > &_moTS_continue, moSolContinue< EOT > &_continue, moComparator< EOT > &_acceptance_criterion, eoMonOp< EOT > &_perturbation, eoEvalFunc< EOT > &_full_evaluation) - - - - moILS - classmo_i_l_s.html - 36bab16abf36957dac36c467b86385bc - (moRandMove< M > &_random_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moSolContinue< EOT > &_moSA_continue, double _initial_temperature, moCoolingSchedule &_cooling_schedule, moSolContinue< EOT > &_continue, moComparator< EOT > &_acceptance_criterion, eoMonOp< EOT > &_perturbation, eoEvalFunc< EOT > &_full_evaluation) - - - bool - operator() - classmo_i_l_s.html - 3f6b950e5a6c363f04b8d4c259502488 - (EOT &_solution) - - - M::EOType - EOT - classmo_i_l_s.html - c81bafc611e4d4fd44347cf7162198c7 - - - - EOT::Fitness - Fitness - classmo_i_l_s.html - 8c464a9eae064a78eff75d4c722b619c - - - - moAlgo< EOT > & - algorithm - classmo_i_l_s.html - 5651a4d94b59d523d341d5d6e24ca311 - - - - moSolContinue< EOT > & - continu - classmo_i_l_s.html - 30edab439401d7ec04fd8d37b4513d94 - - - - moComparator< EOT > & - acceptance_criterion - classmo_i_l_s.html - 295f6d0342c67bd3dc4cb82e2adc26be - - - - eoMonOp< EOT > & - perturbation - classmo_i_l_s.html - f667a1bda06b6d221292df9aba3db8a2 - - - - eoEvalFunc< EOT > & - full_evaluation - classmo_i_l_s.html - 8e8c383ac6ec34aaf071fa18bb54be67 - - - - - moImprBestFitAspirCrit - classmo_impr_best_fit_aspir_crit.html - M - moAspirCrit - - M::EOType::Fitness - Fitness - classmo_impr_best_fit_aspir_crit.html - 0bc1a8c9af99781e662570c04750cca8 - - - - - moImprBestFitAspirCrit - classmo_impr_best_fit_aspir_crit.html - e2c697a5cf3a7696e38bb52b6694a340 - () - - - void - init - classmo_impr_best_fit_aspir_crit.html - ffa451a14ff4ea86fb8bd9fdbc348630 - () - - - bool - operator() - classmo_impr_best_fit_aspir_crit.html - b6e5e96d57a6b846033fc22a9951b067 - (const M &_move, const Fitness &_fitness) - - - Fitness - best_fitness - classmo_impr_best_fit_aspir_crit.html - 03230e8672389de65aacd2bf7b6c1184 - - - - bool - first_time - classmo_impr_best_fit_aspir_crit.html - 2d5226c7dd661b33011402dbbbe78265 - - - - - moItRandNextMove - classmo_it_rand_next_move.html - M - moNextMove - - - moItRandNextMove - classmo_it_rand_next_move.html - c27b1fb0d64d4862dd886f7a59419b8c - (moRandMove< M > &_random_move_generator, unsigned int _iteration_maximum_number) - - - bool - operator() - classmo_it_rand_next_move.html - 21454db723a12fe6c8eb5caeccd32df6 - (M &_move, const EOT &_solution) - - - M::EOType - EOT - classmo_it_rand_next_move.html - ee666007fc494bf4a5f0cd065e5671cf - - - - moRandMove< M > & - random_move_generator - classmo_it_rand_next_move.html - 92601819402ad00d01933113d0bcf40d - - - - unsigned int - iteration_maximum_number - classmo_it_rand_next_move.html - 1b06067aee7a78f8a255563391514d2d - - - - unsigned int - iteration_number - classmo_it_rand_next_move.html - 2f8d52c88d6c002be518091cc52beca1 - - - - - moLinearCoolingSchedule - classmo_linear_cooling_schedule.html - moCoolingSchedule - - - moLinearCoolingSchedule - classmo_linear_cooling_schedule.html - 420939ebf57f01d242cbe4eb668dffde - (double _threshold, double _quantity) - - - bool - operator() - classmo_linear_cooling_schedule.html - b0a1886aaa7ee2a0c8e929e55ca321ce - (double &_current_temperature) - - - double - threshold - classmo_linear_cooling_schedule.html - e7f539f986801ea71392c4a55ba08a76 - - - - double - quantity - classmo_linear_cooling_schedule.html - 6159dc39ceda89b23ffdab3d6ce8d8ed - - - - - moLSCheckPoint - classmo_l_s_check_point.html - M - eoBF - - void - operator() - classmo_l_s_check_point.html - e9b9d41e40dd7bab648327686b2b938d - (const M &_move, const typename M::EOType &_solution) - - - void - add - classmo_l_s_check_point.html - f95f2dc556cdfbdc81688562ca95202d - (eoBF< const M &, const typename M::EOType &, void > &_function) - - - std::vector< eoBF< const M &, const typename M::EOType &, void > * > - functions - classmo_l_s_check_point.html - 56a7427a6aebac7955c22bab302c050a - - - - - moMove - classmo_move.html - EOT - eoUF< EOT &, void > - - EOT - EOType - classmo_move.html - 7fb853a91ba1319530529e515380bbba - - - - - moMoveExpl - classmo_move_expl.html - M - eoBF< const M::EOType &, M::EOType &, void > - - - moMoveIncrEval - classmo_move_incr_eval.html - M - eoBF - - - moMoveInit - classmo_move_init.html - M - eoBF - - - moMoveLoopExpl - classmo_move_loop_expl.html - M - moMoveExpl - - - moMoveSelect - classmo_move_select.html - M - eoBF< M &, M::EOType::Fitness &, void > - - M::EOType::Fitness - Fitness - classmo_move_select.html - 8148ccc0e6fbd209c3fe6829559895c8 - - - - virtual void - init - classmo_move_select.html - 58038bd859632c1bd022d23d9792bdca - (const Fitness &_fitness)=0 - - - virtual bool - update - classmo_move_select.html - 5b4d3b2f030cca80c563c3db0c4af404 - (const M &_move, const Fitness &_fitness)=0 - - - - moNextMove - classmo_next_move.html - M - eoBF - - - moNoAspirCrit - classmo_no_aspir_crit.html - M - moAspirCrit - - bool - operator() - classmo_no_aspir_crit.html - 289aac56f03c4651fcbcec4a91fb6fd6 - (const M &_move, const typename M::EOType::Fitness &_fitness) - - - void - init - classmo_no_aspir_crit.html - f3a286fc4c2d36bd390ba9a3074f3037 - () - - - - moNoFitImprSolContinue - classmo_no_fit_impr_sol_continue.html - EOT - moSolContinue - - EOT::Fitness - Fitness - classmo_no_fit_impr_sol_continue.html - 64c184de66bb37d75d53aa600ac947b3 - - - - - moNoFitImprSolContinue - classmo_no_fit_impr_sol_continue.html - 0793f68a0ad558c8203b97c33c8f9c90 - (unsigned int _maxNumberOfIterationWithoutImprovement) - - - bool - operator() - classmo_no_fit_impr_sol_continue.html - d8966c73cbe625644df9061377f7221a - (const EOT &_solution) - - - void - init - classmo_no_fit_impr_sol_continue.html - 21641c0a38a4501baae6133cbc591de4 - () - - - unsigned int - maxNumberOfIterationsWithoutImprovement - classmo_no_fit_impr_sol_continue.html - 03612ffc3af9d943c1b1d2cde09d461b - - - - bool - firstFitnessSaved - classmo_no_fit_impr_sol_continue.html - ca3591e47a075b59e0826f31234c71ef - - - - Fitness - fitness - classmo_no_fit_impr_sol_continue.html - 3d3d2b43a4dd73e38689cc0018d44ee7 - - - - unsigned int - counter - classmo_no_fit_impr_sol_continue.html - 46fc008a8f7cd06dcaaeb4016b433adb - - - - - moRandImprSelect - classmo_rand_impr_select.html - M - moMoveSelect - - M::EOType::Fitness - Fitness - classmo_rand_impr_select.html - 3bff2fdb963297430543c82ffb567a5c - - - - void - init - classmo_rand_impr_select.html - 7af99966b31aa387ecef74fd307a42e8 - (const Fitness &_fitness) - - - bool - update - classmo_rand_impr_select.html - b20cfd0164266aa75960cba3c1673f69 - (const M &_move, const Fitness &_fitness) - - - void - operator() - classmo_rand_impr_select.html - 1bc88f10830960c1d88e22e444c4e670 - (M &_move, Fitness &_fitness) - - - Fitness - initial_fitness - classmo_rand_impr_select.html - d566fa23689861b1d04257e53c71ae20 - - - - std::vector< Fitness > - better_fitnesses - classmo_rand_impr_select.html - 220d6e3db838b11938e59bc7b29a0db6 - - - - std::vector< M > - better_moves - classmo_rand_impr_select.html - 8a2e7bd7d7a74d7f7402ef25737b09e1 - - - - - moRandMove - classmo_rand_move.html - M - eoUF< M &, void > - - - moSA - classmo_s_a.html - M - moAlgo< M::EOType > - - - moSA - classmo_s_a.html - 12e7da3a56b82daa29a30d1254da5823 - (moRandMove< M > &_random_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moSolContinue< EOT > &_continue, double _initial_temperature, moCoolingSchedule &_cooling_schedule, eoEvalFunc< EOT > &_full_evaluation) - - - bool - operator() - classmo_s_a.html - bea8176b0c05a96696b2ab29d3f3c544 - (EOT &_solution) - - - M::EOType - EOT - classmo_s_a.html - d5d64a8797bdedc7b3af7893aded0bd5 - - - - EOT::Fitness - Fitness - classmo_s_a.html - 97f1a40d5ab5a0b3f878d0347b34804b - - - - moRandMove< M > & - random_move_generator - classmo_s_a.html - 92656523f556669862fcffdccea178dd - - - - moMoveIncrEval< M > & - incremental_evaluation - classmo_s_a.html - fdb49f837dc602624554279418c94bdb - - - - moSolContinue< EOT > & - continu - classmo_s_a.html - 776586a839c2bbd6d12a731c12a1b748 - - - - double - initial_temperature - classmo_s_a.html - e07bf4ca64248e94ab85e8a1ba32aa8c - - - - moCoolingSchedule & - cooling_schedule - classmo_s_a.html - f514ae01cdfc67bf0b87d5389b3792e5 - - - - eoEvalFunc< EOT > & - full_evaluation - classmo_s_a.html - ace30095ffc4924d84e14a0e59f7746f - - - - - moSimpleMoveTabuList - classmo_simple_move_tabu_list.html - M - moTabuList - - M::EOType - EOT - classmo_simple_move_tabu_list.html - 91286ff3ba6b1e9e1db9e4fdade2edb7 - - - - std::list< M >::iterator - moveIterator - classmo_simple_move_tabu_list.html - 4ca9387c0a20bb9f4142682cbfee26bf - - - - - moSimpleMoveTabuList - classmo_simple_move_tabu_list.html - c27e7fabe1370ea65f56981c5cbc1769 - (unsigned int _memory_maximum_size) - - - bool - operator() - classmo_simple_move_tabu_list.html - 8d38f296f3d7721025820f16f25fcf7e - (const M &_move, const EOT &_solution) - - - void - add - classmo_simple_move_tabu_list.html - e6c0835fbfab2bdc63097cf2fd5328aa - (const M &_move, const EOT &_solution) - - - void - update - classmo_simple_move_tabu_list.html - 96cffc8118456ed762b07b9fc0e0679f - () - - - void - init - classmo_simple_move_tabu_list.html - b91ae9971be30769757d1ad92c6009dc - () - - - void - removeMove - classmo_simple_move_tabu_list.html - 922ac2e3c45cbb94698517265be95de5 - (const M &_move) - - - unsigned int - memory_maximum_size - classmo_simple_move_tabu_list.html - fea7fe7c62a6da9b8f087a2732f44251 - - - - unsigned int - memory_size - classmo_simple_move_tabu_list.html - defd20fe6d0d51fdaedbc5b95018aea7 - - - - std::list< M > - tabuList - classmo_simple_move_tabu_list.html - d91bc838361524720616b44eda9b2c3a - - - - - moSimpleSolutionTabuList - classmo_simple_solution_tabu_list.html - M - moTabuList - - M::EOType - EOT - classmo_simple_solution_tabu_list.html - 881060871a6b49e5e8554c5df85176d9 - - - - std::list< EOT >::iterator - solutionIterator - classmo_simple_solution_tabu_list.html - 3438db9ed9e1a94a24c418d8cbadec54 - - - - - moSimpleSolutionTabuList - classmo_simple_solution_tabu_list.html - 8499bf947de47519d155e9e45f815d41 - (unsigned int _memory_maximum_size) - - - bool - operator() - classmo_simple_solution_tabu_list.html - 9052858ae3e6765cbe4c344bdae6c692 - (const M &_move, const EOT &_solution) - - - void - add - classmo_simple_solution_tabu_list.html - 58ae13e7642c429ea51ff679a932aceb - (const M &_move, const EOT &_solution) - - - void - update - classmo_simple_solution_tabu_list.html - 91b8b01dba7ffea8b63765d931e56f56 - () - - - void - init - classmo_simple_solution_tabu_list.html - d5645c39fec71a6110a2cbccbb08b816 - () - - - void - removeSolution - classmo_simple_solution_tabu_list.html - e4a57001a201e1fb7446902381a7ac7d - (const EOT &_solution) - - - unsigned int - memory_maximum_size - classmo_simple_solution_tabu_list.html - 06631e7b9a2511e3c11540aa14b9e636 - - - - unsigned int - memory_size - classmo_simple_solution_tabu_list.html - 0d54e6b0af0e6088aafae596392c9490 - - - - std::list< EOT > - tabuList - classmo_simple_solution_tabu_list.html - 75df9cd683528d3722d02bac407b710b - - - - - moSolContinue - classmo_sol_continue.html - EOT - eoUF< const EOT &, bool > - - virtual void - init - classmo_sol_continue.html - 064dc966a210f4ffb9515be3f03ca4c7 - ()=0 - - - - moSteadyFitSolContinue - classmo_steady_fit_sol_continue.html - EOT - moSolContinue - - EOT::Fitness - Fitness - classmo_steady_fit_sol_continue.html - c289721abbbafe50f6e3b8305dd31007 - - - - - moSteadyFitSolContinue - classmo_steady_fit_sol_continue.html - c5e0e998b73e3a48ca3e87f4f816569b - (unsigned int _maxNumberOfIterations, unsigned int _maxNumberOfIterationWithoutImprovement) - - - bool - operator() - classmo_steady_fit_sol_continue.html - f7432bccb768d50a2fef248c2b174904 - (const EOT &_solution) - - - void - init - classmo_steady_fit_sol_continue.html - 87563493addc8e4b58982c55a67179b9 - () - - - unsigned int - maxNumberOfIterations - classmo_steady_fit_sol_continue.html - 36b43c2a252887ad027165ac32393fe8 - - - - unsigned int - maxNumberOfIterationsWithoutImprovement - classmo_steady_fit_sol_continue.html - cde593c09f497a5fa66ff62732544f40 - - - - bool - maxNumberOfIterationsReached - classmo_steady_fit_sol_continue.html - 7d88c0eb91b2a12121ba1c3ae9139887 - - - - bool - firstFitnessSaved - classmo_steady_fit_sol_continue.html - 025bf2789e470fdde989eee9121035c3 - - - - Fitness - fitness - classmo_steady_fit_sol_continue.html - a5c62e7049b36f6e71e92b559568c09e - - - - unsigned int - counter - classmo_steady_fit_sol_continue.html - 245c9099a2c40dfc4f34b3ff216d13ce - - - - - moTabuList - classmo_tabu_list.html - M - eoBF - - M::EOType - EOT - classmo_tabu_list.html - e219715cc3fdd5626764bc50ce6357df - - - - virtual void - add - classmo_tabu_list.html - 55204939b6d67b6d37b4af725d70cf6d - (const M &_move, const EOT &_solution)=0 - - - virtual void - update - classmo_tabu_list.html - a2e5d1132f064093c8ed57046405f5ca - ()=0 - - - virtual void - init - classmo_tabu_list.html - 0a06c459d56e8e2b408a8f3c6aec4e57 - ()=0 - - - - moTS - classmo_t_s.html - M - moAlgo< M::EOType > - - - moTS - classmo_t_s.html - 336408ddf8b7a29ffa8e01e9c18d8e10 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moTabuList< M > &_tabu_list, moAspirCrit< M > &_aspiration_criterion, moSolContinue< EOT > &_continue, eoEvalFunc< EOT > &_full_evaluation) - - - - moTS - classmo_t_s.html - 7e435fac1b8d5a410b7374d114e005e2 - (moMoveExpl< M > &_move_explorer, moSolContinue< EOT > &_continue, eoEvalFunc< EOT > &_full_evaluation) - - - bool - operator() - classmo_t_s.html - 2a011779723e24a5132a37593775bf56 - (EOT &_solution) - - - M::EOType - EOT - classmo_t_s.html - 90d19d468c12ab5bd796948ce1ce79b1 - - - - EOT::Fitness - Fitness - classmo_t_s.html - aa0eefbb17111422e495d1255f876fca - - - - moMoveExpl< M > & - move_explorer - classmo_t_s.html - 9fd948a2c586f1991f5a1eee927af8a6 - - - - moSolContinue< EOT > & - continu - classmo_t_s.html - 962a37393faf5239e657388d375cd9b3 - - - - eoEvalFunc< EOT > & - full_evaluation - classmo_t_s.html - f44bb408007e2bff99f7a201842e8e48 - - - - - moTSMoveLoopExpl - classmo_t_s_move_loop_expl.html - M - moMoveLoopExpl - - - moTSMoveLoopExpl - classmo_t_s_move_loop_expl.html - be5cf0853777718c3bbcbef456b50bc7 - (moMoveInit< M > &_move_initializer, moNextMove< M > &_next_move_generator, moMoveIncrEval< M > &_incremental_evaluation, moTabuList< M > &_tabu_list, moAspirCrit< M > &_aspiration_criterion) - - - void - operator() - classmo_t_s_move_loop_expl.html - 853743f2e21def3ea129556f47fafa55 - (const EOT &_old_solution, EOT &_new_solution) - - - M::EOType - EOT - classmo_t_s_move_loop_expl.html - 47f42225e2ed096374b818bdb848a527 - - - - M::EOType::Fitness - Fitness - classmo_t_s_move_loop_expl.html - a1ba36c937b195ca2f7d1a24adaa7018 - - - - moMoveInit< M > & - move_initializer - classmo_t_s_move_loop_expl.html - cd680d22382b9941d2c34133a641d443 - - - - moNextMove< M > & - next_move_generator - classmo_t_s_move_loop_expl.html - a2bbb593af2beefb05a307277c22b3d5 - - - - moMoveIncrEval< M > & - incremental_evaluation - classmo_t_s_move_loop_expl.html - 491fa46e1cb7935cb515b27b85bf8765 - - - - moBestImprSelect< M > - move_selection - classmo_t_s_move_loop_expl.html - 1caa6939fbe65ec4255e9e6dc3ce333b - - - - moTabuList< M > & - tabu_list - classmo_t_s_move_loop_expl.html - 0e5988a940ba218e87c53b7e56d79790 - - - - moAspirCrit< M > & - aspiration_criterion - classmo_t_s_move_loop_expl.html - bdfc8efb22599c150b3c3d44cd416b09 - - - - diff --git a/branches/newMo/src/CMakeLists.txt b/branches/newMo/src/CMakeLists.txt index d41d4587a..d4aeba7be 100644 --- a/branches/newMo/src/CMakeLists.txt +++ b/branches/newMo/src/CMakeLists.txt @@ -1,3 +1,4 @@ ############################################################### # This is a dummy file ############################################################### +ADD_SUBDIRECTORY(algo) \ No newline at end of file diff --git a/branches/newMo/src/algo/moLocalSearch.h b/branches/newMo/src/algo/moLocalSearch.h index abee45996..174e1c1e4 100644 --- a/branches/newMo/src/algo/moLocalSearch.h +++ b/branches/newMo/src/algo/moLocalSearch.h @@ -4,9 +4,9 @@ #include #include -/* - the main algorithm of the local search -*/ +/** + * the main algorithm of the local search + */ template< class NHE , class C > class moLocalSearch: public eoMonOp { @@ -15,34 +15,42 @@ public: typedef C Continuator ; typedef typename NeighborhoodExplorer::EOT EOT ; - moLocalSearch(NeighborhoodExplorer & __searchExpl, Continuator & __continuator) : searchExplorer(__searchExpl), continuator(__continuator) { } ; - virtual bool operator() (EOT & solution) { + /** + * Constructor of a moLocalSearch needs a NeighborhooExplorer and a Continuator + */ + moLocalSearch(NeighborhoodExplorer& _searchExpl, Continuator & _continuator) : searchExplorer(_searchExpl), continuator(_continuator) { } ; + + /** + * Run the local search on a solution + * @param _solution the related solution + */ + virtual bool operator() (EOT & _solution) { // initialization of the external continuator (for example the time, or the number of generations) - continuator.init(solution); + continuator.init(_solution); // initialization of the parameter of the search (for example fill empty the tabu list) - searchExplorer.initParam(solution); + searchExplorer.initParam(_solution); unsigned num = 0; do { // explore the neighborhood of the solution - searchExplorer(solution); + searchExplorer(_solution); // if a solution in the neighborhood can be accepted - if (searchExplorer.accept(solution)) - searchExplorer.move(solution); + if (searchExplorer.accept(_solution)) + searchExplorer.move(_solution); // update the parameter of the search (for ex. Temperature of the SA) - searchExplorer.updateParam(solution); + searchExplorer.updateParam(_solution); - std::cout << num << " : " << solution << std::endl ; + std::cout << num << " : " << _solution << std::endl ; num++; - } while (continuator(solution) && searchExplorer.isContinue(solution)); + } while (continuator(_solution) && searchExplorer.isContinue(_solution)); - searchExplorer.terminate(solution); + searchExplorer.terminate(_solution); //A CHANGER return true; @@ -51,10 +59,10 @@ public: private: // make the exploration of the neighborhood according to a local search heuristic - NeighborhoodExplorer & searchExplorer ; + NeighborhoodExplorer& searchExplorer ; // external continuator - Continuator & continuator ; + Continuator& continuator ; }; #endif diff --git a/branches/newMo/src/comparator/moComparator.h b/branches/newMo/src/comparator/moComparator.h index 601778d98..e9caf0b24 100644 --- a/branches/newMo/src/comparator/moComparator.h +++ b/branches/newMo/src/comparator/moComparator.h @@ -15,12 +15,17 @@ // - moNeighborCompartor : : eoComparator // // une instantiation possible !! + + +/** + * Comparator of two solutions + */ template< class EOT > class moComparator : public eoBF { public: - /* + /** * Compare two solutions * @param _sol1 the first solution * @param _sol2 the second solution @@ -30,7 +35,7 @@ public: return (_sol1.fitness() > _sol2.fitness()); } - /* + /** * Return the class id. * @return the class name as a std::string */ diff --git a/branches/newMo/src/comparator/moNeighborComparator.h b/branches/newMo/src/comparator/moNeighborComparator.h index 537af1631..c5c52ef19 100644 --- a/branches/newMo/src/comparator/moNeighborComparator.h +++ b/branches/newMo/src/comparator/moNeighborComparator.h @@ -6,12 +6,16 @@ #include + +/** + * Comparator of two neighbors + */ template< class Neighbor > class moNeighborComparator : public eoBF { public: - /* + /** * Compare two neighbors * @param _neighbor1 the first neighbor * @param _neighbor2 the second neighbor @@ -21,7 +25,7 @@ public: return (neighbor1.fitness() > neighbor2.fitness()); } - /* + /** * Return the class id. * @return the class name as a std::string */ diff --git a/branches/newMo/src/continuator/moContinuator.h b/branches/newMo/src/continuator/moContinuator.h index dca76d1a4..53b105c1f 100644 --- a/branches/newMo/src/continuator/moContinuator.h +++ b/branches/newMo/src/continuator/moContinuator.h @@ -3,7 +3,7 @@ #include -/* +/** * To make specific continuator from a solution */ template< class NH > @@ -13,7 +13,7 @@ public: typedef NH Neighborhood ; typedef typename Neighborhood::EOT EOT ; - /* + /** * Init Continuator parameters * @param _solution the related solution */ diff --git a/branches/newMo/src/continuator/moTrueContinuator.h b/branches/newMo/src/continuator/moTrueContinuator.h index 6c48435a1..2e1792c33 100644 --- a/branches/newMo/src/continuator/moTrueContinuator.h +++ b/branches/newMo/src/continuator/moTrueContinuator.h @@ -3,7 +3,7 @@ #include -/* +/** to make specific continuator from a solution */ template< class NH > @@ -16,7 +16,7 @@ public: // empty constructor moTrueContinuator() { i=0;} ; - /* + /** always true */ virtual bool operator()(EOT & solution) { diff --git a/branches/newMo/src/eval/moEval.h b/branches/newMo/src/eval/moEval.h index e37bd84ef..130821c31 100644 --- a/branches/newMo/src/eval/moEval.h +++ b/branches/newMo/src/eval/moEval.h @@ -3,6 +3,9 @@ #include +/** + * Abstract class for the evaluation + */ template class moEval : public eoBF { diff --git a/branches/newMo/src/eval/moFullEvalBitNeighbor.h b/branches/newMo/src/eval/moFullEvalBitNeighbor.h index 96a260f59..b7cb87749 100644 --- a/branches/newMo/src/eval/moFullEvalBitNeighbor.h +++ b/branches/newMo/src/eval/moFullEvalBitNeighbor.h @@ -4,9 +4,9 @@ #include #include -/* - contener of the neighbor information -*/ +/** + * contener of the neighbor information + */ template< class Fitness > class moFullEvalBitNeighbor : public moBitNeighbor { diff --git a/branches/newMo/src/eval/moFullEvalByCopy.h b/branches/newMo/src/eval/moFullEvalByCopy.h index 018fd9987..12d9a2cf5 100644 --- a/branches/newMo/src/eval/moFullEvalByCopy.h +++ b/branches/newMo/src/eval/moFullEvalByCopy.h @@ -4,6 +4,10 @@ #include #include + +/** + * Evaluation by copy + */ template class moFullEvalByCopy : public moEval { diff --git a/branches/newMo/src/eval/moFullEvalByModif.h b/branches/newMo/src/eval/moFullEvalByModif.h index f3ebb8559..9d7dd48e1 100644 --- a/branches/newMo/src/eval/moFullEvalByModif.h +++ b/branches/newMo/src/eval/moFullEvalByModif.h @@ -4,7 +4,7 @@ #include #include -/* +/** * Full evaluation to use with a moBackableNeighbor */ template diff --git a/branches/newMo/src/explorer/moNeighborhoodExplorer.h b/branches/newMo/src/explorer/moNeighborhoodExplorer.h index d59c242df..1b747e2e6 100644 --- a/branches/newMo/src/explorer/moNeighborhoodExplorer.h +++ b/branches/newMo/src/explorer/moNeighborhoodExplorer.h @@ -6,7 +6,7 @@ #include -/* +/** * Explore the neighborhood */ template< class NH > @@ -17,52 +17,52 @@ public: typedef typename Neighborhood::EOT EOT ; typedef typename Neighborhood::Neighbor Neighbor ; - /* + /** * Constructor with a Neighborhood and evaluation function * @param _neighborhood the neighborhood * @param _eval the evaluation function */ moNeighborhoodExplorer(Neighborhood& _neighborhood, moEval& _eval):neighborhood(_neighborhood), eval(_eval) {} - /* + /** * Init Search parameters * @param _solution the solution to explore */ virtual void initParam (EOT& _solution) = 0 ; - /* + /** * Update Search parameters * @param _solution the solution to explore */ virtual void updateParam (EOT& _solution) = 0 ; - /* + /** * Test if the exploration continue or not * @param _solution the solution to explore * @return true if the exploration continue, else return false */ virtual bool isContinue(EOT& _solution) = 0 ; - /* + /** * Move a solution * @param _solution the solution to explore */ virtual void move(EOT& _solution) = 0 ; - /* + /** * Test if a solution is accepted * @param _solution the solution to explore * @return true if the solution is accepted, else return false */ virtual bool accept(EOT& _solution) = 0 ; - /* + /** * Terminate the search * @param _solution the solution to explore */ virtual void terminate(EOT& _solution) = 0 ; - /* + /** * Return the class id. * @return the class name as a std::string */ diff --git a/branches/newMo/src/neighborhood/moBackableNeighbor.h b/branches/newMo/src/neighborhood/moBackableNeighbor.h index 35a97d646..d9123e2e3 100644 --- a/branches/newMo/src/neighborhood/moBackableNeighbor.h +++ b/branches/newMo/src/neighborhood/moBackableNeighbor.h @@ -1,7 +1,7 @@ #ifndef _BackableNeighbor_h #define _BackableNeighbor_h -/* +/** * Neighbor with a move back function to use in a moFullEvalByModif */ template< class EOT , class Fitness > @@ -9,7 +9,7 @@ class moBackableNeighbor : moNeighbor { public: - /* + /** * the move back function * @param _solution the solution to moveBack */ diff --git a/branches/newMo/src/neighborhood/moNeighbor.h b/branches/newMo/src/neighborhood/moNeighbor.h index 5421ad40a..bc94890cc 100644 --- a/branches/newMo/src/neighborhood/moNeighbor.h +++ b/branches/newMo/src/neighborhood/moNeighbor.h @@ -1,3 +1,39 @@ +/* + + Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008 + (C) OPAC Team, LIFL, 2002-2008 + + Sébastien Cahon, Jean-Charles Boisson (Jean-Charles.Boisson@lifl.fr) + + This software is governed by the CeCILL license under French law and + abiding by the rules of distribution of free software. You can use, + modify and/ or redistribute the software under the terms of the CeCILL + license as circulated by CEA, CNRS and INRIA at the following URL + "http://www.cecill.info". + + As a counterpart to the access to the source code and rights to copy, + modify and redistribute granted by the license, users are provided only + with a limited warranty and the software's author, the holder of the + economic rights, and the successive licensors have only limited liability. + + In this respect, the user's attention is drawn to the risks associated + with loading, using, modifying and/or developing or reproducing the + software by the user in light of its specific status of free software, + that may mean that it is complicated to manipulate, and that also + therefore means that it is reserved for developers and experienced + professionals having in-depth computer knowledge. Users are therefore + encouraged to load and test the software's suitability as regards their + requirements in conditions enabling the security of their systems and/or + data to be ensured and, more generally, to use and operate it in the + same conditions as regards security. + The fact that you are presently reading this means that you have had + knowledge of the CeCILL license and that you accept its terms. + + ParadisEO WebSite : http://paradiseo.gforge.inria.fr + Contact: paradiseo-help@lists.gforge.inria.fr + +*/ + #ifndef _moNeighbor_h #define _moNeighbor_h @@ -8,7 +44,7 @@ #include -/* +/** * Container of the neighbor informations */ template< class EOT , class Fitness > @@ -16,12 +52,12 @@ class moNeighbor : public eoObject, public eoPersistent { public: - /* + /** * Default Constructor */ moNeighbor(){} - /* + /** * Copy Constructor * @param _neighbor to copy */ @@ -29,9 +65,9 @@ public: repFitness = _neighbor.fitness(); } - /* + /** * Assignment operator - * @param the _neighbor to assign + * @param _neighbor the neighbor to assign * @return a neighbor equal to the other */ virtual moNeighbor& operator=(const moNeighbor& _neighbor) { @@ -39,13 +75,13 @@ public: return (*this); } - /* + /** * Move a solution * @param _solution the related solution */ virtual void move(EOT & _solution) = 0 ; - /* + /** * Get the fitness of the neighbor * @return fitness of the neighbor */ @@ -54,7 +90,7 @@ public: } - /* + /** * Get fitness as reference, useful when fitness is set in a multi-stage way, e.g., MOFitness gets performance information, is subsequently ranked * @return fitness as reference of the neighbor */ @@ -62,7 +98,7 @@ public: return repFitness; } - /* + /** * Set fitness. At the same time, validates it. * @param _fitness new fitness value. */ @@ -70,13 +106,13 @@ public: repFitness = _fitness; } - /* + /** * Return the class id. * @return the class name as a std::string */ virtual std::string className() const { return "moNeighbor"; } - /* + /** * Read object. * Calls base class, just in case that one had something to do. * The read and print methods should be compatible and have the same format. @@ -87,7 +123,7 @@ public: _is >> repFitness; } - /* + /** * Write object. Called printOn since it prints the object _on_ a stream. * @param _os A std::ostream. */ diff --git a/branches/newMo/src/neighborhood/moNeighborhood.h b/branches/newMo/src/neighborhood/moNeighborhood.h index bc4050412..1dd6fafc9 100644 --- a/branches/newMo/src/neighborhood/moNeighborhood.h +++ b/branches/newMo/src/neighborhood/moNeighborhood.h @@ -4,52 +4,53 @@ #include -/* +/** * A Neighborhood */ template< class Neighbor > class moNeighborhood : public eoObject { public: - /* + /** * Define type of a solution corresponding to Neighbor */ typedef typename Neighbor::EOType EOT; - /* + /** * Default Constructor */ moNeighborhood(){} - /* + /** * Test if a solution has (again) a Neighbor * @param _solution the related solution * @return if _solution has a Neighbor */ virtual bool hasNeighbor(EOT & _solution) = 0 ; - /* + /** * Initialization of the neighborhood * @param _solution the solution to explore * @param _current the first neighbor */ virtual void init(EOT & _solution, Neighbor & _current) = 0 ; - /* + /** * Give the next neighbor * @param _solution the solution to explore * @param _current the next neighbor */ virtual void next(EOT & _solution, Neighbor & _current) = 0 ; - /* + /** * Test if there is again a neighbor * @param _solution the solution to explore * @return if there is again a neighbor not explored */ virtual bool cont(EOT & _solution) = 0 ; - /* Return the class id. + /** + * Return the class id. * @return the class name as a std::string */ virtual std::string className() const { return "moNeighborhood"; } diff --git a/branches/newMo/src/old/moMove.h b/branches/newMo/src/old/moMove.h index d24832db3..ecf878783 100644 --- a/branches/newMo/src/old/moMove.h +++ b/branches/newMo/src/old/moMove.h @@ -39,18 +39,18 @@ #include -//! Definition of a move. +// Definition of a move. -/*! - A move transforms a solution to another close solution. - It describes how a solution can be modified to another one. -*/ +/* + * A move transforms a solution to another close solution. + * It describes how a solution can be modified to another one. + */ template < class EOT > class moMove:public eoUF < EOT &, void > { public: - //! Alias for the type + // Alias for the type typedef EOT EOType; }; diff --git a/branches/newMo/src/old/moMoveIncrEval.h b/branches/newMo/src/old/moMoveIncrEval.h index af1032dcd..e4a911eb7 100644 --- a/branches/newMo/src/old/moMoveIncrEval.h +++ b/branches/newMo/src/old/moMoveIncrEval.h @@ -38,13 +38,13 @@ #include -//! (generally) Efficient evaluation function based a move and a solution. +// (generally) Efficient evaluation function based a move and a solution. -/*! - From a move and a solution, it computes - a new fitness that could be associated to - the solution if this one is updated. -*/ +/* + * From a move and a solution, it computes + * a new fitness that could be associated to + * the solution if this one is updated. + */ template < class M, class Objective = typename M::EOType::Fitness> class moMoveIncrEval:public eoBF < const M &, const typename M::EOType &, Objective > {}; diff --git a/branches/newMo/src/old/moMoveInit.h b/branches/newMo/src/old/moMoveInit.h index bd521d90a..dae026c72 100644 --- a/branches/newMo/src/old/moMoveInit.h +++ b/branches/newMo/src/old/moMoveInit.h @@ -38,11 +38,11 @@ #include -//! Move (moMove) initializer -/*! - Class which allows to initiase a move. - Only a description... An object that herits from this class needs to be designed to be used. -*/ +// Move (moMove) initializer +/* + * Class which allows to initiase a move. + * Only a description... An object that herits from this class needs to be designed to be used. + */ template < class M > class moMoveInit:public eoBF < M &, const typename M::EOType &, void > {}; diff --git a/branches/newMo/src/old/moNextMove.h b/branches/newMo/src/old/moNextMove.h index 5a067039c..c40268f2f 100644 --- a/branches/newMo/src/old/moNextMove.h +++ b/branches/newMo/src/old/moNextMove.h @@ -38,11 +38,11 @@ #include -//! Class which allows to generate a new move (moMove). -/*! - Useful for the explorer (for moTS or moHC). - Does nothing... An object that herits from this class needs to be designed for being used. -*/ +// Class which allows to generate a new move (moMove). +/* + * Useful for the explorer (for moTS or moHC). + * Does nothing... An object that herits from this class needs to be designed for being used. + */ template < class M > class moNextMove:public eoBF < M &, const typename M::EOType &, bool > {};