From 4fb8f53679fb2724e3191bc58c24582e9205b8ec Mon Sep 17 00:00:00 2001
From: berenger-bramas <berenger-bramas@2616d619-271b-44dc-8df4-d4a8f33a7222>
Date: Wed, 2 Mar 2011 08:44:22 +0000
Subject: [PATCH] ScalFMM Octree & Utils Sources
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/scalfmm/scalfmm/trunk@3 2616d619-271b-44dc-8df4-d4a8f33a7222
---
.gitignore | 19 +
Doc/Doxyfile | 1661 ++++++++++++++++++++++++
Doc/doxygen.png | Bin 0 -> 2033 bytes
Sources/Containers/FList.hpp | 220 ++++
Sources/Containers/FOctree.hpp | 444 +++++++
Sources/Containers/FSubOctree.hpp | 390 ++++++
Sources/Containers/FTreeCoordinate.hpp | 155 +++
Sources/Core/FAbstractParticule.hpp | 34 +
Sources/Core/FBasicParticule.hpp | 64 +
Sources/Files/FAbstractLoader.hpp | 61 +
Sources/Files/FBasicLoader.hpp | 118 ++
Sources/Utils/F3DPosition.hpp | 164 +++
Sources/Utils/FAbstractApplication.hpp | 202 +++
Sources/Utils/FAbstractThreaded.hpp | 74 ++
Sources/Utils/FAssertable.cpp | 16 +
Sources/Utils/FAssertable.hpp | 77 ++
Sources/Utils/FDebug.cpp | 12 +
Sources/Utils/FDebug.hpp | 162 +++
Sources/Utils/FMath.hpp | 47 +
Sources/Utils/FMpiApplication.hpp | 88 ++
Sources/Utils/FNoThreaded.hpp | 88 ++
Sources/Utils/FOpenMPThreaded.hpp | 123 ++
Sources/Utils/FPosixThreaded.hpp | 185 +++
Sources/Utils/FSingleApplication.hpp | 79 ++
TODO | 0
Tests/FDebug.out | 1 +
Tests/testApplication.cpp | 61 +
Tests/testAssert.cpp | 43 +
Tests/testDebug.cpp | 31 +
Tests/testLoader.cpp | 76 ++
Tests/testOctree.cpp | 93 ++
Tests/testOctreeIter.cpp | 135 ++
Tests/testThread.cpp | 74 ++
UTests/FUTester.hpp | 192 +++
UTests/flistUTest.cpp | 104 ++
UTests/testUTest.cpp | 44 +
36 files changed, 5337 insertions(+)
create mode 100644 .gitignore
create mode 100644 Doc/Doxyfile
create mode 100644 Doc/doxygen.png
create mode 100644 Sources/Containers/FList.hpp
create mode 100644 Sources/Containers/FOctree.hpp
create mode 100644 Sources/Containers/FSubOctree.hpp
create mode 100644 Sources/Containers/FTreeCoordinate.hpp
create mode 100644 Sources/Core/FAbstractParticule.hpp
create mode 100644 Sources/Core/FBasicParticule.hpp
create mode 100644 Sources/Files/FAbstractLoader.hpp
create mode 100644 Sources/Files/FBasicLoader.hpp
create mode 100644 Sources/Utils/F3DPosition.hpp
create mode 100644 Sources/Utils/FAbstractApplication.hpp
create mode 100644 Sources/Utils/FAbstractThreaded.hpp
create mode 100644 Sources/Utils/FAssertable.cpp
create mode 100644 Sources/Utils/FAssertable.hpp
create mode 100644 Sources/Utils/FDebug.cpp
create mode 100644 Sources/Utils/FDebug.hpp
create mode 100644 Sources/Utils/FMath.hpp
create mode 100644 Sources/Utils/FMpiApplication.hpp
create mode 100644 Sources/Utils/FNoThreaded.hpp
create mode 100644 Sources/Utils/FOpenMPThreaded.hpp
create mode 100644 Sources/Utils/FPosixThreaded.hpp
create mode 100644 Sources/Utils/FSingleApplication.hpp
delete mode 100644 TODO
create mode 100644 Tests/FDebug.out
create mode 100644 Tests/testApplication.cpp
create mode 100644 Tests/testAssert.cpp
create mode 100644 Tests/testDebug.cpp
create mode 100644 Tests/testLoader.cpp
create mode 100644 Tests/testOctree.cpp
create mode 100644 Tests/testOctreeIter.cpp
create mode 100644 Tests/testThread.cpp
create mode 100644 UTests/FUTester.hpp
create mode 100644 UTests/flistUTest.cpp
create mode 100644 UTests/testUTest.cpp
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000000000..90aa73913
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,19 @@
+#ignore building directory
+build/
+
+#ignore generated doc
+Doc/html/
+
+#ignore qt project file
+*.pro
+*.pro.*
+
+#ignore executables
+*.exe
+
+#ignore temporary files
+tmp/
+*.tmp
+*~
+*TAGS
+*#*#
diff --git a/Doc/Doxyfile b/Doc/Doxyfile
new file mode 100644
index 000000000..2629432ae
--- /dev/null
+++ b/Doc/Doxyfile
@@ -0,0 +1,1661 @@
+# Doxyfile 1.7.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# 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.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = FMB++
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = Beta
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = ../Doc
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# 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, Esperanto, 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, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = YES
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# 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
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+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 regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# 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 = NO
+
+# 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.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+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.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# 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, CSharp, 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. Note that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+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
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# 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
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+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
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+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
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# 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
+
+# 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
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = 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 applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+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
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+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
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = ../Sources
+
+# 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
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# 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 *.f90
+
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.d \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.idl \
+ *.odl \
+ *.cs \
+ *.php \
+ *.php3 \
+ *.inc \
+ *.m \
+ *.mm \
+ *.dox \
+ *.py \
+ *.f90 \
+ *.f \
+ *.vhd \
+ *.vhdl
+
+# 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.
+# If left blank NO is used.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# 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 =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = YES
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# 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
+
+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
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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
+# 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:
+# 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.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = NO
+
+# 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 = NO
+
+# 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 = NO
+
+# 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 = NO
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the stylesheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+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
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# 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 compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+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.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+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 = org.doxygen.Project
+
+# 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
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+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 =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# 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.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# 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 YES, 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 (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# 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
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+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
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# 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 ...
+# Adding location for the tag files is done as follows:
+# 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)
+# 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 =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = NO
+
+# 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.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS = 0
+
+# 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.ttf
+
+# 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
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = NO
+
+# 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.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+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
+# 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
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# 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 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, 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
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
diff --git a/Doc/doxygen.png b/Doc/doxygen.png
new file mode 100644
index 0000000000000000000000000000000000000000..ef08ee6edfd062b499a10ed5038be9cfd9268c35
GIT binary patch
literal 2033
zcmeAS@N?(olHy`uVBq!ia0y~yVEDnnz~IKg%)r2K?fgm`1_lPn64!{5;QX|b^2DN4
z2FH~Aq*MjZ+{E<Mpwz^a%EFVWAVrn|J|V8LaS7M1UthOweOp_{p+kqie*IclRPy@u
z>-3DQS+nOneE6`srf$N-NlTV4+p%NknKNgP969pn;luy`|A&>_kzrt95H1Pw3;vG*
z7&g`3;b353*Y|XB45_&FX4dPX*J=U{JMXjVzW=}BZma{-O+TZzSLU5;l;=~J@MU9o
zK*V2X?%NNfYnt;v@a{Wk{)6p466g4V)D?=EOS42Ty<WAXWu9}a=%1xlVox`&&N`X6
zYzq6IusM|(D?T>#zIn*b-n+=1HSaO2$kFFbww&*duK4juui%(=`iD1Jk!CxK&bO=$
ziV>Aqu&2>V?4U?V=+Op0iIp$xZgR5EJyWn}Wuk!yd+(>~D@wNMcZHwaBYbD4bI4mB
zk3E-8Kd$cQ;#m>%?P8PUo@t9-FaBVsP{GJ7;eCNa=UF}HJg%OA_blwT%$@Q#JJ~-x
zX4B*4xvI0Ns8RhwJ<E3<sdnR!>JNNh@3pk{`S>IHK9^jB+J?hVtt-knP0N||4MHUK
z{<6kJD1|;3l5!K7p~!pdzji_Sfuyi=7i&1gcNG=>2;a*q({sH^+j%3`gLPt=8$74Z
zV%@h`_Wj||vwNmBiAseQh6r}O6Iq~WaxaK;VO*p1(y9G>>u#KKd^K_TwST@3b6CqG
zmmb~JziRP=b*4w&v)Z4zyS!2IY2fw!;x#)qRUF;GedqdpzC088t2x3gonfci53&{u
zT>5ymqBv6`#~@%auiTl!l7}z8vL5D8JLucYY~qvk<^PK}>BY5ddamYK#}DqQ-2cRG
z?&|Icg-wMGmu2Uu^IVZ+3P@;u#e1jtOzh?Z8G7Bp>J`tvsdM^l>6#Y4&-e0vw&mNO
ztDIxgo2z74bn2qk)!9cDYCfL2`GeZ);K+H$KL&r8wde=KeiPZr(uHP<7F@Ph&qoI@
zy6+YD=aJQanbZ4Oue)vGN%OD?YHKpQ{j$b$PJ-j31xqGeN?3Pa_1yjqh4wyHrg<Np
zzI%3A_vp^z+063{dfR4Co@1eT-X~AqS=r8{Hv93Jn@5jT8}+@+Dp9#~^VrI`8HYXZ
z-~RFP#vVDTb#5`zOV=zs8zZ$u+&|&huLrzEwU+YUuYO((e;}s2J<Bd9=5rSFvl%Hn
zWXe~>Wcx8cG;i>~e4|00cXv!RUoF?UQtqdb<&`%t7VbUBC=~P5eA2F>lXB%QhwUD1
z%DbxnS(7#Otd+g^xtiRWv!(8=D&O!y<7D1-oq1YM(tXb_myS|TD85?qIwCLYvu45K
z({q0(e7CuK?wsIOk;^gZuW!8be>MA@=m!1glihyYn(`|6f!FStw+m*=T{bKA+VtC)
zTS(b$_nYJZeh2@i9dBQMvQ-z@@ZiUv$9(tRNb*>gOlQ#D@+NKF;f95MuOygEX1~1b
z;w`s;?G<<OrNzC{LaXQRQ1p0ayltxbq&L%KX3IbAFv&ErI=N17(tVl8C@0CYwkP=4
zJUH9Tz5F=u3zx2L!AXjHiyB{5oOz}-Z|i~Hoc`M{KC`-te0cR}YPh=9y(_zq8(QZ^
ziV2>dx9*^nQJcy7^Nq2cj~=Z`dHsj$oN=Ru&C7$bGIuv89B0yV^*;2VlJl|27o|lh
zjax5oz2hdd<Mgi7yxK{1Y<iye+09qiSXD&L{rcpk%FXQPN2*?~Tlg={{iNVl-JP-`
z_ew4Mbd4=6X623U>9am)=)RsPqnfuU(c<`VPMOd8g-z~~^BRjycW-8m(XBj^b@H&Q
zg(<u4-L!{BmbIsypZ)CGd8krw)|BsokEG&mZsv?hGn-_f@9c8?z{djLstr0XjD@a$
zonrB33-=9|ikYhyAJBZWB6#;<)^+KE=jY|Q<W<|R3aFiyU_QC;bWQcMDv>AiZtd8R
z$F@GLp;<S{i$kb+=@ixySr5@?E7W%sttebjaaYpj#*SR3@8ag`{tNqFU;U>)as4B)
zH|KR!*WEmyTW1sASaa{c;JK!MT5}3FeF$lu-8c7%u&@5=&SQ+-ob#%uElp@CdFZ;&
zYvP-joj)2a&dq$Z!2Fu;bHU|b?!M|i^XR48qAgjOJIf6F?B}ju7Q%K}<}YJG$3wjr
z7VnSmtUD98r=>{CAtQd(v8AVLi)GBNIX*t<_T>v>*R$y_(-!At9{YXpYNDf4-QP5m
zTi^EExoRhzvA0;W<Zg*Iqxf~dxqPSnx3|cjS#!X+<aXJ|Iew=_Te4-EkH2`!G;h;u
zpTiHOmPgymxO7Z7`sBv06K`wXf3*oqxZQW|eeEyGm%P(t`A_X>$Kz}~#6;&F;pj1Y
zP;g>(TOH%xUF93!9<P?E|FIw;d!B5xy<Nt>S^LFhRPD}9`tVx)RPdp1xfYzs=bSsl
zwk9ntI3{8#lip|9sQH(r?ZDoOp2x2{Pp*9PaV=9lZ=HqNA;l-lw0EpIy4BdMjZ5+D
zq@ArA`xwQ~+wn$!_iHRK*w?gJ?(%Z`OC`z<OBy?0Sj)et^VwmxMAVb3X9M#c5BJwo
ze3|QQa^`&A(i(H+d(-w63*9yx_}|!IquJxXcmq#`?}?T}i|<Ikl4|$pzSj`G{uZl@
z_#_jq|8E)F&oI7x@BJXI!|6YpVAlWo4xMG^yWcbYH$KgVT&tmQZlAJe;$h&)lD2U^
TcOs2}fq}u()z4*}Q$iB}{i5-E
literal 0
HcmV?d00001
diff --git a/Sources/Containers/FList.hpp b/Sources/Containers/FList.hpp
new file mode 100644
index 000000000..71952fa35
--- /dev/null
+++ b/Sources/Containers/FList.hpp
@@ -0,0 +1,220 @@
+#ifndef FLIST_HPP
+#define FLIST_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+
+
+/**
+ * @author Berenger Bramas (berenger.bramas@inria.fr)
+ * @class FList
+ * Please read the license
+ *
+ * This class is a linked list container.
+ *
+ * Please refere to unit test flistUTest.cpp
+ */
+template< class Object >
+class FList {
+ /** A list node */
+ struct Node {
+ Object target; //< Object of the node
+ Node* next; //< Next node
+ };
+
+ Node* root; //< Root node, NULL if size is 0
+
+ int size; //< Elements in the list
+
+ /**
+ * Copy a list into current object
+ * The current list has to be empty when this function is called
+ */
+ void copy(const FList& other){
+ const Node* otherRoot = other.root;
+ Node ** myRoot = &this->root;
+ while(otherRoot){
+ (*myRoot) = new Node;
+ (*myRoot)->target = otherRoot->target;
+
+ myRoot = &(*myRoot)->next;
+ otherRoot = otherRoot->next;
+ }
+ *myRoot = 0;
+ this->size = other.size;
+ }
+
+public:
+ /** Constructor (of an empty list) */
+ FList() : root(0) , size(0) {
+ }
+
+ /** Desctructor */
+ virtual ~FList(){
+ clear();
+ }
+
+ /**
+ * Copy operator
+ * This will clear the current list before copying
+ * @param other the source list
+ * @return the current list as a reference
+ */
+ FList& operator=(const FList& other){
+ clear();
+ copy(other);
+ return *this;
+ }
+
+ /**
+ * Copy constructor
+ * @param other the source list
+ */
+ FList(const FList& other): root(0) , size(0) {
+ copy(other);
+ }
+
+ /**
+ * To clear the list
+ * Size is 0 after calling this function
+ */
+ void clear(){
+ while(this->root){
+ Node* next(this->root->next);
+ delete this->root;
+ this->root = next;
+ }
+ this->size = 0;
+ }
+
+ /**
+ * Push an element in the front of the list
+ */
+ void pushFront(Object& inObject){
+ Node* newNode = new Node;
+ newNode->target = inObject;
+ newNode->next = this->root;
+
+ this->root = newNode;
+ ++size;
+ }
+
+ /**
+ * Push an element in the front of the list
+ * used when type is pointer and like [TYPE* const] object
+ */
+ void pushFront(Object const inObject){
+ Node* newNode = new Node;
+ newNode->target = inObject;
+ newNode->next = this->root;
+
+ this->root = newNode;
+ ++size;
+ }
+
+ /**
+ * To get front value (last pushed value)
+ * if size == 0 then defaultValue is returned
+ * @param defaultValue as the returned value in case size == 0, equal Object() if no param as passed
+ * @return first value if exists or defaultValue otherwise
+ */
+ Object& front(Object& defaultValue = Object()){
+ if(size) return this->root->target;
+ else return defaultValue;
+ }
+
+ /**
+ * To get front value as const
+ * if size == 0 then defaultValue is return
+ * @param defaultValue as the returned value in case size == 0, equal Object() if no param as passed
+ * @return first value if exists or defaultValue otherwise
+ */
+ const Object& front(const Object& defaultValue = Object()) const {
+ if(size) return this->root->target;
+ else return defaultValue;
+ }
+
+ /**
+ * To get the front value and remove it from the list
+ * @return first value
+ * @warning you must check the list's size before calling this function!
+ */
+ Object popFront(){
+ --size;
+ Node* newNode = this->root;
+ this->root = this->root->next;
+
+ Object value = newNode->target;
+ delete newNode;
+
+ return value;
+ }
+
+ /**
+ * To get the number of elements in the list
+ * @return size
+ */
+ int getSize() const{
+ return size;
+ }
+
+ /**
+ * This iterator allow accessing list's elements
+ * If you change the target list pointed by an iterator
+ * you cannot used the iterator any more.
+ * <code>
+ * FList<int> values; <br>
+ * // inserting ... <br>
+ * FList<int>::BasicIterator iter(values); <br>
+ * while( iter.isValide() ){ <br>
+ * iter.value() += 1; <br>
+ * iter.progress(); <br>
+ * } <br>
+ * </code>
+ */
+ class BasicIterator {
+ private:
+ Node* iter; //< current node on the list
+
+ public:
+ /**
+ * Constructor needs the target list
+ * @param the list to iterate on
+ */
+ BasicIterator(FList& list) : iter(list.root){
+ }
+
+ /** to progress on the list */
+ void progress(){
+ if(iter) iter = iter->next;
+ }
+
+ /**
+ * Current pointed value
+ * current iterator must be valide (isValide()) to use this function
+ */
+ Object& value(){
+ return iter->target;
+ }
+
+ /**
+ * Current pointed value
+ * current iterator must be valide (isValide()) to use this function
+ */
+ const Object& value() const{
+ return iter->target;
+ }
+
+ /**
+ * To know if an iterator is at the end of the list
+ * @return true if the current iterator can progress and access to value, else false
+ */
+ bool isValide() const{
+ return iter;
+ }
+
+ };
+
+};
+
+#endif //FLIST_HPP
+// [--LICENSE--]
diff --git a/Sources/Containers/FOctree.hpp b/Sources/Containers/FOctree.hpp
new file mode 100644
index 000000000..78644c143
--- /dev/null
+++ b/Sources/Containers/FOctree.hpp
@@ -0,0 +1,444 @@
+#ifndef FOCTREE_HPP
+#define FOCTREE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include "FSubOctree.hpp"
+
+#include "../Utils/F3DPosition.hpp"
+#include "../Utils/FMath.hpp"
+#include "FTreeCoordinate.hpp"
+
+#include "../Utils/FAssertable.hpp"
+
+/**
+ * @author Berenger Bramas (berenger.bramas@inria.fr)
+ * @class FOctree
+ * Please read the license
+ *
+ * This class is an octree container.
+ *
+ * Please refere to testOctree.cpp to see an example.
+ * <code>
+ * // can be used as : <br>
+ * FOctree<TestParticule, TestCell, 10, 3> tree(1.0,F3DPosition(0.5,0.5,0.5));
+ * </code>
+ */
+template< class ParticuleClass, class CellClass, int OctreeHeight, int SubtreeHeight = 3>
+class FOctree {
+ const int height; //< tree height
+ const int leafIndex; //< index of leaf int array
+
+ const double boxWidth; //< the space system width
+ const F3DPosition boxCenter; //< the space system center
+ const F3DPosition boxCorner; //< the space system corner (used to compute morton index)
+
+ double boxWidthAtLevel[OctreeHeight]; //< to store the width of each boxs at all levels
+
+ FSubOctree< ParticuleClass, CellClass > root;//< root suboctree
+
+ /** Forbiden copy operator */
+ FOctree& operator=(const FOctree&) {
+ return *this;
+ }
+
+ /** Forbiden copy constructor */
+ FOctree(const FOctree&) {
+ }
+
+ /**
+ * Get morton index from a position for the leaf leavel
+ * @param inPosition position to compute
+ * @return the morton index
+ */
+ MortonIndex getLeafMortonFromPosition(const F3DPosition& inPosition){
+ // box coordinate to host the particule
+ FTreeCoordinate host;
+ // position has to be relative to corner not center
+ host.setX( getTreeCoordinate( inPosition.getX() - this->boxCorner.getX() ));
+ host.setY( getTreeCoordinate( inPosition.getY() - this->boxCorner.getY() ));
+ host.setZ( getTreeCoordinate( inPosition.getZ() - this->boxCorner.getZ() ));
+ return host.getMortonIndex(leafIndex);
+ }
+
+ /**
+ * Get the box number from a position
+ * at a position POS with a leaf level box width of WI, the position is RELATIVE_TO_CORNER(POS)/WI
+ * @param inRelativePosition a position from the corner of the box
+ * @return the box num at the leaf level that contains inRelativePosition
+ */
+ long getTreeCoordinate(const double inRelativePosition){
+ const double indexDouble = inRelativePosition / this->boxWidthAtLevel[this->leafIndex];
+ long index = FMath::dfloor(indexDouble);
+ if( index && FMath::LookEqual(inRelativePosition, this->boxWidthAtLevel[this->leafIndex] * index ) ){
+ --index;
+ }
+ return index;
+ }
+
+public:
+ /**
+ * Constructor
+ * @param inBoxWidth box width for this simulation
+ * @param inBoxCenter box center for this simulation
+ */
+ FOctree(const double inBoxWidth, const F3DPosition& inBoxCenter)
+ : boxWidth(inBoxWidth) , boxCenter(inBoxCenter), boxCorner(inBoxCenter - (inBoxWidth/2)),
+ height(OctreeHeight) , leafIndex(OctreeHeight-1),
+ root(0, 0, SubtreeHeight, 1){
+ double tempWidth = this->boxWidth;
+ // pre compute box width for each level
+ for(int indexLevel = 0; indexLevel < this->height; ++indexLevel ){
+ this->boxWidthAtLevel[indexLevel] = tempWidth;
+ tempWidth /= 2.0;
+ }
+ }
+
+ /** Desctructor */
+ virtual ~FOctree() {
+ }
+
+ /**
+ * Insert a particule on the tree
+ * algorithm is :
+ * Compute morton index for the particule
+ * ask node to insert this particule
+ * @param inParticule the particule to insert (must inherite from FAbstractParticule)
+ */
+ void insert(ParticuleClass* const inParticule){
+ const MortonIndex particuleIndex = getLeafMortonFromPosition(inParticule->getPosition());
+ root.insert( particuleIndex, inParticule, height);
+ }
+
+
+ /**
+ * This has to be used to iterate on an octree
+ * It simply stores an pointer on a suboctree and moves to right/left/up/down.
+ * Please refere to testOctreeIter file to see how it works.
+ *
+ * <code>
+ * FOctree<TestParticule, TestCell, NbLevels, NbSubLevels>::Iterator octreeIterator(&tree); <br>
+ * octreeIterator.gotoBottomLeft(); <br>
+ * for(int idx = 0 ; idx < NbLevels - 1; ++idx ){ <br>
+ * do{ <br>
+ * // ... <br>
+ * } while(octreeIterator.moveRight()); <br>
+ * octreeIterator.moveUp(); <br>
+ * octreeIterator.gotoLeft(); <br>
+ * } <br>
+ * <code>
+ * Remark :
+ * It uses the left right limit on each suboctree and their morton index.
+ * Please have a look to the move functions to understand how the system is working.
+ */
+ class Iterator : public FAssertable {
+ /**
+ * The class works on suboctree. Most of the resources needed
+ * are avaiblable by using FAbstractSubOctree. But when accessing
+ * to the leaf we have to use FSubOctree or FSubOctreeWithLeafs
+ * depending if we are working on the bottom of the tree.
+ */
+ union SubOctreeTypes {
+ FAbstractSubOctree<ParticuleClass,CellClass>* tree; //< Usual pointer to work
+ FSubOctree<ParticuleClass,CellClass>* middleTree; //< To access to sub-octree under
+ FSubOctreeWithLeafs<ParticuleClass,CellClass>* leafTree;//< To access to particules lists
+ };
+
+
+ SubOctreeTypes current; //< Current suboctree
+
+ int currentLocalLevel; //< Current level in the current suboctree
+ long currentLocalIndex; //< Current index (array position) in the current_suboctree.cells[ currentLocalLevel ]
+
+ /**
+ * To know what is the left limit on the current level on the current subtree
+ * @retrun suboctree.left_limit >> 3 * diff(leaf_index, current_index).
+ */
+ static long TransposeIndex(const long indexInLeafLevel, const int distanceFromLeafLevel) {
+ return indexInLeafLevel >> (3 * distanceFromLeafLevel);
+ }
+
+
+ public:
+ /**
+ * Constructor
+ * @param inTarget the octree to iterate on
+ * After building a iterator, this one is positioned at the level 0
+ * of the root (level 1 of octree) at the left limit index
+ */
+ Iterator(FOctree* const inTarget)
+ : currentLocalLevel(0), currentLocalIndex(0) {
+ assert(inTarget, "Target for Octree::Iterator cannot be null", __LINE__, __FILE__);
+ assert(inTarget->root.getRightLeafIndex(), "Octree seems to be empty, getRightLeafIndex == 0", __LINE__, __FILE__);
+
+ // Start by the root
+ this->current.tree = &inTarget->root;
+ // On the left limit
+ this->currentLocalIndex = TransposeIndex(this->current.tree->getLeftLeafIndex(), (this->current.tree->getSubOctreeHeight() - this->currentLocalLevel - 1) );
+ }
+
+
+ /**
+ * Move iterator to the top! (level 0 of root, level 1 of octree)
+ * index = left limit at root level
+ */
+ void gotoTop(){
+ while(this->current.tree->hasParent()){
+ this->current.tree = this->current.tree->getParent();
+ }
+ this->currentLocalLevel = 0;
+ this->currentLocalIndex = TransposeIndex(this->current.tree->getLeftLeafIndex(), (this->current.tree->getSubOctreeHeight() - 1) );
+ }
+
+ /**
+ * Move iterator to the bottom left place
+ * We are on a leaf
+ */
+ void gotoBottomLeft(){
+ gotoTop();
+ while(1) {
+ this->currentLocalLevel = this->current.tree->getSubOctreeHeight() - 1;
+ this->currentLocalIndex = this->current.tree->getLeftLeafIndex();
+ if(isAtLeafLevel()){
+ return;
+ }
+ this->current.tree = this->current.middleTree->leafs(this->currentLocalIndex);
+ }
+ }
+
+ /**
+ * Move iterator to the left place at the same level
+ */
+ void gotoLeft(){
+ // Function variables
+ const int currentLevel = level();
+
+ // Goto root sutoctree
+ while(this->current.tree->hasParent()){
+ this->current.tree = this->current.tree->getParent();
+ }
+
+ // Go down on the left until arriving on the same global level
+ while(this->current.tree->getSubOctreeHeight() + this->current.tree->getSubOctreePosition() - 1 < currentLevel) {
+ this->current.tree = this->current.middleTree->leafs(this->current.tree->getLeftLeafIndex());
+ }
+
+ // Level still unchanged we only go to the left
+ // The left limit on this tree at the level we want to stay
+ this->currentLocalIndex = TransposeIndex(this->current.tree->getLeftLeafIndex(), (this->current.tree->getSubOctreeHeight() - this->currentLocalLevel - 1));
+ }
+
+ /**
+ * Move iterator to the left place at the same level
+ */
+ void gotoRight(){
+ // Function variables
+ const int currentLevel = level();
+ // Goto root sutoctree
+ while(this->current.tree->hasParent()){
+ this->current.tree = this->current.tree->getParent();
+ }
+ // Go down on the left until arriving on the same global level
+ while(this->current.tree->getSubOctreeHeight() + this->current.tree->getSubOctreePosition() - 1 < currentLevel) {
+ this->current.tree = this->current.middleTree->leafs(this->current.tree->getRightLeafIndex());
+ }
+ // Level still unchanged we only go to the left
+ // The left limit on this tree at the level we want to stay
+ this->currentLocalIndex = TransposeIndex(this->current.tree->getRightLeafIndex(), (this->current.tree->getSubOctreeHeight() - this->currentLocalLevel - 1));
+ }
+
+ /**
+ * Goto the next value on the right at the same level
+ *
+ * The algorithm here is :
+ * As long as we are on the right limit, go to the parent suboctree
+ * if we are on the root and on the right then return (there is no more data on the right)
+ *
+ * After that point we do not know where we are but we know that there is some data
+ * on the right (without knowing our position!)
+ *
+ * We progress on the brother to find an allocated cell (->)
+ * for example if we are on index 2 we will look until 8 = 2 | 7 + 1
+ * if we arrive a 8 without finding a cell we go upper and do the same
+ * we know we will find something because we are not at the right limit
+ *
+ * We find an allocated cell.
+ * We have to go down, we go on the left child of this cells
+ * until : the current level if we did not have change the current suboctree
+ * or : the leaf level
+ *
+ * In the second case, it meanse we need to change octree downward
+ * but it is easy because we can use the left limit!
+ */
+ bool moveRight(){
+ // Function variables
+ SubOctreeTypes workingTree = this->current; // To cover parent other sub octre
+ long workingLevel = this->currentLocalLevel; // To know where we are
+ long workingIndex = this->currentLocalIndex; // To know where we are
+
+ // -- First we have to go in a tree where we can move on the right --
+ // Number of time we go into parent subtree
+ int countUpward = 0;
+ // We stop when we can right move or if there is no more parent (root)
+ while( workingIndex == TransposeIndex(workingTree.tree->getRightLeafIndex(), (workingTree.tree->getSubOctreeHeight() - workingLevel - 1) )
+ && workingTree.tree->hasParent() ){
+ // Goto the leaf level into parent at current_tree.position_into_parent_array
+ workingIndex = workingTree.tree->getIndexInParent();
+ workingTree.tree = workingTree.tree->getParent();
+ workingLevel = workingTree.tree->getSubOctreeHeight() - 1;
+ // inc counter
+ ++countUpward;
+ }
+
+ // Do we stop because we are on the root (means we cannot move right?)
+ if( workingIndex < TransposeIndex(workingTree.tree->getRightLeafIndex(), (workingTree.tree->getSubOctreeHeight() - workingLevel - 1) ) ){
+ // Move to the first right cell pointer(!)
+ ++workingIndex;
+
+ // Maybe it is null, but we know there is almost one cell on the right
+ // we need to find it
+ if( !workingTree.tree->cellsAt(workingLevel)[workingIndex] ){
+ // While we are not on a allocated cell
+ while( true ){
+ // Test element on the right (test brothers)
+ const long rightLimite = (workingIndex | 7) + 1;
+ while( workingIndex < rightLimite && !workingTree.tree->cellsAt(workingLevel)[workingIndex]){
+ ++workingIndex;
+ }
+ // Stop if we are on an allocated cell
+ if( workingTree.tree->cellsAt(workingLevel)[workingIndex] ){
+ break;
+ }
+ // Else go to the upper level
+ --workingLevel;
+ workingIndex >>= 3;
+ }
+ }
+
+ // if wokring tree != current tree => working tree leafs level ; else current level
+ const int objectiveLevel = (countUpward ? workingTree.tree->getSubOctreeHeight() - 1 : this->currentLocalLevel );
+
+ // We need to go down as left as possible
+ while( workingLevel != objectiveLevel ){
+ ++workingLevel;
+ workingIndex <<= 3;
+ const long rightLimite = (workingIndex | 7); // not + 1 because if the 7th first are null it must be the 8th!
+ while( workingIndex < rightLimite && !workingTree.tree->cellsAt(workingLevel)[workingIndex]){
+ ++workingIndex;
+ }
+ }
+
+ // Do we change from the current sub octree?
+ if( countUpward ){
+ // Then we simply need to go down the same number of time
+ workingTree.tree = workingTree.middleTree->leafs(workingIndex);
+ while( --countUpward ){
+ workingTree.tree = workingTree.middleTree->leafs(workingTree.tree->getLeftLeafIndex());
+ }
+ // level did not change, simpli set octree and get left limit of this octree at the current level
+ this->current = workingTree;
+ this->currentLocalIndex = TransposeIndex(workingTree.tree->getLeftLeafIndex(), (workingTree.tree->getSubOctreeHeight() - this->currentLocalLevel - 1) );
+ }
+ else{
+ // We are on the right tree
+ this->currentLocalIndex = workingIndex;
+ }
+
+ return true;
+ }
+ return false;
+ }
+ /**
+ * Move to the upper level
+ * It may cause to change the suboctree we are working on
+ */
+ bool moveUp() {
+ // It is on the top level?
+ if(this->currentLocalLevel){
+ // No so simply go up
+ --this->currentLocalLevel;
+ this->currentLocalIndex >>= 3;
+ }
+ // Yes need to change suboctree
+ else if(this->current.tree->hasParent()){
+ this->currentLocalIndex = this->current.tree->getIndexInParent();
+ this->current.tree = this->current.tree->getParent();
+ this->currentLocalLevel = this->current.tree->getSubOctreeHeight() - 1;
+ }
+ else{
+ return false;
+ }
+ return true;
+ }
+ /**
+ * Move down
+ * It may cause to change the suboctree we are working on
+ * We point on the first child found from left to right in the above
+ * level
+ */
+ bool moveDown(){
+ if( !isAtLeafLevel() ){
+ // We are on the leaf of the current suboctree?
+ if(this->currentLocalLevel + 1 == this->current.tree->getSubOctreeHeight()){
+ // Yes change sub octree
+ this->current.tree = this->current.middleTree->leafs[this->currentLocalLevel][this->currentLocalIndex];
+ this->currentLocalIndex = 0;
+ this->currentLocalLevel = 0;
+ }
+ // No simply go down
+ else{
+ ++this->currentLocalLevel;
+ this->currentLocalIndex <<= 3;
+ }
+ // Find the first allocated cell from left to right
+ while(this->current.tree->cellsAt(this->currentLocalLevel)[this->currentLocalIndex]){
+ ++this->currentLocalIndex;
+ }
+ return true;
+ }
+ return false;
+ }
+
+
+ /**
+ * To know if we are not on the root level
+ * @return true if we can move up
+ */
+ bool canProgressToUp() const {
+ return this->currentLocalLevel || this->current.tree->hasParent();
+ }
+
+ /**
+ * To know if we are not on the leafs level
+ * @return true if we can move down
+ */
+ bool canProgressToDown() const {
+ return !isAtLeafLevel();
+ }
+
+ /**
+ * To know if we are on the leafs level
+ * @return true if we are at the bottom of the tree
+ */
+ bool isAtLeafLevel() const {
+ return level() + 1 == OctreeHeight;
+ }
+
+ /**
+ * To know the current level (not local but global)
+ * @return the level in the entire octree
+ */
+ int level() const {
+ return this->currentLocalLevel + this->current.tree->getSubOctreePosition();
+ }
+
+ FList<ParticuleClass*>* getCurrentList() const {
+ return this->current.leafTree->getLeaf(this->currentLocalIndex);
+ }
+ };
+
+ // To be able to access octree root
+ friend class Iterator;
+};
+
+#endif //FOCTREE_HPP
+// [--LICENSE--]
diff --git a/Sources/Containers/FSubOctree.hpp b/Sources/Containers/FSubOctree.hpp
new file mode 100644
index 000000000..ab72e71b6
--- /dev/null
+++ b/Sources/Containers/FSubOctree.hpp
@@ -0,0 +1,390 @@
+#ifndef FSUBOCTREE_HPP
+#define FSUBOCTREE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include "../Utils/F3DPosition.hpp"
+#include "../Utils/FAssertable.hpp"
+#include "../Utils/FMath.hpp"
+
+#include "FTreeCoordinate.hpp"
+#include "FList.hpp"
+
+
+/**
+ * @author Berenger Bramas (berenger.bramas@inria.fr)
+ * @class FAbstractSubOctree
+ * Please read the license
+ *
+ * This class is a sub-octree container.
+ * This class is the main component of the octree.
+ *
+ * This class does not have a main root. In fact, the root
+ * is contained in the parent sub-octree.
+ *
+ * If the sub-octree is a middle suboctree, the leaf level is pointers
+ * on other suboctrees.
+ *
+ * If the sub-octree is a bottom subtree then the leaf level is pointers on
+ * lists<particule>
+ *
+ * This two situations are implemented in tow different classes that inherite of FAbstractSubOctree.
+ *
+ * Please refere to testOctree.cpp to see an example
+ * @warning Give the particuleClass & cellClass
+ */
+template< class ParticuleClass, class CellClass >
+class FAbstractSubOctree : public FAssertable{
+protected:
+ const int subOctreeHeight; //< Height of this suboctree
+ const int subOctreePosition; //< Level of the current suboctree in the global tree (0 if node)
+
+ long leftLeafIndex; //< The leaf at the left position (this is the array index to start when iterate)
+ long rightLeafIndex; //< The leaf at the right position (this is the last array index when iterate)
+
+ CellClass*** cells; //< Potential cells, cells are allocated only if needed
+
+ FAbstractSubOctree* const parent; //< Parent suboctree (null for root)
+
+ const long indexInParent; //< This is the index of the current octree in the parent's array
+
+ /**
+ * This function compute the morton index for the last level of this suboctree.
+ * suppose we have an index like : 000.010.111.001.101.110
+ * and now considere that suboctree height is 2, the morton index have to be cut as :
+ * [000.010].[111.001].[101.110] each part correspond to a morton index a leaf level for the
+ * different suboctree.
+ * This is why depending on the level of the octree we need to remove extra part on the left and
+ * on the right.
+ */
+ MortonIndex getLeafIndex(const MortonIndex index, const int inTreeHeight) const {
+ // Remove right useless part - used by child
+ const MortonIndex fullIndex = index >> (3 * (inTreeHeight - (this->subOctreeHeight + this->subOctreePosition) ) );
+ // Remove left extra data part - used by parent
+ const MortonIndex treeLeafMask = ( (~0x00LL ^ (~0x00LL << (3 * this->subOctreeHeight ))));
+ return treeLeafMask & fullIndex;
+ }
+
+ /**
+ * This function creats all the intermediates cells between
+ * a leaf and the root.
+ * It is used after inserting a new leaf to have cells from leaf to root
+ * when computing
+ * @param arrayIndex the index at the leaf index of the new element
+ */
+ void createPreviousCells(MortonIndex arrayIndex){
+ int indexLevel = this->subOctreeHeight - 1;
+ while(indexLevel >= 0 && !this->cells[indexLevel][arrayIndex]){
+ this->cells[indexLevel][arrayIndex] = new CellClass();
+ --indexLevel;
+ arrayIndex >>= 3;
+ }
+ }
+
+ /**
+ * This function is initializing variables when a new leaf is inserted in the tree
+ * for example it updates the leaf array marges and calls createPreviousCells()
+ * @param arrayIndex the position of the new leaf in the leafs array
+ */
+ void newLeafInserted(const long arrayIndex){
+ createPreviousCells(arrayIndex);
+ // Update if this is the bottom left
+ if(arrayIndex < this->leftLeafIndex) this->leftLeafIndex = arrayIndex;
+ if(arrayIndex > this->rightLeafIndex) this->rightLeafIndex = arrayIndex;
+ }
+
+public:
+ /**
+ * Constructor
+ * Allocate the cells arrays to be able to create every potential cells
+ * @param inParent the SubOctree parent (0 if node)
+ * @param inSubOctreeHeight Height of this suboctree
+ * @param inSubOctreePosition Level of the current suboctree in the global tree (1 if upper tree)
+ */
+ FAbstractSubOctree(FAbstractSubOctree* const inParent, const long inIndexInParent,
+ const int inSubOctreeHeight, const int inSubOctreePosition) :
+ parent( inParent ), indexInParent(inIndexInParent), subOctreePosition( inSubOctreePosition ),
+ subOctreeHeight( inSubOctreeHeight ), leftLeafIndex(1 << (3 * inSubOctreeHeight)), rightLeafIndex(0) {
+
+ this->cells = new CellClass**[this->subOctreeHeight];
+ assert(this->cells, "Allocation failled", __LINE__, __FILE__);
+
+ // We start at a sub-level - 8^1
+ long cellsAtlevel = 8;
+ for( int indexLevel = 0 ; indexLevel < this->subOctreeHeight ; ++indexLevel ){
+ this->cells[indexLevel] = new CellClass*[cellsAtlevel];
+ assert(this->cells[indexLevel], "Allocation failled", __LINE__, __FILE__);
+
+ for( int indexCells = 0 ; indexCells < cellsAtlevel ; ++indexCells ){
+ this->cells[indexLevel][indexCells] = 0;
+ }
+
+ cellsAtlevel <<= 3; // => * 8 >> 8^indexLevel
+ }
+ }
+
+ /**
+ * Destructor
+ * Delete cells arrays and allocated cells
+ */
+ virtual ~FAbstractSubOctree(){
+ long cellsAtlevel = 8;
+ for( int indexLevel = 0 ; indexLevel < this->subOctreeHeight ; ++indexLevel ){
+ for( int indexCells = 0 ; indexCells < cellsAtlevel ; ++indexCells ){
+ if(this->cells[indexLevel][indexCells]){
+ delete this->cells[indexLevel][indexCells];
+ }
+ }
+
+ delete [] this->cells[indexLevel];
+ cellsAtlevel <<= 3; // => * 8 >> 8^indexLevel
+ }
+
+ delete [] this->cells;
+ }
+
+
+ /**
+ * Insert a particule on the subtree
+ * @param index the morton index of the particule to insert
+ * @param inParticule the particule to insert (must inherite from FAbstractParticule)
+ * @param inParticule the inTreeHeight the height of the tree
+ */
+ virtual void insert(const MortonIndex index, ParticuleClass* const inParticule, const int inTreeHeight) = 0;
+
+ ///////////////////////////////////////
+ // This is the FOctree::Iterator Part
+ ///////////////////////////////////////
+
+ /** Suboctree height accessor (leaf level + 1)
+ * @return subOctreeHeight */
+ int getSubOctreeHeight() const{
+ return subOctreeHeight;
+ }
+
+ /** Suboctree position in the real tree
+ * @return subOctreePosition */
+ int getSubOctreePosition() const {
+ return subOctreePosition;
+ }
+
+ /** Return the more left leaf index
+ * the smallest index on the leafs array
+ * @return leftLeafIndex */
+ long getLeftLeafIndex() const {
+ return leftLeafIndex;
+ }
+
+ /** Return the more right leaf index
+ * the biggest index on the leafs array
+ * @return rightLeafIndex */
+ long getRightLeafIndex() const {
+ return rightLeafIndex;
+ }
+
+ /** Return the array of cells at a specious index
+ * @param level the level to access cells array (must be < subOctreeHeight)
+ * @return cells[level] */
+ CellClass** cellsAt(const int level){
+ assert(level < subOctreeHeight, "Level out of memory", __LINE__, __FILE__);
+ return cells[level];
+ }
+
+ /** To know if it is the root suboctree
+ * @return true if has parent otherwise return false */
+ bool hasParent() const {
+ return parent;
+ }
+
+ /** To get access to the parent suboctree
+ * @return parent */
+ FAbstractSubOctree* getParent(){
+ return parent;
+ }
+
+ /** To get the index of the current suboctree in the parent leafs array
+ * This index can is part of the morton index of the cells contains
+ * in this suboctree
+ * @return indexInParent */
+ long getIndexInParent() const{
+ return indexInParent;
+ }
+};
+
+
+
+/////////////////////////////////////////////////////////////////////////////////////
+// Last level sub octree
+/////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * @author Berenger Bramas (berenger.bramas@inria.fr)
+ * @class FSubOctreeWithLeafs
+ * Please read the license
+ *
+ * This class is an sub-octree container.
+ * But this is the specialized bottom part, in fact the last level is composed by
+ * a cells array (managing by abstract class) and lists of particules.
+ *
+ * Please refere to testOctree.cpp to see an example.
+ * @warning Give the particuleClass & cellClass
+ */
+template< class ParticuleClass, class CellClass >
+class FSubOctreeWithLeafs : public FAbstractSubOctree<ParticuleClass,CellClass> {
+private:
+
+ FList<ParticuleClass*>** leafs; //< Leafs array
+public:
+ /**
+ * Constructor
+ * Allocate the leafs array
+ * @param inParent the SubOctree parent (0 if node)
+ * @param inSubOctreeHeight Height of this suboctree
+ * @param inSubOctreePosition Level of the current suboctree in the global tree (1 if upper tree)
+ */
+ FSubOctreeWithLeafs(FAbstractSubOctree<ParticuleClass,CellClass>* const inParent, const long inIndexInParent,
+ const int inSubOctreeHeight, const int inSubOctreePosition) :
+ FAbstractSubOctree<ParticuleClass,CellClass>(inParent, inIndexInParent, inSubOctreeHeight, inSubOctreePosition) {
+
+ const long cellsAtLeafLevel = 1 << (3 * inSubOctreeHeight);
+
+ this->leafs = new FList<ParticuleClass*>*[cellsAtLeafLevel];
+ assert(this->leafs, "Allocation failled", __LINE__, __FILE__);
+
+ for( long indexLeaf = 0 ; indexLeaf < cellsAtLeafLevel ; ++indexLeaf ){
+ this->leafs[indexLeaf] = 0;
+ }
+ }
+
+ /**
+ * Destructor dealloc all leafs & the leaf array
+ */
+ virtual ~FSubOctreeWithLeafs(){
+ const int cellsAtLeafLevel = 1 << (3 * this->subOctreeHeight );
+ for( int indexLeaf = 0 ; indexLeaf < cellsAtLeafLevel ; ++indexLeaf ){
+ if(this->leafs[indexLeaf]){
+ delete this->leafs[indexLeaf];
+ }
+ }
+ delete [] this->leafs;
+ }
+
+ /**
+ * Refer to FAbstractSubOctree::insert
+ */
+ void insert(const MortonIndex index, ParticuleClass* const inParticule, const int inTreeHeight){
+ // Get the morton index for the leaf level
+ const MortonIndex arrayIndex = FAbstractSubOctree<ParticuleClass,CellClass>::getLeafIndex(index,inTreeHeight);
+ // is there already a leaf?
+ if( !this->leafs[arrayIndex] ){
+ this->leafs[arrayIndex] = new FList<ParticuleClass*>();
+ FAbstractSubOctree<ParticuleClass,CellClass>::newLeafInserted( arrayIndex );
+ }
+ // add particule to leaf list
+ this->leafs[arrayIndex]->pushFront(inParticule);
+ }
+
+ /** To get access leafs elements
+ * @param index the position of the leaf
+ * @return the list of particules at this index */
+ FList<ParticuleClass*>* getLeaf(const int index){
+ return this->leafs[index];
+ }
+
+};
+
+
+
+/////////////////////////////////////////////////////////////////////////////////////
+// Middle level sub octree
+/////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * @author Berenger Bramas (berenger.bramas@inria.fr)
+ * @class FSubOctree
+ * Please read the license
+ *
+ * This class is an sub-octree container.
+ * This is the middle level specialized suboctree, it means that it does not contain
+ * leaf but pointers to other suboctree.
+ * These suboctrees at the last level can be FSubOctree of FSubOctreeWithLeafs depending
+ * if they are at the bottom of the tree or not
+ *
+ * @warning Give the particuleClass & cellClass
+ */
+template< class ParticuleClass, class CellClass >
+class FSubOctree : public FAbstractSubOctree<ParticuleClass,CellClass> {
+private:
+ FAbstractSubOctree<ParticuleClass,CellClass>** subleafs; //< Last levels is composed of suboctree
+
+public:
+ /**
+ * Constructor
+ * Allocate the subleafs array
+ * @param inParent the SubOctree parent (0 if node)
+ * @param inSubOctreeHeight Height of this suboctree
+ * @param inSubOctreePosition Level of the current suboctree in the global tree (0 if upper tree)
+ */
+ FSubOctree(FAbstractSubOctree<ParticuleClass,CellClass>* const inParent, const long inIndexInParent,
+ const int inSubOctreeHeight, const int inSubOctreePosition) :
+ FAbstractSubOctree<ParticuleClass,CellClass>(inParent, inIndexInParent, inSubOctreeHeight, inSubOctreePosition) {
+
+ const long cellsAtLeafLevel = 1 << (3 * inSubOctreeHeight);
+ this->subleafs = new FAbstractSubOctree<ParticuleClass,CellClass>*[cellsAtLeafLevel];
+ assert(this->subleafs, "Allocation failled", __LINE__, __FILE__);
+
+ for( int indexLeaf = 0 ; indexLeaf < cellsAtLeafLevel ; ++indexLeaf ){
+ this->subleafs[indexLeaf] = 0;
+ }
+ }
+
+ /**
+ * Destructor dealloc all suboctrees leafs & leafs array
+ */
+ virtual ~FSubOctree(){
+ const long cellsAtLeafLevel = 1 << (3 * this->subOctreeHeight);
+ for( int indexLeaf = 0 ; indexLeaf < cellsAtLeafLevel ; ++indexLeaf ){
+ if(this->subleafs[indexLeaf]) delete this->subleafs[indexLeaf];
+ }
+ delete [] this->subleafs;
+ }
+
+ /**
+ * Refer to FAbstractSubOctree::insert
+ */
+ void insert(const MortonIndex index, ParticuleClass* const inParticule, const int inTreeHeight){
+ // We need the morton index at the bottom level of this sub octree
+ // so we remove the right side
+ const MortonIndex arrayIndex = FAbstractSubOctree<ParticuleClass,CellClass>::getLeafIndex(index,inTreeHeight);
+ // Is there already a leaf?
+ if( !this->subleafs[arrayIndex] ){
+ // We need to create leaf sub octree
+ const int nextSubOctreePosition = this->subOctreePosition + this->subOctreeHeight;
+ const int nextSubOctreeHeight = FMath::Min(inTreeHeight - nextSubOctreePosition, this->subOctreeHeight);
+
+ // Next suboctree is a middle suboctree
+ if(inTreeHeight > nextSubOctreeHeight + nextSubOctreePosition){
+ this->subleafs[arrayIndex] = new FSubOctree(this,arrayIndex,nextSubOctreeHeight,nextSubOctreePosition);
+ }
+ // Or next suboctree contains the reail leaf!
+ else{
+ this->subleafs[arrayIndex] = new FSubOctreeWithLeafs<ParticuleClass,CellClass>(this,arrayIndex,nextSubOctreeHeight,nextSubOctreePosition);
+ }
+
+ // We need to inform parent class
+ FAbstractSubOctree<ParticuleClass,CellClass>::newLeafInserted( arrayIndex );
+ }
+ // Ask next suboctree to insert the particule
+ this->subleafs[arrayIndex]->insert( index, inParticule, inTreeHeight);
+ }
+
+ /** To get access to leafs elements (child suboctree)
+ * @param index the position of the leaf/child suboctree
+ * @return child at this index */
+ FAbstractSubOctree<ParticuleClass,CellClass>* leafs(const int index){
+ return this->subleafs[index];
+ }
+};
+
+
+#endif //FSUBOCTREE_HPP
+// [--LICENSE--]
diff --git a/Sources/Containers/FTreeCoordinate.hpp b/Sources/Containers/FTreeCoordinate.hpp
new file mode 100644
index 000000000..005603fe3
--- /dev/null
+++ b/Sources/Containers/FTreeCoordinate.hpp
@@ -0,0 +1,155 @@
+#ifndef FTREECOORDINATE_HPP
+#define FTREECOORDINATE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <cstring>
+
+/** Morton index */
+typedef long long MortonIndex;
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FTreeCoordinate
+* Please read the license
+*
+* This class represents tree coordinate. It is used to save
+* the position in "box unit" (not system unit!).
+*/
+class FTreeCoordinate{
+private:
+ long x; //< x box-th position
+ long y; //< y box-th position
+ long z; //< z box-th position
+
+public:
+ /** Default constructor */
+ FTreeCoordinate() : x(0), y(0), z(0){
+ }
+
+ /**
+ * Default constructor
+ * @param inX the x
+ * @param inY the y
+ * @param inZ the z
+ */
+ FTreeCoordinate(const long inX,const long inY,const long inZ)
+ : x(inX), y(inY), z(inZ){
+ }
+
+ /** Default destructor */
+ virtual ~FTreeCoordinate(){
+ }
+
+ /**
+ * Copy constructor
+ * @param other the source class to copy
+ */
+ FTreeCoordinate(const FTreeCoordinate& other):x(other.x), y(other.y), z(other.z){
+ }
+
+ /**
+ * Copy constructor
+ * @param other the source class to copy
+ * @return this a reference to the current object
+ */
+ FTreeCoordinate& operator=(const FTreeCoordinate& other){
+ memcpy(this, &other, sizeof(other));
+ return *this;
+ }
+
+ /**
+ * Position setter
+ * @param inX the new x
+ * @param inY the new y
+ * @param inZ the new z
+ */
+ void setPosition(const long inX,const long inY,const long inZ){
+ this->x = inX;
+ this->y = inY;
+ this->z = inZ;
+ }
+
+ /**
+ * X Getter
+ * @return this->x
+ */
+ long getX() const{
+ return this->x;
+ }
+
+ /**
+ * Y Getter
+ * @return this->y
+ */
+ long getY() const{
+ return this->y;
+ }
+
+ /**
+ * Z Getter
+ * @return this->z
+ */
+ long getZ() const{
+ return this->z;
+ }
+
+ /**
+ * X Setter, simply change x position
+ * @param the new x
+ */
+ void setX(const long inX){
+ this->x = inX;
+ }
+
+ /**
+ * Y Setter, simply change y position
+ * @param the new y
+ */
+ void setY(const long inY){
+ this->y = inY;
+ }
+
+ /**
+ * Z Setter, simply change z position
+ * @param the new z
+ */
+ void setZ(const long inZ){
+ this->z = inZ;
+ }
+
+ /**
+ * To get the morton index of the current position
+ * @complexity inLevel
+ * @param inLevel the level of the component
+ * @return morton index
+ */
+ MortonIndex getMortonIndex(const int inLevel) const{
+ MortonIndex index = 0x0LL;
+ MortonIndex mask = 0x1LL;
+
+ MortonIndex mx = this->x << 2;
+ MortonIndex my = this->y << 1;
+ MortonIndex mz = this->z;
+
+ for(int indexLevel = 0; indexLevel < inLevel ; ++indexLevel){
+ index |= (mz & mask);
+ mask <<= 1;
+ index |= (my & mask);
+ mask <<= 1;
+ index |= (mx & mask);
+ mask <<= 1;
+
+ mz <<= 2;
+ my <<= 2;
+ mx <<= 2;
+ }
+
+ return index;
+ }
+
+};
+
+
+#endif //FTREECOORDINATE_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Core/FAbstractParticule.hpp b/Sources/Core/FAbstractParticule.hpp
new file mode 100644
index 000000000..5b0034253
--- /dev/null
+++ b/Sources/Core/FAbstractParticule.hpp
@@ -0,0 +1,34 @@
+#ifndef FABSTRACTPARTICULE_HPP
+#define FABSTRACTPARTICULE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+/* forward declaration to avoid include */
+class F3DPosition;
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FAbstractBody
+* @brief
+* Please read the license
+*
+* This class define the method that every particule class
+* has to implement.
+* @warning Inherite from this class when implement a specific particule type
+*/
+class FAbstractParticule{
+public:
+ /** Default destructor */
+ virtual ~FAbstractParticule(){
+ }
+
+ /**
+ * Must be implemented by each user Particule class
+ * @return the position of the current cell
+ */
+ virtual F3DPosition getPosition() const = 0;
+};
+
+
+#endif //FABSTRACTPARTICULE_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Core/FBasicParticule.hpp b/Sources/Core/FBasicParticule.hpp
new file mode 100644
index 000000000..c63069397
--- /dev/null
+++ b/Sources/Core/FBasicParticule.hpp
@@ -0,0 +1,64 @@
+#ifndef FBASICPARTICULE_HPP
+#define FBASICPARTICULE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include "FAbstractParticule.hpp"
+#include "../Utils/F3DPosition.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FBasicParticule
+* Please read the license
+*
+* This class defines a basic particule used for examples.
+*/
+class FBasicParticule : public FAbstractParticule{
+protected:
+ F3DPosition pos; //< Particule's position
+
+public:
+ /**
+ * Constructor with a position
+ * @param inX x position
+ * @param inY y position
+ * @param inZ z position
+ */
+ FBasicParticule(const double inX, const double inY, const double inZ) : pos(inX,inY,inZ) {
+ }
+
+ /**
+ * Constructor with a position object
+ * @param inPos particule position
+ */
+ FBasicParticule(const F3DPosition& inPos) : pos(inPos) {
+ }
+
+ /** Default constructor */
+ FBasicParticule(){
+ }
+
+ /** Default destructor */
+ virtual ~FBasicParticule(){
+ }
+
+ /**
+ * From the FAbstractParticule definition
+ * @return the position of the current cell
+ */
+ F3DPosition getPosition() const {
+ return pos;
+ }
+
+ /**
+ * This function is needed by the basic loader to fill the current particule
+ * @param inPos the position given by the basic loader
+ */
+ void setPosition(const F3DPosition& inPos) {
+ pos = inPos;
+ }
+};
+
+
+#endif //FBASICPARTICULE_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Files/FAbstractLoader.hpp b/Sources/Files/FAbstractLoader.hpp
new file mode 100644
index 000000000..c7ec6f649
--- /dev/null
+++ b/Sources/Files/FAbstractLoader.hpp
@@ -0,0 +1,61 @@
+#ifndef FABSTRACTLOADER_HPP
+#define FABSTRACTLOADER_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+class F3DPosition;
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FAbstractLoader
+* Please read the license
+*
+* This class defined the FMB usual loader. A loader is the component
+* that fills an octree.
+*
+* If you want to use a specific file format you then need to inherite from this loader
+* and implemente several methods.
+*
+* @warning Inherite from this class when defining a loader class
+*/
+template <class ParticuleClass>
+class FAbstractLoader {
+public:
+ /** Default destructor */
+ virtual ~FAbstractLoader(){
+ }
+
+ /**
+ * Get the number of particules for this simulation
+ * @return number of particules that the loader can fill
+ */
+ virtual long getNumberOfParticules() const = 0;
+
+ /**
+ * Get the center of the simulation box
+ * @return box center needed by the octree
+ */
+ virtual F3DPosition getCenterOfBox() const = 0;
+
+ /**
+ * Get the simulation box width
+ * @return box width needed by the octree
+ */
+ virtual double getBoxWidth() const = 0;
+
+ /**
+ * To know if the loader is valide (file opened, etc.)
+ * @return true if file is open
+ */
+ virtual bool isValide() const = 0;
+
+ /**
+ * Fill the next particule
+ * @param inParticule the particule to fill
+ */
+ virtual void fillParticule(ParticuleClass* const inParticule) = 0;
+};
+
+
+#endif //FABSTRACTLOADER_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Files/FBasicLoader.hpp b/Sources/Files/FBasicLoader.hpp
new file mode 100644
index 000000000..26b407b8f
--- /dev/null
+++ b/Sources/Files/FBasicLoader.hpp
@@ -0,0 +1,118 @@
+#ifndef FBASICLOADER_HPP
+#define FBASICLOADER_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+#include <fstream>
+
+#include "FAbstractLoader.hpp"
+#include "../Utils/F3DPosition.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FBasicLoader
+* Please read the license
+*
+* Load a file with a format like :
+* NB_particules Box_width Box_X Box_Y Box_Z // init
+* X Y Z // one particule by line
+* ....
+* <code>
+* FBasicLoader<FBasicParticule> loader("../FMB++/Tests/particules.basic.txt"); <br>
+* if(!loader.isValide()){ <br>
+* std::cout << "Loader Error\n"; <br>
+* return 1; <br>
+* } <br>
+* <br>
+* FOctree<FBasicParticule, TestCell, 10, 3> tree(loader.getBoxWidth(),loader.getCenterOfBox()); <br>
+* <br>
+* for(int idx = 0 ; idx < loader.getNumberOfParticules() ; ++idx){ <br>
+* FBasicParticule* const part = new FBasicParticule(); <br>
+* loader.fillParticule(part); <br>
+* tree.insert(part); <br>
+* } <br>
+* </code>
+*/
+template <class ParticuleClass>
+class FBasicLoader : public FAbstractLoader<ParticuleClass> {
+protected:
+ std::ifstream file; //< The file to read
+ F3DPosition centerOfBox; //< The center of box read from file
+ double boxWidth; //< the box width read from file
+ int nbParticules; //< the number of particules read from file
+
+public:
+ /**
+ * The constructor need the file name
+ * @param filename the name of the file to open
+ * you can test if file is successfuly open by calling isValide()
+ */
+ FBasicLoader(const char* const filename): file(filename,std::ifstream::in){
+ // test if open
+ if(this->file.is_open()){
+ double x,y,z;
+ this->file >> this->nbParticules >> this->boxWidth >> x >> y >> z;
+ this->centerOfBox.setPosition(x,y,z);
+ }
+ else {
+ this->boxWidth = 0;
+ this->nbParticules = 0;
+ }
+ }
+
+ /**
+ * Default destructor, simply close the file
+ */
+ virtual ~FBasicLoader(){
+ file.close();
+ }
+
+ /**
+ * To know if file is open and ready to read
+ * @return true if loader can work
+ */
+ bool isValide() const{
+ return this->file.is_open() && !this->file.eof();
+ }
+
+ /**
+ * To get the number of particules from this loader
+ * @param the number of particules the loader can fill
+ */
+ long getNumberOfParticules() const{
+ return this->nbParticules;
+ }
+
+ /**
+ * The center of the box from the simulation file opened by the loader
+ * @return box center
+ */
+ F3DPosition getCenterOfBox() const{
+ return this->centerOfBox;
+ }
+
+ /**
+ * The box width from the simulation file opened by the loader
+ * @return box width
+ */
+ double getBoxWidth() const{
+ return this->boxWidth;
+ }
+
+ /**
+ * Fill a particule
+ * @warning to work with the loader, particules has to expose a setPosition method
+ * @param the particule to fill
+ */
+ void fillParticule(ParticuleClass* const inParticule){
+ double x,y,z;
+ this->file >> x >> y >> z;
+ inParticule->setPosition(F3DPosition(x,y,z));
+ }
+
+};
+
+
+#endif //FBASICLOADER_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/F3DPosition.hpp b/Sources/Utils/F3DPosition.hpp
new file mode 100644
index 000000000..2757600f3
--- /dev/null
+++ b/Sources/Utils/F3DPosition.hpp
@@ -0,0 +1,164 @@
+#ifndef F3DPOSITION_HPP
+#define F3DPOSITION_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+// To get memcpy
+#include <cstring>
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class F3DPosition
+* Please read the license
+*
+*/
+class F3DPosition{
+private:
+ double x; //< x position
+ double y; //< y position
+ double z; //< z position
+
+public:
+ /** Default constructor */
+ F3DPosition() : x(0.0), y(0.0), z(0.0){
+ }
+
+ /** Default constructor */
+ F3DPosition(const double inX,const double inY,const double inZ)
+ : x(inX), y(inY), z(inZ){
+ }
+
+ /** Default destructor */
+ virtual ~F3DPosition(){
+ }
+
+ /**
+ * Copy constructor
+ * @param other the source class to copy
+ */
+ F3DPosition(const F3DPosition& other):x(other.x), y(other.y), z(other.z){
+ }
+
+ /**
+ * Copy constructor
+ * @param other the source class to copy
+ * @return this a reference to the current class
+ */
+ F3DPosition& operator=(const F3DPosition& other){
+ memcpy(this, &other, sizeof(F3DPosition));
+ return *this;
+ }
+
+ /**
+ * Position setter
+ * @param other the source class to copy
+ * @return this a reference to the current class
+ */
+ void setPosition(const double inX,const double inY,const double inZ){
+ this->x = inX;
+ this->y = inY;
+ this->z = inZ;
+ }
+
+ /**
+ * Get x
+ * @return this->x
+ */
+ double getX() const{
+ return this->x;
+ }
+
+ /**
+ * Get y
+ * @return this->y
+ */
+ double getY() const{
+ return this->y;
+ }
+
+ /**
+ * Get z
+ * @return this->z
+ */
+ double getZ() const{
+ return this->z;
+ }
+
+ /**
+ * Set x
+ * @param the new x
+ */
+ void setX(const double inX){
+ this->x = inX;
+ }
+
+ /**
+ * Set y
+ * @param the new y
+ */
+ void setY(const double inY){
+ this->y = inY;
+ }
+
+ /**
+ * Set z
+ * @param the new z
+ */
+ void setZ(const double inZ){
+ this->z = inZ;
+ }
+
+ /**
+ * Subtract to all dim the inValue
+ * @param inValue the value to substract
+ * @return the current object after being subtracted
+ */
+ F3DPosition& operator-=(const double inValue){
+ this->x -= inValue;
+ this->y -= inValue;
+ this->z -= inValue;
+ return *this;
+ }
+
+ /**
+ * Affect to all dim the inValue
+ * @param inValue the value to afect
+ * @return the current object after being affected
+ */
+ F3DPosition& operator+=(const double inValue){
+ this->x += inValue;
+ this->y += inValue;
+ this->z += inValue;
+ return *this;
+ }
+
+};
+
+/**
+* Operator F3Position minus double
+* This substract inValue to all dimensions of the inPosition
+* @param inPosition the position to compute
+* @param inValue the value to decrease/substract position
+* @return the resulting position
+*/
+F3DPosition operator-(const F3DPosition& inPosition, const double inValue){
+ F3DPosition position(inPosition);
+ position -= inValue;
+ return position;
+}
+
+/**
+* Operator F3Position plus double
+* This affect from inValue all dimensions of the inPosition
+* @param inPosition the position to compute
+* @param inValue the value to increase/affect position
+* @return the resulting position
+*/
+F3DPosition operator+(const F3DPosition& inPosition, const double inValue){
+ F3DPosition position(inPosition);
+ position += inValue;
+ return position;
+}
+
+#endif //F3DPOSITION_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FAbstractApplication.hpp b/Sources/Utils/FAbstractApplication.hpp
new file mode 100644
index 000000000..fa774f0aa
--- /dev/null
+++ b/Sources/Utils/FAbstractApplication.hpp
@@ -0,0 +1,202 @@
+#ifndef FABSTRACTAPPLICATION_HPP
+#define FABSTRACTAPPLICATION_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <sstream>
+#include <iostream>
+#include <string.h>
+
+#include "FAssertable.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FAbstractApplication
+* Please read the license
+*
+* This class is an interface for main application.
+* It represents the core of the system
+* Only one app can be instancied by program.
+*
+* @warning you have to implement run() and call execute to start the app
+*
+* Please refere to testApplication.cpp to see an example.
+* <code>
+* </code>
+*/
+class FAbstractApplication {
+private:
+ const int argc; //< argc from command line
+
+ char ** const argv; //< argv from command line
+
+protected:
+ /**
+ * This will be called as the main method
+ * @warning Must be impleted in the derived class
+ */
+ virtual void run() = 0;
+
+ /**
+ * This function is called before the run if the process is the master one
+ */
+ virtual void initMaster(){}
+
+ /**
+ * This function is called before the run if the process is a slave
+ */
+ virtual void initSlave(){}
+
+private:
+
+ /** Forbiden (private) default constructor */
+ FAbstractApplication():argc(0), argv(0){}
+
+ /** Forbiden (private) copy constructor */
+ FAbstractApplication(const FAbstractApplication&):argc(0), argv(0){}
+
+ /** Forbiden (private) copy */
+ FAbstractApplication& operator=(const FAbstractApplication&){}
+
+public:
+ /**
+ * Constructor
+ * @param inArgc argc from command line
+ * @param inArgv argv from command line
+ * This will also set the current app in the assert system
+ */
+ FAbstractApplication(const int inArgc, char ** const inArgv )
+ : argc(inArgc), argv(inArgv) {
+ FAssertable::SetCurrentApp(this);
+ }
+
+ /** Destructor */
+ virtual ~FAbstractApplication(){}
+
+ /**
+ * This function has to be called to execute the process run
+ * @return 0 if success
+ */
+ int execute(){
+ if( isMaster() ) initMaster();
+ else initSlave();
+ run();
+ return 0;
+ }
+
+ /**
+ * To get the current process id
+ * @return the process numeber [0 ; processCount [
+ */
+ virtual int processId() const = 0;
+
+ /**
+ * To get the number of process
+ * @return process count
+ */
+ virtual int processCount() const = 0;
+
+ /**
+ * To make a barrier between process
+ */
+ virtual void processBarrier() const = 0;
+
+ /**
+ * To kill all process
+ * @param inErrorCode the error to return to OS (default is 1)
+ */
+ virtual void abort(const int inErrorCode = 1) const = 0;
+
+ /**
+ * This function has to be used to know if the current app is the master
+ * @return true if id() == 0
+ */
+ bool isMaster() const {
+ return !processId();
+ }
+
+ /**
+ * This function has to be used to know if the current app is alone
+ * @return true if processCount() == 1
+ */
+ bool isAlone() const {
+ return processCount() == 1;
+ }
+
+ /**
+ * This function has to be used to know if the current app is a slave
+ * @return true if id() != 0
+ */
+ bool isSlave() const {
+ return processId();
+ }
+
+ /**
+ * This function gives the number of parameters (argc)
+ * @return argc
+ */
+ int userParemetersCount() const{
+ return this->argc;
+ }
+
+ /**
+ * This function gives a parameter
+ * @parameter inArg parameter position has to be strictly less than argc/userParemetersCount
+ * @return argv[inArg]
+ */
+ const char* userParemeterAt(const int inArg) const{
+ return this->argv[inArg];
+ }
+
+ /**
+ * This function gives a parameter in a standart type
+ * @parameter inArg parameter position has to be strictly less than argc/userParemetersCount
+ * @return argv[inArg] in the template VariableType form
+ * @warning VariableType need to work with istream >> operator
+ * <code> const int argInt = userParemetersAt<int>(1,-1); </code>
+ */
+ template <class VariableType>
+ const VariableType userParemeterAt(const int inArg, const VariableType& defaultValue = VariableType()) const{
+ std::istringstream iss(this->argv[inArg],std::istringstream::in);
+ VariableType value;
+ iss >> value;
+ if( /*iss.tellg()*/ iss.eof() ) return value;
+ return defaultValue;
+ }
+
+ /**
+ * This function gives the parameter in a standart type after a key parameter
+ * Do not use pointer in template type!
+ * @parameter inArg parameter key
+ * @return argv[inArg.position + 1] in the template VariableType form
+ * @warning VariableType need to work with istream >> operator
+ * <code> const int argInt = userParemetersAt<int>(1,-1); </code>
+ */
+ template <class VariableType>
+ const VariableType userParemeterFromKey(const char* const inKey, const VariableType& defaultValue = VariableType(), bool* const inState = 0) const{
+ const int keysArgc= this->argc - 1;
+ // loop from 1 to argc 1
+ for(int indexArg = 1 ; indexArg < keysArgc ; ++indexArg){
+ // if argv == inArg
+ if(strcmp(this->argv[indexArg] , inKey) == 0){
+ // the argv + 1 => variable to use
+ std::istringstream iss(this->argv[indexArg + 1],std::istringstream::in);
+ VariableType value;
+ iss >> value;
+ // if we can cast to the template type
+ if( iss.eof() ){
+ if( inState ) *inState = true;
+ return value;
+ }
+ break;
+ }
+ }
+ // cannot cast to template or key not found
+ if( inState ) *inState = false;
+ return defaultValue;
+ }
+
+};
+
+#endif //FABSTRACTAPPLICATION_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FAbstractThreaded.hpp b/Sources/Utils/FAbstractThreaded.hpp
new file mode 100644
index 000000000..1eaed0664
--- /dev/null
+++ b/Sources/Utils/FAbstractThreaded.hpp
@@ -0,0 +1,74 @@
+#ifndef FABSTRACTTHREADED_HPP
+#define FABSTRACTTHREADED_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FAbstractThreaded
+* Please read the license
+*
+* This class is an interface for threaded class.
+* Each class that wants to use thread must inherited from FOpenMPThreaded or FPosixThreaded.
+*
+* Please refere to testThread.cpp to see an example.
+* <code>
+* // Example with FOpenMPThreaded <br>
+* class TOpen : public FOpenMPThreaded<TOpen>{ <br>
+* public: <br>
+* void threadCallback(const int inThreadId, const int){ <br>
+* printf("I am %d\n",inThreadId); <br>
+* } <br>
+* }; <br>
+* // ... <br>
+* TOpen open; <br>
+* open.executeThreads(10); <br>
+* </code>
+*/
+template <class Derived>
+class FAbstractThreaded{
+public:
+ /**
+ * This function is used to create inThreadsNumber threads with inCallback as the callback.
+ * @param inCallback the callback (must be a object method)
+ * @param inThreadsNumber the number of threads to create
+ */
+ virtual void executeThreads(void (Derived::*inCallback)(const int,const int), const int inThreadsNumber) = 0;
+
+ /**
+ * This function is used to create inThreadsNumber threads with Object::threadCallback as the callback.
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * @warning You have to implement threadCallback
+ */
+ virtual void executeThreads(const int inThreadsNumber) = 0;
+
+ /**
+ * This function executed by each thread after executeThreads has been called
+ * @param inThreadId the current thread index
+ * @param inThreadNumbers the number of threads started
+ * @warning Must be impleted in the derived class
+ */
+ virtual void threadCallback(const int inThreadId,const int inThreadNumbers) = 0;
+
+ /** Useless Virtual Destructor */
+ virtual ~FAbstractThreaded(){}
+
+protected:
+ /**
+ * This function lock a thread-type spefic mutex
+ */
+ virtual void lock() const = 0;
+
+ /**
+ * This function unlock a thread-type spefic mutex
+ */
+ virtual void unlock() const = 0;
+
+ /**
+ * Barrier to sync all thread
+ */
+ virtual void barrier() const = 0;
+};
+
+#endif //FABSTRACTTHREADED_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FAssertable.cpp b/Sources/Utils/FAssertable.cpp
new file mode 100644
index 000000000..6d3f7589b
--- /dev/null
+++ b/Sources/Utils/FAssertable.cpp
@@ -0,0 +1,16 @@
+#include "FAssertable.hpp"
+#include "FAbstractApplication.hpp"
+
+/**
+* Current application
+*/
+FAbstractApplication* FAssertable::CurrentApp(0);
+
+// Simply quit the current app
+void FAssertable::exitApplication(const int inExitCode) const{
+ if(CurrentApp) CurrentApp->abort(inExitCode);
+}
+
+
+
+
diff --git a/Sources/Utils/FAssertable.hpp b/Sources/Utils/FAssertable.hpp
new file mode 100644
index 000000000..87f9c1816
--- /dev/null
+++ b/Sources/Utils/FAssertable.hpp
@@ -0,0 +1,77 @@
+#ifndef FASSERTABLE_HPP
+#define FASSERTABLE_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <sstream>
+#include <iostream>
+
+class FAbstractApplication;
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FAssertable
+* Please read the license
+*
+* This class is an interface for managing error.
+*
+* Please refere to testAssert.cpp to see an example
+* <code>
+* </code>
+*/
+class FAssertable {
+private:
+ static FAbstractApplication* CurrentApp; //< You must have only one app
+
+ /**
+ * Called by Fapplication instance to set the current app
+ * @param inCurrentApp current app
+ */
+ static void SetCurrentApp(FAbstractApplication* const inCurrentApp){
+ CurrentApp = inCurrentApp;
+ }
+
+ /** To set CurrentApp */
+ friend class FAbstractApplication;
+
+ /** To quit current application */
+ void exitApplication(const int inExitCode) const;
+
+protected:
+ /** Empty Destructor */
+ virtual ~FAssertable(){}
+
+ /**
+ * to write debug data with line & file
+ * @param inTest if false, application will stop
+ * @param inMessage a message - from any type - to print
+ * @param inLinePosition line number
+ * @param inFilePosition file name
+ *
+ * <code> assert(toto == titi, "toto is not equal titi!", __LINE__, __FILE__); </code>
+ *
+ * To prevent use from multiple thread we use a ostringstream before printing
+ */
+ template <class Tmess, class Tline, class Tfile>
+ void assert(const bool inTest, const Tmess& inMessage, const Tline& inLinePosition, const Tfile& inFilePosition, const int inExitCode = 1) const {
+ if(!inTest){
+ calledBeforeExit();
+
+ std::ostringstream oss;
+ oss << "Error in " << inFilePosition << " at line " << inLinePosition <<" :\n";
+ oss << inMessage << "\n";
+
+ std::cerr << oss.str();
+ exitApplication(inExitCode);
+ }
+ }
+
+ /**
+ * May be implemented in the derived class to know when app will quit
+ */
+ virtual void calledBeforeExit() const {}
+
+};
+
+#endif //FASSERTABLE_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FDebug.cpp b/Sources/Utils/FDebug.cpp
new file mode 100644
index 000000000..5ceb2e00c
--- /dev/null
+++ b/Sources/Utils/FDebug.cpp
@@ -0,0 +1,12 @@
+#include "FDebug.hpp"
+#ifdef FUSE_DEBUG
+
+/**
+* Singleton debug
+*/
+FDebug FDebug::Controller;
+
+
+
+#endif // FUSE_DEBUG
+
diff --git a/Sources/Utils/FDebug.hpp b/Sources/Utils/FDebug.hpp
new file mode 100644
index 000000000..bdaef7dae
--- /dev/null
+++ b/Sources/Utils/FDebug.hpp
@@ -0,0 +1,162 @@
+#ifndef FDEBUG_HPP
+#define FDEBUG_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+// Uncomment next line to use debug mode
+#define FUSE_DEBUG
+
+#ifndef FUSE_DEBUG
+#define FDEBUG( X )
+#else
+#define FDEBUG( X ) X
+
+#include <iostream>
+#include <fstream>
+#include <sstream>
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FDebug
+* Please read the license
+*
+* This class is used to print debug data durint processing.
+* You have to use the DEBUG macro as shown in the example.
+*
+* <code>
+* FDEBUG( FDebug::Controller.writeFromLine("hello World", __LINE__, __FILE__); ) <br>
+* FDEBUG( FDebug::Controller << "I want to debug " << toto << "\n"; )
+* </code>
+*/
+class FDebug{
+private:
+ std::ostream* stream; //< Standart c++ ostream
+
+ /** Default constructor forbiden */
+ FDebug(){
+ stream = &std::cout;
+ }
+
+ /** Default destructor forbiden */
+ virtual ~FDebug(){
+ close();
+ }
+
+ /**
+ * Close the current debug stream
+ * dealloc the stream if differents from cout.
+ * after this call stream is useless
+ */
+ void close(){
+ stream->flush();
+ if(stream != &std::cout) delete(stream);
+ }
+
+ /**
+ * Copy constructor forbiden
+ * @param other the source class to copy
+ */
+ FDebug(const FDebug& ){}
+
+ /**
+ * Copy constructor forbiden
+ * @param other the source class to copy
+ * @return this a reference to the current class
+ */
+ FDebug& operator=(const FDebug& ){return *this;}
+
+
+public:
+ static FDebug Controller; //< Singleton
+
+ /**
+ * To set the debug stream to write into a file
+ * @param filename the file to write
+ */
+ void writeToFile(const char* const filename){
+ close();
+
+ std::ofstream* const file = new std::ofstream();
+ file->open(filename);
+
+ stream = file;
+ }
+
+ /**
+ * To set the debug stream to write to std::cout
+ */
+ void writeToCout(){
+ close();
+ stream = &std::cout;
+ }
+
+ /**
+ * stream operator to print debug data
+ * @param inMessage a message - from any type - to print
+ * @return current FDebug
+ */
+ template <class T>
+ FDebug& operator<<(const T& inMessage){
+ (*stream) << inMessage;
+ return *this;
+ }
+
+ /**
+ * to write debug data
+ * @param inMessage a message - from any type - to print
+ * @return current FDebug
+ */
+ template <class T>
+ FDebug& write(const T& inMessage){
+ (*stream) << inMessage;
+ return *this;
+ }
+
+ /**
+ * to write debug data with line & file
+ * @param inMessage a message - from any type - to print
+ * @param inLinePosition line number
+ * @param inFilePosition file name
+ * @return current FDebug
+ *
+ * <code> FDebug::Controller.writeFromLine("hello World", __LINE__, __FILE__); </code>
+ *
+ * To prevent use from multiple thread we use a ostringstream before printing
+ */
+ template <class T, class Tline, class Tfile>
+ FDebug& writeFromLine(const T& inMessage, const Tline& inLinePosition, const Tfile& inFilePosition){
+ std::ostringstream oss;
+ oss << "Message from " << inFilePosition << " (at line " << inLinePosition <<")\n";
+ oss << ">> " << inMessage << "\n";
+
+ (*stream) << oss.str();
+ return *this;
+ }
+
+ /**
+ * to write debug data with line & file
+ * @param inVariable variable name
+ * @param inValue variable value
+ * @param inLinePosition line number
+ * @param inFilePosition file name
+ * @return current FDebug
+ *
+ * <code> FDebug::Controller.writeVariableFromLine( "toto", toto, __LINE__, __FILE__); </code>
+ *
+ * To prevent use from multiple thread we use a ostringstream before printing
+ */
+ template <class T, class Tline, class Tfile>
+ FDebug& writeVariableFromLine(const char* const inVariable, const T& inValue, const Tline& inLinePosition, const Tfile& inFilePosition){
+ std::ostringstream oss;
+ oss << "[Value] " << inVariable << " = " << inValue << " at line " << inLinePosition <<" (file " << inFilePosition << ")\n";
+
+ (*stream) << oss.str();
+ return *this;
+ }
+
+};
+
+#endif //FUSE_DEBUG
+
+#endif //FDEBUG_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FMath.hpp b/Sources/Utils/FMath.hpp
new file mode 100644
index 000000000..e27707f9a
--- /dev/null
+++ b/Sources/Utils/FMath.hpp
@@ -0,0 +1,47 @@
+#ifndef FMATH_HPP
+#define FMATH_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <math.h>
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class
+* Please read the license
+*
+* Propose basic math function or indirection
+*/
+struct FMath{
+ /** To get absolute value */
+ template <class NumType>
+ static NumType Abs(const NumType inV){
+ return (inV < 0 ? -inV : inV);
+ }
+ /** To get max between 2 values */
+ template <class NumType>
+ static NumType Max(const NumType inV1, const NumType inV2){
+ return (inV1 > inV2 ? inV1 : inV2);
+ }
+ /** To get min between 2 values */
+ template <class NumType>
+ static NumType Min(const NumType inV1, const NumType inV2){
+ return (inV1 < inV2 ? inV1 : inV2);
+ }
+ /** To know if 2 values seems to be equal */
+ template <class NumType>
+ static bool LookEqual(const NumType inV1, const NumType inV2){
+ /*const double relTol = 0.00001;
+ const double absTol = 0.00001;
+ return (Abs(inV1 - inV2) <= Max(absTol, relTol * Max(Abs(inV1), Abs(inV2))));*/
+ return Abs(inV1 - inV2) <= (Abs(inV1 < Abs(inV2) ? Abs(inV2) : Abs(inV1)) * 0.00001);
+ }
+ /** To get floor of a double */
+ static double dfloor(const double inValue){
+ return floor(inValue);
+ }
+};
+
+
+#endif //FMATH_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FMpiApplication.hpp b/Sources/Utils/FMpiApplication.hpp
new file mode 100644
index 000000000..f85ab0950
--- /dev/null
+++ b/Sources/Utils/FMpiApplication.hpp
@@ -0,0 +1,88 @@
+#ifndef FMPIAPPLICATION_HPP
+#define FMPIAPPLICATION_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <mpi.h>
+
+#include "FAbstractApplication.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FMpiApplication
+* Please read the license
+*
+* This class is an implementation of the abstract application with mpi
+*
+* @warning you have to implement run() and call execute to start the app
+*
+* Please refere to testApplication.cpp to see an example
+* <code>
+* </code>
+*/
+class FMpiApplication : public FAbstractApplication {
+protected:
+ /**
+ * This will be called as the main method
+ * @warning Must be impleted in the derived class
+ */
+ virtual void run() = 0;
+
+
+public:
+ /**
+ * Constructor
+ * @param inArgc argc from command line
+ * @param inArgv argv from command line
+ */
+ FMpiApplication(int inArgc, char ** inArgv )
+ : FAbstractApplication(inArgc,inArgv) {
+ MPI_Init(&inArgc,&inArgv);
+ }
+
+ /** Destructor */
+ virtual ~FMpiApplication(){
+ MPI_Finalize();
+ }
+
+ /**
+ * To get the current process id
+ * @return the process numeber [0 ; processCount [
+ */
+ int processId() const {
+ int id;
+ MPI_Comm_rank(MPI_COMM_WORLD,&id);
+ return id;
+ }
+
+ /**
+ * To get the number of process
+ * @return process count
+ */
+ int processCount() const {
+ int count;
+ MPI_Comm_size(MPI_COMM_WORLD,&count);
+ return count;
+ }
+
+ /**
+ * To make a barrier between process
+ */
+ void processBarrier() const{
+ MPI_Barrier(MPI_COMM_WORLD);
+ }
+
+ /**
+ * To kill all process
+ * @param inErrorCode the error to return to OS (default is 1)
+ */
+ void abort(const int inErrorCode = 1) const {
+ MPI_Abort(MPI_COMM_WORLD, inErrorCode);
+ }
+
+
+
+};
+
+#endif //FMPIAPPLICATION_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FNoThreaded.hpp b/Sources/Utils/FNoThreaded.hpp
new file mode 100644
index 000000000..16246fcd1
--- /dev/null
+++ b/Sources/Utils/FNoThreaded.hpp
@@ -0,0 +1,88 @@
+#ifndef FNOTHREADED_HPP
+#define FNOTHREADED_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <omp.h>
+
+#include "FAbstractThreaded.hpp"
+#include "FDebug.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FNoThreaded
+* Please read the license
+*
+* This class do not use thread. It is used on system that do not allow openmp or posix threads,
+* or to make some test without these libs.
+*
+* @warning You have to put your class name as the template when inheriting.
+*
+* <code>
+* // Example with FNoThreaded <br>
+* class TNo : public FNoThreaded<TNo>{ <br>
+* public: <br>
+* void threadCallback(const int inThreadId, const int){ <br>
+* printf("I am %d\n",inThreadId); <br>
+* } <br>
+* }; <br>
+* // ... <br>
+* TNo notd; <br>
+* notd.executeThreads(10); <br>
+* </code>
+*/
+template <class Derived, int DefaultThreadsNumber = 1>
+class FNoThreaded : public FAbstractThreaded<Derived> {
+public:
+ /**
+ * This function is used to create inThreadsNumber threads with inCallback as the callback.
+ * @param inCallback the callback (must be a object method)
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * <code> open.executeThreads(&TOpen::threadCallback,10); </code>
+ */
+ void executeThreads(void (Derived::*inCallback)(const int, const int), const int inThreadsNumber = DefaultThreadsNumber){
+ Derived* const thisDerived = dynamic_cast<Derived*>(this);
+ (thisDerived->*inCallback)(0, 1);
+ }
+
+ /**
+ * This function is used to create inThreadsNumber threads with Object::threadCallback as the callback.
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * @warning You have to implement threadCallback
+ */
+ void executeThreads(const int inThreadsNumber = DefaultThreadsNumber){
+ threadCallback(0, 1);
+ }
+
+ /**
+ * This function executed by each thread after executeThreads has been called
+ * @param inThreadId the current thread index (equal 0 for no thread)
+ * @param inThreadNumbers the number of threads started (equal 1 for no thread)
+ * @warning Must be impleted in the derived class
+ */
+ virtual void threadCallback(const int inThreadId, const int inThreadNumbers){
+ FDEBUG( FDebug::Controller.writeFromLine("[W] You called executeThreads() but did not implement threadCallback", __LINE__, __FILE__); )
+ };
+
+ /** Useless Virtual Destructor */
+ virtual ~FNoThreaded(){}
+
+protected:
+ /**
+ * This function lock a thread-type spefic mutex - here it does nothing
+ */
+ void lock() const {}
+
+ /**
+ * This function unlock a thread-type spefic mutex - here it does nothing
+ */
+ void unlock() const {}
+
+ /**
+ * Barrier to sync all thread - here it does nothing
+ */
+ void barrier() const {}
+};
+
+#endif //FNOTHREADED_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FOpenMPThreaded.hpp b/Sources/Utils/FOpenMPThreaded.hpp
new file mode 100644
index 000000000..a16d80167
--- /dev/null
+++ b/Sources/Utils/FOpenMPThreaded.hpp
@@ -0,0 +1,123 @@
+#ifndef FOPENMPTHREADED_HPP
+#define FOPENMPTHREADED_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <omp.h>
+
+#include "FAbstractThreaded.hpp"
+#include "FDebug.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FOpenMPThreaded
+* Please read the license
+*
+* This class enable openmp threading.
+*
+* @warning You have to put your class name as the template when inheriting.
+*
+* <code>
+* // Example with FOpenMPThreaded <br>
+* class TOpen : public FOpenMPThreaded<TOpen>{ <br>
+* public: <br>
+* void threadCallback(const int inThreadId, const int){ <br>
+* printf("I am %d\n",inThreadId); <br>
+* } <br>
+* }; <br>
+* // ... <br>
+* TOpen open; <br>
+* open.executeThreads(10); <br>
+* </code>
+*/
+template <class Derived, int DefaultThreadsNumber = 5>
+class FOpenMPThreaded : public FAbstractThreaded<Derived> {
+private:
+ mutable omp_lock_t mutex; //< openmp mutex
+
+public:
+ /**
+ * Constructor
+ * just init mutex
+ */
+ FOpenMPThreaded(){
+ omp_init_lock(&this->mutex);
+ }
+
+ /**
+ * Copy constructor
+ * just init mutex
+ */
+ FOpenMPThreaded(const FOpenMPThreaded&){
+ omp_init_lock(&this->mutex);
+ }
+
+ /**
+ * Destructor
+ * just destroy mutex
+ */
+ virtual ~FOpenMPThreaded(){
+ omp_destroy_lock(&this->mutex);
+ }
+
+ /**
+ * This function is used to create inThreadsNumber threads with inCallback as the callback.
+ * @param inCallback the callback (must be a object method)
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * <code> open.executeThreads(&TOpen::threadCallback,10); </code>
+ */
+ void executeThreads(void (Derived::*inCallback)(const int, const int), const int inThreadsNumber = DefaultThreadsNumber){
+ Derived* const thisDerived = dynamic_cast<Derived*>(this);
+ #pragma omp parallel num_threads(inThreadsNumber)
+ {
+ (thisDerived->*inCallback)(omp_get_thread_num(), omp_get_num_threads());
+ }
+ }
+
+ /**
+ * This function is used to create inThreadsNumber threads with Object::threadCallback as the callback.
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * @warning You have to implement threadCallback
+ */
+ void executeThreads(const int inThreadsNumber = DefaultThreadsNumber){
+ #pragma omp parallel num_threads(inThreadsNumber)
+ {
+ threadCallback(omp_get_thread_num(), omp_get_num_threads());
+ }
+ }
+
+ /**
+ * This function executed by each thread after executeThreads has been called
+ * @param inThreadId the current thread index
+ * @param inThreadNumbers the number of threads started
+ * @warning Must be impleted in the derived class
+ */
+ virtual void threadCallback(const int inThreadId, const int inThreadNumbers){
+ FDEBUG( FDebug::Controller.writeFromLine("[W] You called executeThreads() but did not implement threadCallback", __LINE__, __FILE__); )
+ };
+
+protected:
+ /**
+ * This function lock an openmp mutex
+ */
+ void lock() const {
+ omp_set_lock(&this->mutex);
+ }
+
+ /**
+ * This function unlock an openmp mutex
+ */
+ void unlock() const {
+ omp_unset_lock(&this->mutex);
+ }
+
+ /**
+ * Barrier to sync all thread
+ */
+ void barrier() const {
+ #pragma omp barrier
+ }
+};
+
+#endif //FOPENMPTHREADED_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FPosixThreaded.hpp b/Sources/Utils/FPosixThreaded.hpp
new file mode 100644
index 000000000..eef7988d6
--- /dev/null
+++ b/Sources/Utils/FPosixThreaded.hpp
@@ -0,0 +1,185 @@
+#ifndef FPOSIXTHREADED_HPP
+#define FPOSIXTHREADED_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <pthread.h>
+
+#include "FAbstractThreaded.hpp"
+#include "FDebug.hpp"
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FPosixThreaded
+* Please read the license
+*
+* This class enable posix threading.
+*
+* @warning You have to put your class name as the template when inheriting.
+*
+* <code>
+* // Example with FPosixThreaded <br>
+* class TPosix : public FPosixThreaded<TOpen>{ <br>
+* public: <br>
+* void threadCallback(const int inThreadId, const int){ <br>
+* printf("I am %d\n",inThreadId); <br>
+* } <br>
+* }; <br>
+* // ... <br>
+* TPosix posix; <br>
+* posix.executeThreads(10); <br>
+* </code>
+*/
+template <class Derived, int DefaultThreadsNumber = 5>
+class FPosixThreaded : public FAbstractThreaded<Derived> {
+private:
+ mutable pthread_mutex_t mutex; //< Posix mutex
+ mutable pthread_barrier_t pbarrier; //< To use a barrier
+
+public:
+ /**
+ * Constructor
+ * just init mutex
+ */
+ FPosixThreaded(){
+ initMutex();
+ }
+
+ /**
+ * Copy constructor
+ * just init mutex
+ */
+ FPosixThreaded(const FPosixThreaded&){
+ initMutex();
+ }
+
+ /**
+ * Destructor
+ * just destroy mutex
+ */
+ virtual ~FPosixThreaded(){
+ pthread_mutex_unlock(&this->mutex);
+ pthread_mutex_destroy(&this->mutex);
+ }
+
+ /**
+ * This function is used to create inThreadsNumber threads with inCallback as the callback.
+ * @param inCallback the callback (must be a object method)
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * <code> posix.executeThreads(&TPosix::threadCallback,10); </code>
+ */
+ void executeThreads(void (Derived::*inCallback)(const int, const int), const int inThreadsNumber = DefaultThreadsNumber){
+ // init barrier
+ pthread_barrier_init( &this->pbarrier, 0, inThreadsNumber);
+
+ // Get current object address as a Derived class
+ Derived* const thisDerived = dynamic_cast<Derived*>(this);
+
+ // One descriptor per thread
+ PosixDescriptor descriptors[inThreadsNumber];
+
+ // Create thread
+ for(long indexThread = 1 ; indexThread < inThreadsNumber ; ++indexThread){
+ descriptors[indexThread].target = thisDerived;
+ descriptors[indexThread].callback = inCallback;
+ descriptors[indexThread].threadId = indexThread;
+ descriptors[indexThread].numThreads = inThreadsNumber;
+
+ pthread_create(&descriptors[indexThread].thread, 0, PthreadCallback, (void*)&descriptors[indexThread]);
+ }
+
+ // Master thread
+ (thisDerived->*inCallback)(0 , inThreadsNumber);
+
+ // Wait each thread to finish
+ for(long indexThread = 1 ; indexThread < inThreadsNumber ; ++indexThread){
+ pthread_join(descriptors[indexThread].thread, 0);
+ }
+
+ // destroy barrier
+ pthread_barrier_destroy( &this->pbarrier );
+ }
+
+ /**
+ * This function is used to create inThreadsNumber threads with Object::threadCallback as the callback.
+ * @param inThreadsNumber the number of threads to create (default is DefaultThreadsNumber)
+ * @warning You have to implement threadCallback
+ */
+ void executeThreads(const int inThreadsNumber = DefaultThreadsNumber){
+ executeThreads( &FPosixThreaded::threadCallback , inThreadsNumber);
+ }
+
+ /**
+ * This function executed by each thread after executeThreads has been called
+ * @param inThreadId the current thread index
+ * @param inThreadNumbers the number of threads started
+ * @warning Must be impleted in the derived class
+ */
+ virtual void threadCallback(const int inThreadId, const int inThreadNumbers){
+ FDEBUG( FDebug::Controller.writeFromLine("[W] You called executeThreads() but did not implement threadCallback", __LINE__, __FILE__); )
+ };
+
+protected:
+ /**
+ * Init mutext
+ * Equal this->mutex = PTHREAD_MUTEX_INITIALIZER;
+ */
+ void initMutex(){
+ pthread_mutexattr_t attr;
+ pthread_mutexattr_init(&attr);
+ pthread_mutexattr_settype(&attr,PTHREAD_MUTEX_RECURSIVE);
+ pthread_mutex_init(&this->mutex,&attr);
+ pthread_mutexattr_destroy(&attr);
+ }
+
+ /**
+ * This function lock a posix mutex
+ */
+ void lock() const {
+ pthread_mutex_lock( &this->mutex );
+ }
+
+ /**
+ * This function unlock a posix mutex
+ */
+ void unlock() const {
+ pthread_mutex_unlock( &this->mutex );
+ }
+
+ /**
+ * Barrier to sync all thread
+ */
+ void barrier() const {
+ pthread_barrier_wait( &this->pbarrier );
+ }
+
+private:
+
+ /**
+ * This struct is useless for users, it is use to describe a posix thread
+ */
+ typedef void (Derived::*Callback)(const int, const int);
+ struct PosixDescriptor{
+ Derived * target; //< object to call
+ Callback callback; //< method to call
+ int threadId; //< current thread position
+ int numThreads; //< number of threads
+ pthread_t thread; //< posix descriptor to enable wait/join functions
+ };
+
+ /**
+ * This function is the normal posix thread callback
+ * @param inThreadDescriptor a PosixDescriptor of the current thread
+ * @return 0
+ */
+ static void* PthreadCallback(void* const inThreadDescriptor)
+ {
+ // Simply cast the parameter and call the function
+ PosixDescriptor* const threadDescriptor = (PosixDescriptor*) inThreadDescriptor;
+ (threadDescriptor->target->*threadDescriptor->callback)(threadDescriptor->threadId,threadDescriptor->numThreads);
+ return 0;
+ }
+};
+
+#endif //FPOSIXTHREADED_HPP
+
+// [--LICENSE--]
diff --git a/Sources/Utils/FSingleApplication.hpp b/Sources/Utils/FSingleApplication.hpp
new file mode 100644
index 000000000..808ad8022
--- /dev/null
+++ b/Sources/Utils/FSingleApplication.hpp
@@ -0,0 +1,79 @@
+#ifndef FSINGLEAPPLICATION_HPP
+#define FSINGLEAPPLICATION_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <stdlib.h>
+
+
+#include "FAbstractApplication.hpp"
+
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* @class FSingleApplication
+* Please read the license
+*
+* This class is an application of abstract application with as a standalone process
+*
+* @warning you have to implement run() and call execute to start the app
+*
+* Please refere to testApplication.cpp to see an example
+* <code>
+* </code>
+*/
+class FSingleApplication : public FAbstractApplication {
+protected:
+ /**
+ * This will be called as the main method
+ * @warning Must be impleted in the derived class
+ */
+ virtual void run() = 0;
+
+
+public:
+ /**
+ * Constructor
+ * @param inArgc argc from command line
+ * @param inArgv argv from command line
+ */
+ FSingleApplication(const int inArgc, char ** const inArgv )
+ : FAbstractApplication(inArgc,inArgv) {
+ }
+
+ /** Destructor */
+ virtual ~FSingleApplication(){}
+
+ /**
+ * To get the current process id
+ * @return the process numeber [0 ; processCount [
+ */
+ int processId() const {
+ return 0;
+ }
+
+ /**
+ * To get the number of process
+ * @return process count
+ */
+ int processCount() const {
+ return 1;
+ }
+
+ /**
+ * To make a barrier between process
+ */
+ void processBarrier() const{}
+
+ /**
+ * To kill all process
+ * @param inErrorCode the error to return to OS (default is 1)
+ */
+ void abort(const int inErrorCode = 1) const {
+ exit(inErrorCode);
+ }
+
+};
+
+#endif //FSINGLEAPPLICATION_HPP
+
+// [--LICENSE--]
diff --git a/TODO b/TODO
deleted file mode 100644
index e69de29bb..000000000
diff --git a/Tests/FDebug.out b/Tests/FDebug.out
new file mode 100644
index 000000000..768050eb7
--- /dev/null
+++ b/Tests/FDebug.out
@@ -0,0 +1 @@
+Hello Wordl 2 the return
diff --git a/Tests/testApplication.cpp b/Tests/testApplication.cpp
new file mode 100644
index 000000000..5e501f499
--- /dev/null
+++ b/Tests/testApplication.cpp
@@ -0,0 +1,61 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+//#define FUSE_MPI
+
+#ifdef FUSE_MPI
+// Compile by mpic++ testApplication.cpp -o testApplication.exe
+// run by mpirun -np 4 ./testApplication
+#include "../Sources/Utils/FMpiApplication.hpp"
+#define ApplicationImplementation FMpiApplication
+#else
+// Compile by g++ testApplication.cpp -o testApplication.exe
+#include "../Sources/Utils/FSingleApplication.hpp"
+#define ApplicationImplementation FSingleApplication
+#endif
+
+#include <stdio.h>
+
+
+/**
+* In this file we show how to use the application module
+* please refere to the source of testApplication.cpp directly to know more
+*/
+
+/**
+* FApp is an example of the FApplication
+*/
+class FApp : public ApplicationImplementation{
+public:
+ FApp(const int inArgc, char ** const inArgv )
+ : ApplicationImplementation(inArgc,inArgv) {
+ }
+
+protected:
+ void initMaster(){
+ printf("I am %d on %d, I am master\n", processId(), processCount());
+
+ const std::string argStr = userParemeterAt<std::string>(0);
+ printf("[Master] arg str = %s\n", argStr.c_str()); // will print ./testApplication
+ const int argInt = userParemeterAt<int>(0,-1);
+ printf("[Master] arg int = %d\n", argInt); // will print -1
+ }
+ void initSlave(){
+ printf("I am %d on %d, I am slave\n", processId(), processCount());
+ }
+
+ void run(){
+ printf("I am %d, I start to work\n",processId());
+ for(long idx = 0 ; idx < 50000000 ; ++idx) {++idx;--idx;}
+ processBarrier();
+ printf("I am %d, I just finished\n",processId());
+ }
+};
+
+// Usual Main
+int main(int argc, char ** argv){
+ FApp app(argc,argv);
+ return app.execute();
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testAssert.cpp b/Tests/testAssert.cpp
new file mode 100644
index 000000000..e0dcfe429
--- /dev/null
+++ b/Tests/testAssert.cpp
@@ -0,0 +1,43 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+
+#include "../Sources/Utils/FSingleApplication.hpp"
+#include "../Sources/Utils/FAssertable.hpp"
+
+// Compile by : g++ testAssert.cpp ../Sources/Utils/FAssertable.cpp -o testAssert.exe
+
+/**
+* In this file we show how to use assert and error managing module
+*/
+
+// This class is a basic application that need to be assertable
+class FApp : public FSingleApplication, public FAssertable {
+public:
+ FApp(const int inArgc, char ** const inArgv )
+ : FSingleApplication(inArgc,inArgv) {
+ }
+
+protected:
+ void run(){
+ int* pt = new int;
+ assert(pt, "pt allocation failled!", __LINE__, __FILE__);
+ delete pt;
+
+ assert(false, "Error in doing some stuff", __LINE__, __FILE__);
+ }
+
+ // optional : doing something before assert calls FApp->exit
+ void calledBeforeExit() const {
+ std::cout << "assert is false we will quit what can I do...?\n";
+ }
+};
+
+// Usual Main
+int main(int argc, char ** argv){
+ FApp app(argc,argv);
+ return app.execute();
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testDebug.cpp b/Tests/testDebug.cpp
new file mode 100644
index 000000000..128932b42
--- /dev/null
+++ b/Tests/testDebug.cpp
@@ -0,0 +1,31 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include "../Sources/Utils/FDebug.hpp"
+
+// Compile by : g++ testDebug.cpp ../Sources/Utils/FDebug.cpp -o testFDebug.exe
+
+/**
+* In this file we show how to use the debug module
+* please refere to the source of testDebug.cpp directly to knwo more
+*/
+
+int main(void){
+ // Print data simply
+ FDEBUG( FDebug::Controller << "Hello Wordl\n");
+
+ // Print a variable (formated print)
+ int i = 50;
+ FDEBUG( FDebug::Controller.writeVariableFromLine( "i", i, __LINE__, __FILE__););
+
+ // Write a developer information
+ FDEBUG( FDebug::Controller.writeFromLine("Strange things happend here!", __LINE__, __FILE__); )
+
+ // Change stream type
+ FDEBUG( FDebug::Controller.writeToFile("FDebug.out"); )
+ FDEBUG( FDebug::Controller << "Hello Wordl 2 the return\n");
+
+ return 0;
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testLoader.cpp b/Tests/testLoader.cpp
new file mode 100644
index 000000000..0a6ff401c
--- /dev/null
+++ b/Tests/testLoader.cpp
@@ -0,0 +1,76 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+
+#include <omp.h>
+
+#include "../Sources/Containers/FOctree.hpp"
+#include "../Sources/Containers/FList.hpp"
+
+#include "../Sources/Utils/FAssertable.hpp"
+#include "../Sources/Utils/F3DPosition.hpp"
+
+#include "../Sources/Core/FBasicParticule.hpp"
+
+#include "../Sources/Files/FBasicLoader.hpp"
+
+// Compile by : g++ testLoader.cpp ../Sources/Utils/FAssertable.cpp -o testLoader.exe
+
+
+class TestCell{
+};
+
+/**
+ * In this file we show an example of BasicParticule and BasicLoader use
+* Démarrage de /home/berenger/Dropbox/Personnel/FMB++/FMB++-build-desktop/FMB++...
+* Inserting particules ...
+* Done (5.77996).
+* Deleting particules ...
+* Done (0.171918).
+ */
+
+int main(int , char ** ){
+ // we store all particules to be able to dealloc
+ FList<FBasicParticule*> particules;
+
+ // open basic particules loader
+ FBasicLoader<FBasicParticule> loader("../FMB++/Tests/particules.basic.txt");
+ if(!loader.isValide()){
+ std::cout << "Loader Error\n";
+ return 1;
+ }
+
+ // otree
+ FOctree<FBasicParticule, TestCell, 10, 3> tree(loader.getBoxWidth(),loader.getCenterOfBox());
+
+ // -----------------------------------------------------
+ std::cout << "Inserting particules ..." << std::endl;
+ const double InsertingStartTime = omp_get_wtime();
+ for(int idx = 0 ; idx < loader.getNumberOfParticules() ; ++idx){
+ FBasicParticule* const part = new FBasicParticule();
+ particules.pushFront(part);
+ loader.fillParticule(part);
+ tree.insert(part);
+ }
+ const double InsertingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (InsertingEndTime-InsertingStartTime) << ")." << std::endl;
+
+ // -----------------------------------------------------
+ std::cout << "Deleting particules ..." << std::endl;
+ const double DeletingStartTime = omp_get_wtime();
+ while(particules.getSize()){
+ delete particules.popFront();
+ }
+ const double DeletingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (DeletingEndTime-DeletingStartTime) << ")." << std::endl;
+ // -----------------------------------------------------
+
+ return 0;
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testOctree.cpp b/Tests/testOctree.cpp
new file mode 100644
index 000000000..786bce03a
--- /dev/null
+++ b/Tests/testOctree.cpp
@@ -0,0 +1,93 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+
+#include <omp.h>
+
+#include "../Sources/Containers/FOctree.hpp"
+#include "../Sources/Containers/FList.hpp"
+
+#include "../Sources/Utils/FAssertable.hpp"
+#include "../Sources/Utils/F3DPosition.hpp"
+
+#include "../Sources/Core/FAbstractParticule.hpp"
+
+// Compile by : g++ testOctree.cpp ../Sources/Utils/FAssertable.cpp -o testOctree.exe
+
+/**
+* In this file we show how to use octree
+* Démarrage de /home/berenger/Dropbox/Personnel/FMB++/FMB++-build-desktop/FMB++...
+* Creating particules ...
+* Done (0.268113).
+* Inserting particules ...
+* Done (2.70836).
+* Deleting particules ...
+* Done (0.0791715).
+*/
+class TestParticule : public FAbstractParticule {
+ F3DPosition pos;
+public:
+ TestParticule(const F3DPosition& inPos) : pos(inPos) {
+ }
+
+ F3DPosition getPosition() const {
+ return pos;
+ }
+};
+
+class TestCell{
+};
+
+
+int main(int , char ** ){
+ const long NbPart = 2000000;
+ FList<TestParticule*> particules;
+
+ srand ( time(NULL) );
+
+
+ // -----------------------------------------------------
+ std::cout << "Creating particules ..." << std::endl;
+ const double CreatingStartTime = omp_get_wtime();
+ for(long idxPart = 0 ; idxPart < NbPart ; ++idxPart){
+ particules.pushFront(new TestParticule(F3DPosition(double(rand())/RAND_MAX,double(rand())/RAND_MAX,double(rand())/RAND_MAX)));
+ }
+ const double CreatingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (CreatingEndTime-CreatingStartTime) << ")." << std::endl;
+ // -----------------------------------------------------
+
+ FOctree<TestParticule, TestCell, 10, 3> tree(1.0,F3DPosition(0.5,0.5,0.5));
+ FList<TestParticule*>::BasicIterator iter(particules);
+
+ // -----------------------------------------------------
+ std::cout << "Inserting particules ..." << std::endl;
+ const double InsertingStartTime = omp_get_wtime();
+ while( iter.isValide() ){
+ tree.insert(iter.value());
+ iter.progress();
+ }
+ const double InsertingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (InsertingEndTime-InsertingStartTime) << ")." << std::endl;
+ // -----------------------------------------------------
+
+ // -----------------------------------------------------
+ std::cout << "Deleting particules ..." << std::endl;
+ const double DeletingStartTime = omp_get_wtime();
+ while(particules.getSize()){
+ delete particules.popFront();
+ }
+ const double DeletingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (DeletingEndTime-DeletingStartTime) << ")." << std::endl;
+ // -----------------------------------------------------
+
+
+
+ return 0;
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testOctreeIter.cpp b/Tests/testOctreeIter.cpp
new file mode 100644
index 000000000..f13bf87c2
--- /dev/null
+++ b/Tests/testOctreeIter.cpp
@@ -0,0 +1,135 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+
+#include <omp.h>
+
+#include "../Sources/Containers/FOctree.hpp"
+#include "../Sources/Containers/FList.hpp"
+
+#include "../Sources/Utils/FAssertable.hpp"
+#include "../Sources/Utils/F3DPosition.hpp"
+
+#include "../Sources/Core/FAbstractParticule.hpp"
+
+// Compile by : g++ testOctreeIter.cpp ../Sources/Utils/FAssertable.cpp -o testOctreeIter.exe
+
+/**
+* In this file we show how to use octree with iteration
+NbLevels = 5 & NbSubLevels = 2 & NbPart = 2000000
+Creating particules ...
+Done (0.263944s).
+Inserting particules ...
+Done (0.349972s).
+Itering on particules ...
+Next level (4096)...
+Next level (512)...
+Next level (64)...
+Next level (8)...
+Done (5.742e-05s).
+Deleting particules ...
+Done (0.075429s).
+
+NbLevels = 10 & NbSubLevels = 3 & NbPart = 2000000
+Creating particules ...
+Done (0.261834s).
+Inserting particules ...
+Done (2.68187s).
+Itering on particules ...
+Next level (1985191)...
+Next level (1885276)...
+Next level (1289097)...
+Next level (262019)...
+Next level (32768)...
+Next level (4096)...
+Next level (512)...
+Next level (64)...
+Next level (8)...
+Done (0.716064s).
+Deleting particules ...
+Done (0.0830964s).
+*/
+class TestParticule : public FAbstractParticule {
+ F3DPosition pos;
+public:
+ TestParticule(const F3DPosition& inPos) : pos(inPos) {
+ }
+
+ F3DPosition getPosition() const {
+ return pos;
+ }
+};
+
+class TestCell{
+};
+
+
+int main(int , char ** ){
+ const int NbLevels = 10;
+ const int NbSubLevels = 3;
+ const long NbPart = 2E5;
+ FList<TestParticule*> particules;
+
+ srand ( 1 ); // volontary set seed to constant
+
+ // -----------------------------------------------------
+ std::cout << "Creating particules ..." << std::endl;
+ const double CreatingStartTime = omp_get_wtime();
+ for(long idxPart = 0 ; idxPart < NbPart ; ++idxPart){
+ particules.pushFront(new TestParticule(F3DPosition(double(rand())/RAND_MAX,double(rand())/RAND_MAX,double(rand())/RAND_MAX)));
+ }
+ const double CreatingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (CreatingEndTime-CreatingStartTime) << "s)." << std::endl;
+ // -----------------------------------------------------
+
+ FOctree<TestParticule, TestCell, NbLevels, NbSubLevels> tree(1.0,F3DPosition(0.5,0.5,0.5));
+ FList<TestParticule*>::BasicIterator iter(particules);
+
+ // -----------------------------------------------------
+ std::cout << "Inserting particules ..." << std::endl;
+ const double InsertingStartTime = omp_get_wtime();
+ while( iter.isValide() ){
+ tree.insert(iter.value());
+ iter.progress();
+ }
+ const double InsertingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (InsertingEndTime-InsertingStartTime) << "s)." << std::endl;
+ // -----------------------------------------------------
+
+ std::cout << "Itering on particules ..." << std::endl;
+ const double InteringStartTime = omp_get_wtime();
+
+ FOctree<TestParticule, TestCell, NbLevels, NbSubLevels>::Iterator octreeIterator(&tree);
+ octreeIterator.gotoBottomLeft();
+ for(int idx = 0 ; idx < NbLevels - 1; ++idx ){
+ int counter = 0;
+ do{
+ ++counter;
+ //counter += octreeIterator.getCurrentList()->getSize();
+ } while(octreeIterator.moveRight());
+ octreeIterator.moveUp();
+ octreeIterator.gotoLeft();
+ std::cout << "Next level (" << counter << ")...\n";
+ }
+ const double IteringEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (IteringEndTime-InteringStartTime) << "s)." << std::endl;
+
+ // -----------------------------------------------------
+ std::cout << "Deleting particules ..." << std::endl;
+ const double DeletingStartTime = omp_get_wtime();
+ while(particules.getSize()){
+ delete particules.popFront();
+ }
+ const double DeletingEndTime = omp_get_wtime();
+ std::cout << "Done " << "(" << (DeletingEndTime-DeletingStartTime) << "s)." << std::endl;
+ // -----------------------------------------------------
+
+ return 0;
+}
+
+
+// [--LICENSE--]
diff --git a/Tests/testThread.cpp b/Tests/testThread.cpp
new file mode 100644
index 000000000..9c8acd2ad
--- /dev/null
+++ b/Tests/testThread.cpp
@@ -0,0 +1,74 @@
+// /!\ Please, you must read the license at the bottom of this page
+
+#include "../Sources/Utils/FAbstractThreaded.hpp"
+#include "../Sources/Utils/FOpenMPThreaded.hpp"
+#include "../Sources/Utils/FPosixThreaded.hpp"
+#include "../Sources/Utils/FNoThreaded.hpp"
+
+#include <stdio.h>
+
+// Compile by g++ testThread.cpp ../Sources/Utils/FDebug.cpp -lgomp -lpthread -fopenmp -o testThread.exe
+
+/**
+* In this file we show how to use the thread module
+* please refere to the source of testDebug.cpp directly to knwo more
+*/
+
+
+/**
+* TOpen is an example of the FOpenMPThreaded implementation class
+*/
+class TOpen : public FOpenMPThreaded<TOpen>{
+public:
+ void threadCallback(const int inThreadId, const int inThreadsNum){
+ printf("I am %d on %d, \n",inThreadId, inThreadsNum);
+ }
+
+ void threadCallbackMutex(const int inThreadId, const int inThreadsNum){
+ lock();
+ for(long idx = 0 ; idx < 50000000 ; ++idx) {++idx;--idx;}
+ printf("I am %d on %d, \n",inThreadId, inThreadsNum);
+ unlock();
+
+ barrier();
+ printf("I am %d ok\n",inThreadId);
+ }
+};
+
+/**
+* TPosix is an example of the FPosixThreaded implementation class
+*/
+class TPosix : public FPosixThreaded<TPosix>{
+public:
+ void threadCallback(const int inThreadId, const int inThreadsNum){
+ printf("I am %d on %d, \n",inThreadId, inThreadsNum);
+ }
+
+ void threadCallbackMutex(const int inThreadId, const int inThreadsNum){
+ lock();
+ for(long idx = 0 ; idx < 50000000 ; ++idx) {++idx;--idx;}
+ printf("I am %d on %d, \n",inThreadId, inThreadsNum);
+ unlock();
+
+ barrier();
+ printf("I am %d ok\n",inThreadId);
+ }
+};
+
+
+int main(void){
+ // create openmp thread derived class
+ TOpen open;
+ open.executeThreads(10);
+ open.executeThreads(&TOpen::threadCallbackMutex,5);
+
+ // create posix thread derived class
+ TPosix posix;
+ posix.executeThreads(10);
+ posix.executeThreads(&TPosix::threadCallbackMutex,5);
+
+ return 0;
+}
+
+
+// [--LICENSE--]
diff --git a/UTests/FUTester.hpp b/UTests/FUTester.hpp
new file mode 100644
index 000000000..8f57fc698
--- /dev/null
+++ b/UTests/FUTester.hpp
@@ -0,0 +1,192 @@
+#ifndef UTESTER_HPP
+#define UTESTER_HPP
+// /!\ Please, you must read the license at the bottom of this page
+
+#include <iostream>
+#include <list>
+#include <string>
+#include <stdio.h>
+
+
+#define TestClass(X)\
+int main(void){\
+ X Controller;\
+ Controller.Run();\
+ return 0;\
+}\
+
+
+/**
+* @author Berenger Bramas (berenger.bramas@inria.fr)
+* Please read the license
+*
+* This class is used to make simple unit test cases
+*
+* Please refer to testUTest.cpp to see an example
+* @warning Create a derived that implement SetTests() and use TestClass() macro
+*/
+template <class TestClass>
+class FUTester{
+ // Test function pointer
+ typedef void (TestClass::*TestFunc)(void);
+
+ /** Test descriptor */
+ struct TestFuncDescriptor{
+ TestFunc func; //< Test adress
+ std::string name; //< Test name
+ };
+
+
+ std::list<TestFuncDescriptor> tests; //< all tests
+
+ int totalTests; //< number of tests
+
+ int currentTest; //< current processing test in the run
+ int currentStep; //< current processing step in the run
+
+ int failledSteps; //< number of failled step in the current test
+ int failledTests; //< number of failled tests
+
+protected:
+ /** Constructor */
+ FUTester(){
+ totalTests = 0;
+ }
+
+ /** Callback before processing test */
+ virtual void Before(){}
+
+ /** Callback after processing test */
+ virtual void After(){}
+
+ /** Callback before each unit test */
+ virtual void PreTest(){}
+
+ /** Callback after each unit test */
+ virtual void PostTest(){}
+
+ /**
+ * This function has to add tests
+ * <code> AddTest(&MyTest::TestOne); </code>
+ */
+ virtual void SetTests() = 0;
+
+ /**
+ * Add a test without giving a name
+ * @param inFunc test function address
+ */
+ void AddTest(TestFunc inFunc){
+ char buff[256];
+ sprintf(buff,"Unamed Test number %d",totalTests+1);
+ AddTest(inFunc,buff);
+ }
+
+ /**
+ * Add a test with a name
+ * @param inFunc test function address
+ * @param inFuncName function name
+ */
+ void AddTest(TestFunc inFunc, const std::string& inFuncName){
+ ++totalTests;
+ TestFuncDescriptor desc;
+ desc.func = inFunc;
+ desc.name = inFuncName;
+ tests.push_back(desc);
+ }
+
+ /**
+ * To print a message manually in the test
+ * @param value a object that ostream can work on
+ */
+ template <class Output>
+ void Print(const Output& value){
+ std::cout<< "--- Output from program : " << value << "\n";
+ }
+
+ /**
+ * To test
+ * @param result the test result
+ * if result is false test failled
+ */
+ void assert(const bool result){
+ ++currentStep;
+ if(!result){
+ std::cout << ">> Step " << currentStep << " Failled\n";
+ ++failledSteps;
+ }
+ }
+
+ /**
+ * To test equality
+ * @param v1 value one
+ * @param v2 value 2
+ * if v1 is not equal v2 test failled
+ */
+ template <class T>
+ void equal(const T& v1, const T& v2){
+ assert(v1 == v2);
+ }
+
+ /**
+ * To test equality
+ * @param v1 value one
+ * @param v2 value 2
+ * if v1 is equal v2 test failled
+ */
+ template <class T>
+ void different(const T& v1, const T& v2){
+ assert(v1 != v2);
+ }
+
+public :
+ /**
+ * Processing the test
+ */
+ void Run(){
+ tests.clear();
+ // register tests
+ SetTests();
+
+ TestClass* const toTest = static_cast<TestClass*>(this);
+ currentTest = 0;
+ failledTests = 0;
+
+ Before();
+
+ // for each tests
+ const typename std::list<TestFuncDescriptor>::const_iterator end = tests.end();
+ for(typename std::list<TestFuncDescriptor>::iterator iter = tests.begin() ; iter != end ; ++iter){
+ currentStep = 0;
+ failledSteps = 0;
+
+ std::cout << "[Start] " << (*iter).name << "\n";
+
+ PreTest();
+ TestFunc ff = (*iter).func;
+ (toTest->*ff)();
+ PostTest();
+
+ if(failledSteps){
+ std::cout << "[Finished] FAILLED (" << failledSteps << "/" << currentStep<< " steps failled)\n";
+ ++failledTests;
+ }
+ else{
+ std::cout << "[Finished] PASSED (" << currentStep << " steps)\n";
+ }
+
+ ++currentTest;
+ }
+
+
+ After();
+
+ std::cout <<"Test is over, " << (totalTests-failledTests) << " Passed, " << failledTests << " Failled\n";
+ }
+
+};
+
+
+
+
+
+#endif
diff --git a/UTests/flistUTest.cpp b/UTests/flistUTest.cpp
new file mode 100644
index 000000000..36cbab79b
--- /dev/null
+++ b/UTests/flistUTest.cpp
@@ -0,0 +1,104 @@
+#include "FUTester.hpp"
+
+#include "../Sources/Containers/FList.hpp"
+
+// compile by g++ flistUTest.cpp -o testFile.exe
+
+/**
+* This file is a unit test for the FList class
+*/
+
+/**
+* This class is simply used to count alloc dealloc
+*/
+class TestObject{
+public:
+ static int counter;
+ static int dealloced;
+
+ TestObject(){
+ ++counter;
+ }
+ TestObject(const TestObject&){
+ ++counter;
+ }
+ ~TestObject(){
+ ++dealloced;
+ }
+};
+
+int TestObject::counter(0);
+int TestObject::dealloced(0);
+
+
+/** this class test the list container */
+class TestList : public FUTester<TestList> {
+ // Called before each test : simply set counter to 0
+ void PreTest(){
+ TestObject::counter = 0;
+ TestObject::dealloced = 0;
+ }
+
+ // test size
+ void TestSize(){
+ FList<TestObject> list;
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+ assert(list.getSize() == 3);
+
+ assert((TestObject::counter - TestObject::dealloced) == list.getSize());
+
+ list.clear();
+ assert(list.getSize() == 0);
+
+ assert(TestObject::counter == TestObject::dealloced);
+ }
+
+ // test copy
+ void TestCopy(){
+ FList<TestObject> list;
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+
+ FList<TestObject> list2 = list;
+ assert(list.getSize() == list2.getSize());
+
+ assert((TestObject::counter - TestObject::dealloced) == (list.getSize() + list2.getSize()));
+ }
+
+ // test iter
+ void TestIter(){
+ FList<TestObject> list;
+ {
+ FList<TestObject>::BasicIterator iter(list);
+ assert(!iter.isValide());
+ }
+ {
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+ list.pushFront(TestObject());
+
+ FList<TestObject>::BasicIterator iter(list);
+ assert(iter.isValide());
+
+ int counter = 0;
+ while(iter.isValide()){ iter.progress(); ++counter; }
+ assert(!iter.isValide());
+ assert(counter == list.getSize());
+ }
+ }
+
+ // set test
+ void SetTests(){
+ AddTest(&TestList::TestSize,"Test Size");
+ AddTest(&TestList::TestCopy,"Test Copy");
+ AddTest(&TestList::TestIter,"Test Iter");
+ }
+};
+
+// You must do this
+TestClass(TestList)
+
+
diff --git a/UTests/testUTest.cpp b/UTests/testUTest.cpp
new file mode 100644
index 000000000..7ada6af86
--- /dev/null
+++ b/UTests/testUTest.cpp
@@ -0,0 +1,44 @@
+#include "FUTester.hpp"
+
+// compile by g++ testUTest.cpp -o test.exe
+
+/** this class show a simple example of unit test */
+class MyTest : public FUTester<MyTest> {
+ void Before(){
+ Print("Before running the test");
+ }
+
+ void TestOne(){
+ assert(true);
+ assert(false);
+ assert(1 == 1);
+ }
+
+ void TestTwo(){
+ equal(1 , 1);
+ different(1 , 1);
+ }
+
+ void After(){
+ Print("After running the test");
+ }
+
+ void PreTest(){
+ Print("Before each test");
+ }
+
+ void PostTest(){
+ Print("After each test");
+ }
+
+ // You must implement it
+ void SetTests(){
+ AddTest(&MyTest::TestOne);
+ AddTest(&MyTest::TestTwo,"My Second Test");
+ }
+};
+
+// You must do this
+TestClass(MyTest)
+
+
--
GitLab