diff options
Diffstat (limited to 'doc/aapl')
30 files changed, 2065 insertions, 0 deletions
diff --git a/doc/aapl/Doxyfile.in b/doc/aapl/Doxyfile.in new file mode 100644 index 00000000..d632ed39 --- /dev/null +++ b/doc/aapl/Doxyfile.in @@ -0,0 +1,1228 @@ +# Doxyfile 1.4.2 + +# 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 +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = Aapl + +# 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 = @VERSION@ + +# 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 = . + +# 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: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# 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 = + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_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 DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = 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 = NO + +# 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 + +# 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 = 4 + +# 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 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 + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 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 = YES + +# 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 = YES + +# 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 = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# 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 = 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 = NO + +# 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_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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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. + +SHOW_DIRECTORIES = NO + +# 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 progam writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 = NO + +# 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 = dlist/dlistall.h \ + avltree/avlall.h \ + avlitree/avliall.h \ + vector/vectall.h \ + ../aapl/table.h \ + ../aapl/resize.h \ + bsttable/bstall.h \ + sort/sortall.h \ + compare/compare.h \ + string/astring.h \ + mainpage.h + +# 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 + +FILE_PATTERNS = + +# 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 = NO + +# 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 = NO + +# 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. + +EXCLUDE_PATTERNS = + +# 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 = "cpp -nostdinc -P -C -Idummy -DAAPL_DOCUMENTATION" + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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 = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# 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 (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = 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 = YES + +#--------------------------------------------------------------------------- +# 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 = 3 + +# 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 = header.html + +# 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 = footer.html + +# 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 = + +# 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 GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# 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 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 + +# 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 = YES + +# 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 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = 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 + +#--------------------------------------------------------------------------- +# 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. + +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 = NO + +# 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 = NO + +# 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 + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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_PREDEFINED 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 = NO + +# 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 + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_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 = NO + +# 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 = NO + +# 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 MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# 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 a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). + +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 + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/doc/aapl/Makefile b/doc/aapl/Makefile new file mode 100644 index 00000000..3dc64272 --- /dev/null +++ b/doc/aapl/Makefile @@ -0,0 +1,43 @@ +# +# Copyright 2002, 2003 Adrian Thurston <thurston@cs.queensu.ca> +# + +# This file is part of Aapl. +# +# Aapl is free software; you can redistribute it and/or modify it under the +# terms of the GNU Lesser General Public License as published by the Free +# Software Foundation; either version 2.1 of the License, or (at your option) +# any later version. +# +# Aapl is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for +# more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with Aapl; if not, write to the Free Software Foundation, Inc., 59 +# Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +# Get the version info. +include ../../aapl-repos/version.mk + +PREFIX = ../../aapl + +all: Doxyfile + rm -Rf html + mkdir html + ./makelinks + ./makedummy + doxygen Doxyfile + +%: %.cpp + g++ -I../aapl -o $@ $< + +Doxyfile: Doxyfile.in ../../aapl-repos/version.mk + sed 's/@VERSION@/$(VERSION)/' Doxyfile.in > Doxyfile + +clean: + rm -Rf .deps Doxyfile html dummy + find . -type l | xargs rm -f + diff --git a/doc/aapl/avlitree/avliall.h b/doc/aapl/avlitree/avliall.h new file mode 100644 index 00000000..0382d84a --- /dev/null +++ b/doc/aapl/avlitree/avliall.h @@ -0,0 +1,30 @@ +/** + * \defgroup avlitree Linked AVL Tree + * \brief Linked balanced binary tree. + * + * These data structures are similar to the regular AVL tree data structure + * except elements are implicitly linked together in an ordered list. This + * does not add more than a constant amount of work to each operation and + * allows the use of next and previous pointers for walking the items in the + * tree. + * + * AVL tree provides a balanaced binary tree. All operations are O(log(N)). + * AVL Tree is very useful as a general purpose map. + * + * In the current implementation. A single avl tree cannot contain two + * elements with the same key. If this functionality is required, a binary + * search table must be used instead. + * + * As with the double linked list, the AVL trees are divided into two + * types: those that leave element management up to the user and those that + * manage the allocation of elements. All trees except AvlMap and AvlSet leave + * element allocation management up to the user. + */ + +#include "avlitree.h" +#include "avlimel.h" +#include "avlimelkey.h" +#include "avlimap.h" +#include "avliset.h" +#include "avlibasic.h" +#include "avlikeyless.h" diff --git a/doc/aapl/avltree/avlall.h b/doc/aapl/avltree/avlall.h new file mode 100644 index 00000000..6d2e5aa2 --- /dev/null +++ b/doc/aapl/avltree/avlall.h @@ -0,0 +1,32 @@ +/** + * \defgroup avltree AVL Tree + * \brief Balanced binary tree. + * + * AVL tree provides a balanaced binary tree. All operations are O(log(N)). + * AVL Tree is very useful as a general purpose map. + * + * In the current implementation. A single avl tree cannot contain two + * elements with the same key. If this functionality is required, a binary + * search table must be used instead. + * + * As with the double linked list, the AVL trees are divided into two types: + * those that leave element management up to the user and those that manage + * the allocation of elements. All trees except AvlMap and AvlSet leave + * element allocation management up to the user. + * + * The AVL trees can be iterated using each class's Iter structure. This + * iteration traverses the tree structure to produce an inorder walk of the + * nodes. An single iteration step runs in O(log(N)) time. In the worst case + * moving to the next node requires traversing the tree from a leaf node up to + * the root node and then back down agin to a leaf node. If this traversal is + * too costly or if pointers to next and previous nodes are desired then the + * trees in the Linked AVL Tree group can be used. + */ + +#include "avltree.h" +#include "avlmel.h" +#include "avlmelkey.h" +#include "avlmap.h" +#include "avlset.h" +#include "avlbasic.h" +#include "avlkeyless.h" diff --git a/doc/aapl/bsttable/bstall.h b/doc/aapl/bsttable/bstall.h new file mode 100644 index 00000000..1b1d9bcc --- /dev/null +++ b/doc/aapl/bsttable/bstall.h @@ -0,0 +1,24 @@ +/** + * \defgroup bst Binary Search Table + * \brief A dynamic array implementing binary search. + * + * This is a Binary Search %Table built on top of Vector. It allows for + * O(log(N)) finds but is constrained to O(N) insertions and deletions as + * it is table based. + * + * Binary Search %Table is instantiated by supplying an element or key and + * value types which are stored directly in the underlying vector. This is + * opposed to requiring that the element inherit from a base element as is the + * case with AvlTree. A Compare class that can compare the key type must be + * supplied. + * + * Being table based means that it is simple to get an ordered walk of the + * elements in the table. + */ + +#include "bsttable.h" +#include "bstmap.h" +#include "bstset.h" +#include "sbsttable.h" +#include "sbstmap.h" +#include "sbstset.h" diff --git a/doc/aapl/check_ex_compile b/doc/aapl/check_ex_compile new file mode 100755 index 00000000..de4a23c4 --- /dev/null +++ b/doc/aapl/check_ex_compile @@ -0,0 +1,7 @@ +#!/bin/bash +# + +for fn in ex_*.cpp; do + ( set -x; g++ -Wall -I../aapl -o tmp.out $fn; ) +done +rm tmp.out diff --git a/doc/aapl/dlist/dlistall.h b/doc/aapl/dlist/dlistall.h new file mode 100644 index 00000000..a3ef2097 --- /dev/null +++ b/doc/aapl/dlist/dlistall.h @@ -0,0 +1,26 @@ +/** + * \defgroup dlist Double List + * \brief A double linked list. + * + * In DList and DListMel, any structure can become an element that goes in a + * Double List by inheriting from the DListEl template class or by simply + * having next and previous pointers. List elements are + * allocated and owned by the user of the list. You can use these stuctures to + * link together elements that are statically allocated, or that belong to + * some other data structure. DList and DListMel will not delete the list + * contents in their destructors. + * + * DListMel allows a data structure to be an element in multiple lists. The + * element structure inherits multiple element base class and the name of the + * appropriate base class is passed to DListMel so it can resolve the + * ambiguity in accessing the next and previous pointers. + * + * DListVal is a value oriented list that behaves much like the STL list + * class. In this structure the list manages the allocation and deallocation + * of the list elements. The user is concerned with inserting a + * user value which gets copied into a newly allocated list element. + */ + +#include "dlist.h" +#include "dlistmel.h" +#include "dlistval.h" diff --git a/doc/aapl/ex_astring.cpp b/doc/aapl/ex_astring.cpp new file mode 100644 index 00000000..710a4b62 --- /dev/null +++ b/doc/aapl/ex_astring.cpp @@ -0,0 +1,11 @@ +#include <iostream> +#include "astring.h" + +using namespace std; + +int main() +{ + String s = "hello"; + s += " there my friend"; + cout << s.data << endl; +} diff --git a/doc/aapl/ex_avlimap.cpp b/doc/aapl/ex_avlimap.cpp new file mode 100644 index 00000000..ce6c693e --- /dev/null +++ b/doc/aapl/ex_avlimap.cpp @@ -0,0 +1,8 @@ +#include "avlimap.h" + +int main() +{ + AvliMap< char *, int, CmpStr > avlmap; + avlmap.insert( "the key", 1 ); + return 0; +} diff --git a/doc/aapl/ex_avlimel.cpp b/doc/aapl/ex_avlimel.cpp new file mode 100644 index 00000000..2fadaa3f --- /dev/null +++ b/doc/aapl/ex_avlimel.cpp @@ -0,0 +1,39 @@ +#include "avlimel.h" + +/* Forward the element struct so we can pass it to AvlTreeEl. */ +struct CustomEl; + +/* Make two base structures that will be used by + * the tree to resolve ambiguites. */ +struct CustomElBase1 : public AvliTreeEl<CustomEl> {}; +struct CustomElBase2 : public AvliTreeEl<CustomEl> {}; + +struct CustomEl : + public CustomElBase1, + public CustomElBase2, + public CmpOrd<int> +{ + /* For our purposes. */ + CustomEl(int key, const char *data) : key(key), data(data) { } + + const int getKey() { return key; } + int key; + const char *data; +}; + +int main() +{ + /* Specify to AvliMel which base to use. */ + AvliMel< CustomEl, int, CustomElBase1 > avltree1; + AvliMel< CustomEl, int, CustomElBase2 > avltree2; + + /* With AvliMel it makes the most sense to new the element ourseves + * rather than letting the tree do it for use. */ + CustomEl *avlElement = new CustomEl( 1, "CustomEl" ); + + /* These two calls are completely independant and safe. */ + avltree1.insert( avlElement ); + avltree2.insert( avlElement ); + + return 0; +} diff --git a/doc/aapl/ex_avlimelkey.cpp b/doc/aapl/ex_avlimelkey.cpp new file mode 100644 index 00000000..6545d080 --- /dev/null +++ b/doc/aapl/ex_avlimelkey.cpp @@ -0,0 +1,55 @@ +#include "avlimelkey.h" + +/* Forward the element struct so we can pass it to AvliTreeEl. */ +struct CustomEl; + +/* Make two base structures that will be used by + * the tree to resolve ambiguites. */ +struct CustomElBase1 : + public AvliTreeEl<CustomEl> +{ + CustomElBase1( int key ) : intKey(key) { } + + const int getKey() { return intKey; } + int intKey; +}; + +struct CustomElBase2 : + public AvliTreeEl<CustomEl> +{ + CustomElBase2( char *key ) : charStarKey(key) { } + + const char *getKey() { return charStarKey; } + char *charStarKey; +}; + +struct CustomEl : + public CustomElBase1, + public CustomElBase2 +{ + /* For our purposes. */ + CustomEl(int intKey, char *charStarKey, const char *data) : + CustomElBase1(intKey), + CustomElBase2(charStarKey), + data(data) { } + + const char *data; +}; + +int main() +{ + /* Specify to AvliMelKey which base element and base key to use. */ + AvliMelKey< CustomEl, int, CustomElBase1, CustomElBase1 > avltree1; + AvliMelKey< CustomEl, char*, CustomElBase2, CustomElBase2, CmpStr > avltree2; + + /* With AvliMelKey it makes the most sense to new the element ourseves + * rather than letting the tree do it for use. */ + CustomEl *avlElement = new CustomEl( 1, "strkey", "CustomEl" ); + + /* These two calls are completely independant and safe. The first + * uses the int key whereas the second uses the char* key. */ + avltree1.insert( avlElement ); + avltree2.insert( avlElement ); + + return 0; +} diff --git a/doc/aapl/ex_avliset.cpp b/doc/aapl/ex_avliset.cpp new file mode 100644 index 00000000..3e2a5c43 --- /dev/null +++ b/doc/aapl/ex_avliset.cpp @@ -0,0 +1,9 @@ +#include "avliset.h" + +int main() +{ + AvliSet< int, CmpOrd<int> > avlset; + avlset.insert( 1 ); + avlset.remove( 1 ); + return 0; +} diff --git a/doc/aapl/ex_avlitree.cpp b/doc/aapl/ex_avlitree.cpp new file mode 100644 index 00000000..40790908 --- /dev/null +++ b/doc/aapl/ex_avlitree.cpp @@ -0,0 +1,34 @@ +#include "avlitree.h" +#include <iostream> + +struct CustomEl : + public AvliTreeEl<CustomEl>, + public CmpOrd<int> +{ + /* Needed for the insert(const &Key key) routine. */ + CustomEl(int key) : key(key), data(0) { } + + /* For our purposes. */ + CustomEl(int key, const char *data) : key(key), data(data) { } + + const int getKey() { return key; } + int key; + const char *data; +}; + +int main() +{ + AvliTree<CustomEl, int> tree; + + /* This will make a new element for us. */ + tree.insert( 1 ); + + /* Here we make the element ourselves. */ + tree.insert( new CustomEl( 2, "CustomEl") ); + + for ( CustomEl *el = tree.head; el != 0; el = el->next ) + std::cout << el->key << std::endl; + + tree.empty(); + return 0; +} diff --git a/doc/aapl/ex_avlmap.cpp b/doc/aapl/ex_avlmap.cpp new file mode 100644 index 00000000..38f40cc0 --- /dev/null +++ b/doc/aapl/ex_avlmap.cpp @@ -0,0 +1,8 @@ +#include "avlmap.h" + +int main() +{ + AvlMap< char *, int, CmpStr > avlmap; + avlmap.insert( "the key", 1 ); + return 0; +} diff --git a/doc/aapl/ex_avlmel.cpp b/doc/aapl/ex_avlmel.cpp new file mode 100644 index 00000000..7e63d59d --- /dev/null +++ b/doc/aapl/ex_avlmel.cpp @@ -0,0 +1,39 @@ +#include "avlmel.h" + +/* Forward the element struct so we can pass it to AvlTreeEl. */ +struct CustomEl; + +/* Make two base structures that will be used by + * the tree to resolve ambiguites. */ +struct CustomElBase1 : public AvlTreeEl<CustomEl> {}; +struct CustomElBase2 : public AvlTreeEl<CustomEl> {}; + +struct CustomEl : + public CustomElBase1, + public CustomElBase2, + public CmpOrd<int> +{ + /* For our purposes. */ + CustomEl(int key, const char *data) : key(key), data(data) { } + + const int getKey() { return key; } + int key; + const char *data; +}; + +int main() +{ + /* Specify to AvlMel which base to use. */ + AvlMel< CustomEl, int, CustomElBase1 > avltree1; + AvlMel< CustomEl, int, CustomElBase2 > avltree2; + + /* With AvlMel it makes the most sense to new the element ourseves + * rather than letting the tree do it for use. */ + CustomEl *avlElement = new CustomEl( 1, "CustomEl" ); + + /* These two calls are completely independant and safe. */ + avltree1.insert( avlElement ); + avltree2.insert( avlElement ); + + return 0; +} diff --git a/doc/aapl/ex_avlmelkey.cpp b/doc/aapl/ex_avlmelkey.cpp new file mode 100644 index 00000000..25163a7a --- /dev/null +++ b/doc/aapl/ex_avlmelkey.cpp @@ -0,0 +1,57 @@ +#include "avlmelkey.h" + +/* Forward the element struct so we can pass it to AvlTreeEl. */ +struct CustomEl; + +/* Make two base structures that will be used by + * the tree to resolve ambiguites. */ +struct CustomElBase1 : + public AvlTreeEl<CustomEl> +{ + CustomElBase1( int key ) : intKey(key) { } + + const int getKey() { return intKey; } + int intKey; +}; + +struct CustomElBase2 : + public AvlTreeEl<CustomEl> +{ + CustomElBase2( char *key ) : charStarKey(key) { } + + const char *getKey() { return charStarKey; } + char *charStarKey; +}; + +struct CustomEl : + public CustomElBase1, + public CustomElBase2 +{ + /* For our purposes. */ + CustomEl(int intKey, char *charStarKey, const char *data) : + CustomElBase1(intKey), + CustomElBase2(charStarKey), + data(data) { } + + const char *data; +}; + +int main() +{ + /* Specify to AvlMelKey which base element and base key to use. In this + * example, both the key and the AVL tree data are in the CustomElBase + * classes. */ + AvlMelKey< CustomEl, int, CustomElBase1, CustomElBase1 > avltree1; + AvlMelKey< CustomEl, char*, CustomElBase2, CustomElBase2, CmpStr > avltree2; + + /* With AvlMelKey it makes the most sense to new the element ourseves + * rather than letting the tree do it for use. */ + CustomEl *avlElement = new CustomEl( 1, "strkey", "CustomEl" ); + + /* These two calls are completely independant and safe. The first + * uses the int key whereas the second uses the char* key. */ + avltree1.insert( avlElement ); + avltree2.insert( avlElement ); + + return 0; +} diff --git a/doc/aapl/ex_avlset.cpp b/doc/aapl/ex_avlset.cpp new file mode 100644 index 00000000..a3d35ca0 --- /dev/null +++ b/doc/aapl/ex_avlset.cpp @@ -0,0 +1,9 @@ +#include "avlset.h" + +int main() +{ + AvlSet< int, CmpOrd<int> > avlset; + avlset.insert( 1 ); + avlset.remove( 1 ); + return 0; +} diff --git a/doc/aapl/ex_avltree.cpp b/doc/aapl/ex_avltree.cpp new file mode 100644 index 00000000..b94e2798 --- /dev/null +++ b/doc/aapl/ex_avltree.cpp @@ -0,0 +1,30 @@ +#include "avltree.h" + +struct CustomEl : + public AvlTreeEl<CustomEl>, + public CmpOrd<int> +{ + /* Needed only for the insert(const &Key key) routine. */ + CustomEl(int key) : key(key), data(0) { } + + /* For our purposes. */ + CustomEl(int key, const char *data) : key(key), data(data) { } + + const int getKey() { return key; } + int key; + const char *data; +}; + +int main() +{ + AvlTree<CustomEl, int> tree; + + /* This will make a new element for us. */ + tree.insert( 1 ); + + /* Here we make the element ourselves. */ + tree.insert( new CustomEl( 2, "CustomEl") ); + + tree.empty(); + return 0; +} diff --git a/doc/aapl/ex_dlist.cpp b/doc/aapl/ex_dlist.cpp new file mode 100644 index 00000000..c7be1f3f --- /dev/null +++ b/doc/aapl/ex_dlist.cpp @@ -0,0 +1,20 @@ +#include "dlist.h" + +struct ListEl : public DListEl<ListEl> +{ + // List customizations + int data; +}; + +ListEl els[10]; + +int main() +{ + DList<ListEl> list; + + list.append( &els[0] ); + list.append( &els[1] ); + list.append( &els[2] ); + + return 0; +} diff --git a/doc/aapl/ex_dlistmel.cpp b/doc/aapl/ex_dlistmel.cpp new file mode 100644 index 00000000..e003a7d8 --- /dev/null +++ b/doc/aapl/ex_dlistmel.cpp @@ -0,0 +1,23 @@ +#include "dlistmel.h" + +struct ListEl; + +struct ListEl1 { ListEl *prev, *next; }; +struct ListEl2 { ListEl *prev, *next; }; + +struct ListEl : + public ListEl1, + public ListEl2 +{ + // Element customizations + int data; +}; + +int main() +{ + DListMel<ListEl, ListEl1> list1; + DListMel<ListEl, ListEl2> list2; + list1.append( new ListEl ); + list2.append( list1.head ); + return 0; +} diff --git a/doc/aapl/ex_dlistval.cpp b/doc/aapl/ex_dlistval.cpp new file mode 100644 index 00000000..26d05097 --- /dev/null +++ b/doc/aapl/ex_dlistval.cpp @@ -0,0 +1,17 @@ +#include "dlistval.h" + +int main() +{ + DListVal<int> list; + list.append( 1 ); + list.append( 2 ); + list.append( 3 ); + + DListVal<int>::Iter it = list; + while ( it.lte() && it->value != 2 ) + it++; + + list.remove( it.ptr ); + + return 0; +} diff --git a/doc/aapl/ex_iters.cpp b/doc/aapl/ex_iters.cpp new file mode 100644 index 00000000..e673e78e --- /dev/null +++ b/doc/aapl/ex_iters.cpp @@ -0,0 +1,37 @@ +#include <iostream> +#include "vector.h" + +struct Value +{ + Value( const int data ) + : data(data) {} + int data; + operator int() { return data; } +}; + +typedef Vector<Value> MyVect; + +int main() +{ + MyVect vector; + vector.append( Value(1) ); + vector.append( Value(2) ); + vector.append( Value(3) ); + + /* Move forward through the vector, get data directly. */ + for ( MyVect::Iter i = vector; i.lte(); i++ ) + std::cout << i->data << std::endl; + + /* Move backwards through the vector, use conversion from (Value&) to int. */ + for ( MyVect::Iter i = vector.last(); i.gtb(); i-- ) + std::cout << *i << std::endl; + + /* Find the value before value 3, iter is cast to (Value*). */ + Value *last = vector.data + 2; + MyVect::Iter i = vector; + while ( i != last ) + i.increment(); + std::cout << *(--i) << std::endl; + + return 0; +} diff --git a/doc/aapl/ex_vector.cpp b/doc/aapl/ex_vector.cpp new file mode 100644 index 00000000..b0b0dae1 --- /dev/null +++ b/doc/aapl/ex_vector.cpp @@ -0,0 +1,41 @@ +#include <iostream> +#include "vector.h" + +using namespace std; + +class Element +{ +public: + Element(const Element &o); + Element(int data); + ~Element(); + int data; +}; + +Element::Element(const Element &o) +: + data(o.data) +{ + cout << "Copy Constructor" << endl; +} + +Element::Element(int data) : data(data) +{ + cout << "Initialization Constructor" << endl; +} + +Element::~Element() +{ + cout << "Destructor" << endl; +} + +int main() +{ + Vector<Element> v; + v.append( Element(2) ); + + /* Insert 5 duplicate elements at pos 0. */ + v.prependDup( Element(1), 5 ); + + return 0; +} diff --git a/doc/aapl/footer.html b/doc/aapl/footer.html new file mode 100644 index 00000000..2753b269 --- /dev/null +++ b/doc/aapl/footer.html @@ -0,0 +1,5 @@ +<hr> +<small>© Copyright 2001-2006 Adrian Thurston</small> +</body> +</html> + diff --git a/doc/aapl/header.html b/doc/aapl/header.html new file mode 100644 index 00000000..bcc715ec --- /dev/null +++ b/doc/aapl/header.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> + <title>Aapl C++ Template Library</title> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</head> + +<body bgcolor=white> +<hr> +<center> +<a class="qindex" href="index.html">Main Page</a> +<a class="qindex" href="modules.html">Modules</a> +<a class="qindex" href="hierarchy.html">Class Hierarchy</a> +<a class="qindex" href="classes.html">Alphabetical List</a> +<a class="qindex" href="annotated.html">Compound List</a> +<a class="qindex" href="functions.html">Compound Members</a> +</center> +<hr> diff --git a/doc/aapl/mainpage.h b/doc/aapl/mainpage.h new file mode 100644 index 00000000..2092a7e7 --- /dev/null +++ b/doc/aapl/mainpage.h @@ -0,0 +1,92 @@ +/** + * \mainpage Aapl C++ Template Library + * + * \section Introduction + * + * Aapl is a C++ template library for generic programming. It contains + * implementations of %AVL Tree, Linked List, %Vector, Binary Search %Table + * and %Sort. + * + * Aapl supports different generic programming paradigms by providing + * variations of standard data structures. For example, a by-value linked list + * template may be used to store a user supplied type such as an integer. A + * different list template allows the user to define the data structure that + * is to be used as the element. A third list template allows a single + * instance of a data structure to be an element in multiple lists. + * + * Wherever possible, Aapl data structures do not depend on heap memory + * allocation. There are variations of the linked list and AVL tree that allow + * the programmer to allocate a collection of elements statically and + * insert/remove them at will. + * + * Aapl data structures do not have data members that are hidden behind a + * strict abstraction layer. Aapl makes very little use of the private + * keyword. Though data abstractions can be a useful programming technique to + * quickly produce very robust code, they can inhibit functionality when the + * data structure is the centre of much attention. Therefore Aapl leaves the + * use of abstractions up to the programmer. + * + * Browse documentation by: + * <ul> + * <li><a class="qindex" href="modules.html">Modules</a></li> + * <li><a class="qindex" href="hierarchy.html">Class Hierarchy</a></li> + * <li><a class="qindex" href="classes.html">Alphabetical List</a></li> + * <li><a class="qindex" href="annotated.html">Compound List</a></li> + * <li><a class="qindex" href="functions.html">Compound Members</a></li> + * </ul> + */ + +/** + * \defgroup iterators Iterators + * \brief Iterators for walking Aapl data structures. + * + * The Iter classes provide a simple and concise abstraction of data structure + * walking. All Aapl iterators have an identical interface. + * + * A single iterator can be used to perform forward and backward movement. + * This allows a traversal to reverse directions, provided the iterator has + * not walked off the end of the structure. All movement and data reference + * routines are valid only if the iterator already points to valid item. The + * routines lte() and gtb() can be used to ensure this. These stand + * for "less-than end" and "greater-than beginning". In Aapl iterators, "end" + * refers to the state resulting from issuing a increment operation while + * pointing to the last item and "beginning" refers to the state resulting + * from issuing a decrement operation while pointing to the first item. + * + * The negative sense of the lte() and gtb() routines are end() and beg(). + * They return true when the iterater has gone one past the last item and + * arrived at the end, or gone one past the first item and arrived at the + * beginning. To allow a traversal to stop before going off the end, the + * first() and last() routines are provided. They indicate when the iterator + * is at the first item or the last item, respectively. + * + * The element that the iterator points to can be retrieved using + * iter.ptr. Iterators also contain the implicit cast operator () which + * returns the pointer, the -> operator which also returns the pointer and the + * dereference operator * which, when applied as in *iter, returns + * *(iter.ptr). + * + * Some data structures use predefined elements that contain the user's types, + * For exampe maps and sets store the user defined key and value types. Since + * all iterators point to the data structure's element, in these cases the + * user must manually reference the key or value using either iter->key or + * iter->value. + * + * DList iterators keep a pointer to the current element and use the + * element's next and previous pointers for traversal. + * + * AvlTree iterators keep a pointer to the current tree node and traverse the + * structure in-order using the head, left and right pointers of tree nodes. + * Note that the increment and decrement operators of the AvlTree iterators + * run in O(log(N)) time. AvliTree iterators can increment and decrement in + * O(1) time because they have next and previous pointers available in the + * nodes. + * + * Vector iterators (also used for binary search tables) keep a pointer to the + * current item and walk the structure by incrementing and decrementing the + * pointer. Unlike the list and tree iterators, a Vector iterator may become + * invalid if the Vector being traversed is modified. + * + * \include ex_iters.cpp + */ + diff --git a/doc/aapl/makedummy b/doc/aapl/makedummy new file mode 100755 index 00000000..5557f083 --- /dev/null +++ b/doc/aapl/makedummy @@ -0,0 +1,24 @@ +#!/bin/sh -e +# + +# Make sure dummy dir is there. +[ -d dummy ] || mkdir dummy + +# Write dummy include files. +echo > dummy/new +echo > dummy/dlist.h +echo > dummy/compare.h +echo > dummy/assert.h +echo > dummy/vector.h +echo > dummy/svector.h +echo > dummy/table.h +echo > dummy/stdlib.h +echo > dummy/string.h +echo > dummy/dlistmel.h +echo > dummy/bstset.h +echo > dummy/bstmap.h +echo > dummy/avltree.h +echo > dummy/mergesort.h +echo > dummy/stdarg.h +echo > dummy/stdio.h +echo > dummy/iostream diff --git a/doc/aapl/makelinks b/doc/aapl/makelinks new file mode 100755 index 00000000..373885c5 --- /dev/null +++ b/doc/aapl/makelinks @@ -0,0 +1,60 @@ +#!/bin/sh -e +# + +# The location of aapl files. +PREFIX=../../aapl + +# Vector +ln -fs $PREFIX/vectcommon.h vector/vectcommon.h +ln -fs $PREFIX/vector.h vector/vector.h +ln -fs $PREFIX/svectcommon.h vector/svectcommon.h +ln -fs $PREFIX/svector.h vector/svector.h + +# AvlTree +ln -fs $PREFIX/avlcommon.h avltree/avlcommon.h +ln -fs $PREFIX/avltree.h avltree/avltree.h +ln -fs $PREFIX/avlmel.h avltree/avlmel.h +ln -fs $PREFIX/avlmelkey.h avltree/avlmelkey.h +ln -fs $PREFIX/avlmap.h avltree/avlmap.h +ln -fs $PREFIX/avlset.h avltree/avlset.h +ln -fs $PREFIX/avlbasic.h avltree/avlbasic.h +ln -fs $PREFIX/avlkeyless.h avltree/avlkeyless.h + +# AvliTree +ln -fs $PREFIX/avlcommon.h avlitree/avlcommon.h +ln -fs $PREFIX/avlitree.h avlitree/avlitree.h +ln -fs $PREFIX/avlimel.h avlitree/avlimel.h +ln -fs $PREFIX/avlimelkey.h avlitree/avlimelkey.h +ln -fs $PREFIX/avlimap.h avlitree/avlimap.h +ln -fs $PREFIX/avliset.h avlitree/avliset.h +ln -fs $PREFIX/avlibasic.h avlitree/avlibasic.h +ln -fs $PREFIX/avlikeyless.h avlitree/avlikeyless.h + +# Double List +ln -fs $PREFIX/dlcommon.h dlist/dlcommon.h +ln -fs $PREFIX/dlist.h dlist/dlist.h +ln -fs $PREFIX/dlistmel.h dlist/dlistmel.h +ln -fs $PREFIX/dlistval.h dlist/dlistval.h + +# Binary Search Table +ln -fs $PREFIX/bstcommon.h bsttable/bstcommon.h +ln -fs $PREFIX/bsttable.h bsttable/bsttable.h +ln -fs $PREFIX/bstmap.h bsttable/bstmap.h +ln -fs $PREFIX/bstset.h bsttable/bstset.h +ln -fs $PREFIX/sbsttable.h bsttable/sbsttable.h +ln -fs $PREFIX/sbstmap.h bsttable/sbstmap.h +ln -fs $PREFIX/sbstset.h bsttable/sbstset.h + +# Sorting +ln -fs $PREFIX/bubblesort.h sort/bubblesort.h +ln -fs $PREFIX/mergesort.h sort/mergesort.h +ln -fs $PREFIX/insertsort.h sort/insertsort.h +ln -fs $PREFIX/quicksort.h sort/quicksort.h + +# String +test -d string || mkdir string +ln -fs $PREFIX/astring.h string/astring.h + +# Compare +test -d compare || mkdir compare +ln -fs $PREFIX/compare.h compare/compare.h diff --git a/doc/aapl/sort/sortall.h b/doc/aapl/sort/sortall.h new file mode 100644 index 00000000..7357b52c --- /dev/null +++ b/doc/aapl/sort/sortall.h @@ -0,0 +1,9 @@ +/** + * \defgroup sort Sort + * \brief Sorting routines. + */ + +#include "insertsort.h" +#include "mergesort.h" +#include "bubblesort.h" +#include "quicksort.h" diff --git a/doc/aapl/vector/vectall.h b/doc/aapl/vector/vectall.h new file mode 100644 index 00000000..2fbdd910 --- /dev/null +++ b/doc/aapl/vector/vectall.h @@ -0,0 +1,29 @@ +/** + * \defgroup vector Vector + * \brief A dynamic array. + * + * Vector is a dynamic array capable of storing classes with non-trivial + * initialization as well as simple types such as integers and pointers. + * Vector stores items by value. Memory is managed automatically, with several + * reallocation policies available. It is also possible to use a custom + * reallocation scheme. + * + * VectSimp has the same interface as Vector and provides a + * performance improvement for types that do not have constructors or + * destructors. VectSimp uses memcpy for copying data as opposed to invoking + * copy constructors. + * + * SVector and SVectSimp are implicitly shared copy-on-write vectors. Array + * contents are shared when copied, however the actual contents are only + * duplicated when they are modified with insert, replace, append, prepend + * setAs or remove. + * + * Vector should not be used for classes that contain pointers to members or + * to self. Classes that go into vectors need to be translatable to any memory + * location. Pointers to items in a Vector should not be taken. After a + * modification of the Vector, the pointer may become invalid due to a + * required reallocation. + */ + +#include "vector.h" +#include "svector.h" |