Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/mandelbrot.git

Initial commit to new repository

AuthorDave Jarvis <email>
Date2025-04-09 23:47:38 GMT-0700
Commit81b5b770562c4024077314f86649e70015ab0ae5
Doxyfile
+# Doxyfile 1.8.15
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single 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 configuration
+# 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
+# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = Mandelbrot
+
+# 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 = 1.0.0
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "Simple Mandelbrot Set image generator"
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. 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 = docs
+
+# 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 causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = 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.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all generated output in the proper direction.
+# Possible values are: None, LTR, RTL and Context.
+# The default value is: None.
+
+OUTPUT_TEXT_DIRECTION = None
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, 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.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, 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.
+# The default value is: YES.
+
+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 and 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.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, 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
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# 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.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+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 list of 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.
+# The default value is: NO.
+
+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-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+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 behavior. 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 behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+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.
+# The default value is: NO.
+
+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.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act 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 (in the resulting output). You can put ^^ in the value part of an
+# alias to insert a newline as if a physical newline was in the original file.
+# When you need a literal { or } or , in the value part of an alias you have to
+# escape them by means of a backslash (\), this can lead to conflicts with the
+# commands \{ and \} for these it is advised to use the version @{ and @} or use
+# a double escape (\\{ and \\})
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# 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.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
+# sources only. Doxygen will then generate output that is more tailored for that
+# language. For instance, namespaces will be presented as modules, types will be
+# separated into more groups, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_SLICE = 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, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files), VHDL, tcl. 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: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 0
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# 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);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# https://www.riverbankcomputing.com/software/sip/intro) 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.
+# The default value is: NO.
+
+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 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.
+# The default value is: YES.
+
+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.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES 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.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag 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.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_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 respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+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. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. If 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, only methods in the interface are
+# included.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO 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.
+# The default value is: NO.
+
+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, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+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, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+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, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+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 then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+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.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = YES
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# 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.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES 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.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+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 constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: 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 group names will
+# appear in their defined order.
+# The default value is: NO.
+
+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 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.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = 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.
+# The default value is: YES.
+
+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.
+# The default value is: YES.
+
+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.
+# The default value is: YES.
+
+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.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+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.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# 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 value 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 value 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. For an example see the documentation.
+
+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. To 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.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag 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.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag 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.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation. If
+# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR = 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)
+# The default value is: $file:$line: $text.
+
+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 standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is 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. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+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 patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
+
+FILE_PATTERNS = *.h \
+ *.md
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# 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.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+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.
+#
+# 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
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */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.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be 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.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+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 information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# 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 that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# entity all documented functions referencing it will be listed.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES 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.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# 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 https://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES 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.
+# See also: Section \class.
+# The default value is: YES.
+
+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.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+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 a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+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.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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 left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# https://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.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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 YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = NO
+
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via Javascript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have Javascript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_MENUS = 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# 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 (see: https://developer.apple.com/xcode/), 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 https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset 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.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# 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.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_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.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# 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.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# 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.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# 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).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# 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. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+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 Qt Help Project / Virtual
+# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# 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.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+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. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# 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.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. 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.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANSPARENT 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 directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment.
+# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# 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. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: https://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+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.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
+# chosen this is overwritten by pdflatex. For specific output languages the
+# default can have been set differently, this depends on the implementation of
+# the output language.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME =
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# Note: This tag is used in the Makefile / make.bat.
+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
+# (.tex).
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+# generate index for LaTeX.
+# Note: This tag is used in the generated output file (.tex).
+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
+# The default value is: \makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_MAKEINDEX_CMD = \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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+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 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+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. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# 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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
+# path from which the emoji images will be read. If a relative path is entered,
+# it will be relative to the LATEX_OUTPUT directory. If left blank the
+# LATEX_OUTPUT directory will be used.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EMOJI_DIRECTORY =
+
+#---------------------------------------------------------------------------
+# 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 too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+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.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+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 some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# configuration file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's configuration file. A template extensions file can be
+# generated using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+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. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# 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 value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+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.
+# The default value is: NO.
+
+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.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# 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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_NS_MEMB_FILE_SCOPE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
+# the structure of the code including all documentation. Note that this feature
+# is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+
+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.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+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.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+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.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+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, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set 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.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+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.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+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.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+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 e.g.
+# 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.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+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 that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to 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.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. 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. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: 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. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+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.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+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 =
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_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.
+# The default value is: YES.
+
+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 (see:
+# http://www.graphviz.org/), 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 value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 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.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You 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.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is 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 CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+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.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is 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. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is 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. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is 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.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag 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.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+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).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# 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.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+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.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+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).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to 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.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
LICENSE
+MIT License
+
+Copyright (c) 2019 White Magic Software, Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
Makefile
+CC = clang
+CFLAGS = -O3 -Wall
+LIBS = -lgd -lpng -lz -lm -lpthread
+
+HEADERS = $(wildcard *.h)
+SOURCES = $(wildcard *.c)
+OBJECTS = $(SOURCES:.c=.o)
+
+BINARY = mandelbrot
+
+%.o: %.c $(HEADERS)
+ $(CC) -c -o $@ $< $(CFLAGS)
+
+main: $(OBJECTS)
+ $(CC) -o $(BINARY) $^ $(CFLAGS) $(LIBS)
+ strip $(BINARY)
+
+.PHONY: clean
+
+clean:
+ rm -f *.o $(BINARY)
+
README.md
+# Simple Fractal Generator
+
+Renders a fractal image.
+
+# Software Requirements
+
+Building the project requires:
+
+* [Clang](http://clang.llvm.org/) - C compiler
+* [GNU Make](https://www.gnu.org/software/make/) - Build scripting
+* [git](https://git-scm.com/) - Version control system
+
+## Libraries
+
+Third-party libraries required to build the binary include:
+
+* [glibc](https://www.gnu.org/software/libc/) - Math & Threading
+* [libgd](https://libgd.github.io/) - Graphics
+* [libpng](http://www.libpng.org/pub/png/libpng.html) - PNG format
+* [zlib](https://www.zlib.net/) - Image compressor
+
+# Build
+
+Build the project from scratch as follows:
+
+```
+mkdir -p $HOME/dev/c
+cd $HOME/dev/c
+git clone https://github.com/DaveJarvis/mandelbrot
+cd mandelbrot
+make
+```
+
+The project is built.
+
+# Run
+
+Use `./mandelbrot` to run.
+
+# Help
+
+Use `./mandelbrot --help` to display the command line options.
+
+# Result
+
+Open `out.png` to see the output.
+
SETTINGS.md
+# Settings
+This document contains reference settings for generating fractal images.
+
+## Palette
+Various colour values:
+
+* hsv(215.7,0.987,0.694) - blue
+* hsv(34.3,0.259,0.741) - dark sand
+* hsv(42.2,0.121,0.878) - light sand
+
+* rgb(198,33,104) - pantone 18-2045 TCX (pink peacock)
+* rgb(52,49,72) - pantone 19-3810 TCX (eclipse)
+
+## Paper Size
+Standard paper sizes at 300 dpi:
+
+* 8.5" x 11.0" = 2550px x 3300px
+* 18.0" x 24.0" = 5400px x 7200px
+* 24.0" x 36.0" = 7200px x 10800px
+
USAGE.md
+# Usage
+
+This document provides example usages.
+
+# Rendering
+
+Once you've explored the fractal and found coordinates and a zoom level that
+you like, use the application to generate a high-quality image. Try these:
+
+ ./mandelbrot -o default.png
+ ./mandelbrot -x -0.235125 -y 0.827215 -z 1000000 -i 10000 -o trees.png
+ ./mandelbrot -x -0.761825 -y -0.084875 -z 323500 -i 2000 -o spiral.png
+
+# Quality
+
+There are a few ways to increase the render quality, including:
+
+* Use `-s` to increase the subsample size, which controls anti-aliasing.
+Increasing this number will dramatically increase the amount of time to
+render the image. Usually a setting of 4 will suffice.
+ * 1 - The default (no anti-aliasing).
+ * 2 - Can leave visible artefact streaks.
+ * 4 - Overall smooth appearance.
+ * 9 - High-quality smoothing.
+ * 16 - Supreme smoothing.
+ * 32 - Extraordinarily smooth.
+* Use `-w` and `-h` to change the width and height.
+* Use `-i` to increase the number of iterations.
+
+# Interesting Regions
+
+[Paul Bourke](http://paulbourke.net/fractals/mandelbrot/) and
+[Alan Dewar](http://www.cuug.ab.ca/dewara/mandelbrot/Mandelbrowser.html) have
+written about some interesting regions. Regions are given by complex
+plane coordinates and a zoom level, including:
+
+| x | y | zoom |
+|---:|---:|-----:|
+| -0.170337 | -1.0650600 | 78125
+| 0.428840 | -0.2313450 | 78125
+| -1.629170 | -0.0203968 | 78125
+| -0.761574 | -0.0847596 | 78125
+| -0.746300 | 0.1102000 | 0.005
+| -0.745300 | 0.1127000 | 0.00065
+| -0.745290 | 0.1130750 | 0.00015
+| -0.745428 | 0.1130090 | 0.00003
+| -0.925000 | 0.2660000 | 0.032
+| -1.250660 | 0.0201200 | 0.00017
+
+Other settings to try:
+
+| x | y | zoom | iterations |
+|---:|---:|-----:|-----------:|
+| -0.761574 | -y -0.0847596 | 781250 | 250
+
+You will have to change their zoom levels and increase the number of
+iterations to see these areas using this application.
+
algebra.c
+#include "algebra.h"
+
+double cdot( double complex z1, double complex z2 ) {
+ double complex zbar = conj( z1 );
+ double complex z = zbar * z2;
+ return creal( z );
+}
+
algebra.h
+#ifndef H_FRACTAL_ALGEBRA
+#define H_FRACTAL_ALGEBRA
+
+#include <complex.h>
+#include <math.h>
+
+/**
+ * Returns the dot product of z1 and z2.
+ *
+ * @param z1 The first term of the dot product.
+ * @param z2 The second term of the dot product.
+ * @return z1 dot z2
+ *
+ * @see https://proofwiki.org/wiki/Definition:Dot_Product/Complex
+ */
+double cdot( double complex z1, double complex z2 );
+
+#endif
+
args.c
+#include "args.h"
+
+struct optparse_long longopts[] = {
+ { "help", '?',
+ OPTPARSE_NONE, "Show help message then exit" },
+ { "debug", 'd',
+ OPTPARSE_NONE, "Show program line numbers while running" },
+ { "version", 'V',
+ OPTPARSE_NONE, "Show version number then exit" },
+ { "verbose", 'v',
+ OPTPARSE_NONE, "Show processing steps" },
+ { "palette", 'p',
+ OPTPARSE_REQUIRED, "Palette function" opt( ARG_DEFAULT_PALETTE, "" ) },
+ { "width", 'w',
+ OPTPARSE_REQUIRED, "Image width" opt( ARG_DEFAULT_WIDTH , "px" ) },
+ { "height", 'h',
+ OPTPARSE_REQUIRED, "Image height" opt( ARG_DEFAULT_HEIGHT, "px" ) },
+ { "iterate", 'i',
+ OPTPARSE_REQUIRED, "Resolution depth" opt( ARG_DEFAULT_ITERATIONS, "" ) },
+ { "sample", 's',
+ OPTPARSE_REQUIRED, "Antialiasing" opt( ARG_DEFAULT_SAMPLES, "" ) },
+ { "threads", 't',
+ OPTPARSE_REQUIRED, "Number of threads to use" },
+ { "plot-cx", 'x',
+ OPTPARSE_REQUIRED, "Central x coordinate" opt( ARG_DEFAULT_X, "" ) },
+ { "plot-cy", 'y',
+ OPTPARSE_REQUIRED, "Central y coordinate" opt( ARG_DEFAULT_Y, "" ) },
+ { "zoom", 'z',
+ OPTPARSE_REQUIRED, "Zoom factor" opt( ARG_DEFAULT_ZOOM, "" ) },
+ { "output", 'o',
+ OPTPARSE_REQUIRED, "Image filename" opt( ARG_DEFAULT_FILENAME, "" ) },
+ { 0 }
+};
+
+void args_init( global_args *args ) {
+ args->width = ARG_DEFAULT_WIDTH;
+ args->height = ARG_DEFAULT_HEIGHT;
+ args->iterations = ARG_DEFAULT_ITERATIONS;
+ args->samples = ARG_DEFAULT_SAMPLES;
+ args->palette = ARG_DEFAULT_PALETTE;
+
+ args->cx = ARG_DEFAULT_X;
+ args->cy = ARG_DEFAULT_Y;
+ args->zoom = ARG_DEFAULT_ZOOM;
+
+ args->threads = ARG_DEFAULT_THREADS;
+ args->debug = ARG_DEFAULT_DEBUG;
+ args->verbose = ARG_DEFAULT_VERBOSE;
+ args->version = ARG_DEFAULT_VERSION;
+ args->help = ARG_DEFAULT_HELP;
+
+ args->filename = ARG_DEFAULT_FILENAME;
+}
+
+void args_parse( char **v, global_args *args ) {
+ int key = 0;
+ struct optparse options;
+ optparse_init( &options, v );
+ args_init( args );
+
+ while( (key = optparse_long(&options, longopts, NULL)) != -1 ) {
+ char *arg = options.optarg;
+
+ switch( key ) {
+ // Options that control fractal rendering parameters
+ case 'w':
+ if( arg ) args->width = atoi( arg );
+ break;
+ case 'h':
+ if( arg ) args->height = atoi( arg );
+ break;
+ case 'p':
+ if( arg ) args->palette = arg;
+ break;
+ case 'i':
+ if( arg ) args->iterations = atoi( arg );
+ break;
+ case 's':
+ if( arg ) args->samples = atoi( arg );
+ break;
+ case 'x':
+ if( arg ) args->cx = atof( arg );
+ break;
+ case 'y':
+ if( arg ) args->cy = atof( arg );
+ break;
+ case 'z':
+ if( arg ) args->zoom = atof( arg );
+ break;
+
+ // Options that affect program behaviour
+ case 'd':
+ args->debug = true;
+ break;
+ case 'o':
+ if( arg ) args->filename = arg;
+ break;
+ case 't':
+ if( arg ) args->threads = atoi( arg );
+ break;
+ case 'v':
+ args->verbose = true;
+ break;
+ case '?':
+ args->help = true;
+ break;
+ case 'V':
+ args->version = true;
+ break;
+ }
+ }
+}
+
args.h
+#ifndef H_FRACTAL_ARGS
+#define H_FRACTAL_ARGS
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+#include "optparse.h"
+
+#define UNUSED __attribute__((unused))
+
+#define ARG_UNDEFINED 0L
+
+#define ARG_DEFAULT_WIDTH 1024
+#define ARG_DEFAULT_HEIGHT 768
+#define ARG_DEFAULT_ITERATIONS 50
+#define ARG_DEFAULT_SAMPLES 1
+
+#define ARG_DEFAULT_X -0.75
+#define ARG_DEFAULT_Y 0.00
+#define ARG_DEFAULT_ZOOM 300
+
+#define ARG_DEFAULT_PALETTE "hsv(215.7,0.987,0.694)"
+
+#define ARG_DEFAULT_DEBUG false
+#define ARG_DEFAULT_VERBOSE false
+#define ARG_DEFAULT_VERSION false
+#define ARG_DEFAULT_HELP false
+
+#define ARG_DEFAULT_THREADS ARG_UNDEFINED
+#define ARG_DEFAULT_FILENAME "output.png"
+
+#define xstr(x) #x
+#define str(x) xstr(x)
+
+#define opt(x,y) " ("str(x)y")"
+
+/** List of command line arguments to parse into global_args structure. */
+extern struct optparse_long longopts[];
+
+typedef struct global_args_t {
+ /** Canvas width in pixels (-w, --width) */
+ int width;
+ /** Canvas height in pixels (-h, --height) */
+ int height;
+
+ /** How many iterations to test for escaping to infinity (-i, --iterate) */
+ int iterations;
+ /** Number of neighbouring pixels to subsample (-s, --sample) */
+ int samples;
+
+ /** Central x coordinate for fractal zoom (-x, --plot-cx) */
+ double cx;
+ /** Central y coordinate for fractal zoom (-y, --plot-cy) */
+ double cy;
+ /** Zoom into (cx, cy) by this amount (-z, --zoom) */
+ double zoom;
+
+ /** Palette colouring (-p, --palette) */
+ char *palette;
+
+ /** Output filename (-o, --output) */
+ char *filename;
+
+ /** Number of threads (-t, --threads) */
+ int threads;
+
+ /** Write extended process information (-d, --debug) */
+ bool debug;
+ /** Write process information to standard output (-v, --verbose) */
+ bool verbose;
+ /** Show version (-V, --version) */
+ bool version;
+ /** Show help (-?, --help) */
+ bool help;
+} global_args;
+
+void args_init( global_args *args );
+
+/**
+ * Sets application default values, not including the fractal configuration.
+ *
+ * @param v Unparsed command line arguments from main.
+ * @param args Parameters to control threads, output, etc.
+ */
+void args_parse( char **v, global_args *args );
+
+#endif
+
colours.c
+#include "colours.h"
+
+static const char *COLOUR_FUNC_HSV = "hsv";
+static const char *COLOUR_FUNC_RGB = "rgb";
+
+double colour_min( double a, double b, double c ) {
+ return a < b
+ ? (a < c ? a : c)
+ : (b < c ? b : c);
+}
+
+colour *colour_open( void ) {
+ return memory_open( (size_t)sizeof( colour ) );
+}
+
+void colour_close( colour *colour ) {
+ memory_close( colour );
+}
+
+void colour_parse( char *f, colour *out ) {
+ char name[3];
+ double v1;
+ double v2;
+ double v3;
+
+ // e.g., rgb(0,255,128)
+ sscanf( f, "%3s(%lf,%lf,%lf)", name, &v1, &v2, &v3 );
+
+ // The fractal rendering expects colours in HSV format.
+ if( strncmp( (const char *)name, COLOUR_FUNC_HSV, 3 ) == 0 ) {
+ out->hsv[0] = v1;
+ out->hsv[1] = v2;
+ out->hsv[2] = v3;
+ colour_hsv_to_rgb( out, out );
+ }
+ else if( strncmp( (const char *)name, COLOUR_FUNC_RGB, 3 ) == 0 ) {
+ // The user can provide an RGB format, which are first converted to HSV.
+ out->rgb[0] = v1;
+ out->rgb[1] = v2;
+ out->rgb[2] = v3;
+ colour_rgb_to_hsv( out, out );
+ }
+}
+
+void colour_hsv_to_rgb( colour *in, colour *out ) {
+ double h = in->hsv[0];
+ double s = in->hsv[1];
+ double v = in->hsv[2];
+
+ double r;
+ double g;
+ double b;
+
+ if( s <= 0.0 ) {
+ r = v;
+ g = v;
+ b = v;
+ }
+ else {
+ double hh = h >= 360.0 ? 0.0 : h / 60.0;
+ long i = (long)hh;
+ double ff = hh - i;
+ double p = v * (1.0 - s);
+ double q = v * (1.0 - (s * ff));
+ double t = v * (1.0 - (s * (1.0 - ff)));
+
+ switch( i ) {
+ case 0: r = v; g = t; b = p; break;
+ case 1: r = q; g = v; b = p; break;
+ case 2: r = p; g = v; b = t; break;
+ case 3: r = p; g = q; b = v; break;
+ case 4: r = t; g = p; b = v; break;
+ case 5:
+ default: r = v; g = p; b = q; break;
+ }
+ }
+
+ out->rgb[0] = (int)(r * 255.0);
+ out->rgb[1] = (int)(g * 255.0);
+ out->rgb[2] = (int)(b * 255.0);
+}
+
+void colour_rgb_to_hsv( colour *in, colour *out ) {
+ double r = in->rgb[0] / 255.0;
+ double g = in->rgb[1] / 255.0;
+ double b = in->rgb[2] / 255.0;
+
+ float k = 0.0;
+
+ if( g < b ) {
+ double t = g; g = b; b = t;
+ k = -1.0;
+ }
+
+ if( r < g ) {
+ double t = r; r = g; g = t;
+ k = -2.0 / 6.0 - k;
+ }
+
+ float chroma = r - min( g, b );
+ out->hsv[0] = fabs( k + (g - b) / (6.0 * chroma + 1e-20f) ) * 360;
+ out->hsv[1] = chroma / (r + 1e-20f);
+ out->hsv[2] = r;
+}
+
colours.h
+#ifndef H_FRACTAL_COLOURS
+#define H_FRACTAL_COLOURS
+
+#include <float.h>
+#include <math.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "algebra.h"
+#include "logging.h"
+#include "memory.h"
+
+/**
+ * Represents the hue, saturation, and value for a colour, as well as its
+ * RGB values.
+ */
+typedef struct colour {
+ /** Hue (0 to 360), saturation (0 to 1), and value (0 to 1). */
+ double hsv[3];
+
+ /** Red (0 to 255), green (0 to 255), and blue (0 to 255). */
+ int rgb[3];
+} colour;
+
+/**
+ * Returns the lowest value of the given parameters.
+ *
+ * @param a Compared against b.
+ * @param b Compared against a.
+ *
+ * @return The smallest value of {a, b}.
+ */
+#define min( a, b ) colour_min( a, b, DBL_MAX )
+
+/**
+ * Returns the lowest value of the given parameters.
+ *
+ * @param a Compared against b and c.
+ * @param b Compared against a and c.
+ * @param c Compared against a and b.
+ *
+ * @return The smallest value of {a, b, c}.
+ */
+double colour_min( double a, double b, double c );
+
+/**
+ * Allocates memory for a colour structure and initialises it to a default
+ * value.
+ *
+ * @return Memory allocated for a colour structure.
+ */
+colour *colour_open( void );
+
+/**
+ * Releases memory allocated to a colour structure.
+ *
+ * @param colour The reference to deallocate.
+ */
+void colour_close( colour *colour );
+
+/**
+ * Parses a colour string into its equivalent colour. The string f takes the
+ * form `hsv(h,s,v)` or `rgb(r,g,b)` where:
+ *
+ * - `f` is the colour function to parse.
+ * - `h` is the hue (0 to 360) or red (0 to 255).
+ * - `s` is the saturation (0 to 1) or green (0 to 255).
+ * - `v` is the value (0 to 1) or blue (0 to 255).
+ *
+ * @param f Function string to parse.
+ * @param out Values from f are set into this structure.
+ */
+void colour_parse( char *f, colour *out );
+
+/**
+ * Convert HSV to RGB.
+ *
+ * @param in.hsv[0] Hue between 0 and 360.
+ * @param in.hsv[1] Saturation between 0 and 1.
+ * @param in.hsv[2] Value between 0 and 1.
+ *
+ * @param out.rgb[0] Output red colour (0 to 1).
+ * @param out.rgb[1] Output green colour (0 to 1).
+ * @param out.rgb[2] Output blue colour (0 to 1).
+ *
+ * @see https://en.wikipedia.org/wiki/HSL_and_HSV
+ */
+void colour_hsv_to_rgb( colour *in, colour *out );
+
+/**
+ * Convert RGB to HSV.
+ *
+ * @param in.rgb[0] Red colour (0 to 255).
+ * @param in.rgb[1] Green colour (0 to 255).
+ * @param in.rgb[2] Blue colour (0 to 255).
+ *
+ * @param out.hsv[0] Output Hue between 0 and 360.
+ * @param out.hsv[1] Output saturation between 0 and 1.
+ * @param out.hsv[2] Output value between 0 and 1.
+ *
+ * @see https://en.wikipedia.org/wiki/HSL_and_HSV
+ */
+void colour_rgb_to_hsv( colour *in, colour *out );
+
+#endif
+
errors.c
+#include "errors.h"
+
+void error_terminate( int exit_code, char *message ) {
+ fprintf( stderr, "%s\n", message );
+ exit( exit_code );
+}
+
errors.h
+#ifndef H_FRACTAL_ERRORS
+#define H_FRACTAL_ERRORS
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdnoreturn.h>
+
+#define ERROR_MEMORY 1
+#define ERROR_MEMORY_TEXT "Out of memory"
+
+#define ERROR_THREAD 2
+#define ERROR_THREAD_TEXT "Cannot create fractal rendering threads"
+
+/**
+ * Exits the application with the given exit code.
+ *
+ * @param exit_code The program error level.
+ * @param message The reason for termination (written to standard error).
+ */
+noreturn void error_terminate( int exit_code, char *message );
+
+#endif
+
fractal.c
+#include "fractal.h"
+
+fractal_parameters *fractal_parameters_open( void ) {
+ return memory_open( (size_t)sizeof( fractal_parameters ) );
+}
+
+void fractal_parameters_init( fractal_parameters *fractal, global_args *args ) {
+ // Assign the command-line parameters to the fractal controls.
+ fractal->width = args->width;
+ fractal->height = args->height;
+ fractal->iterations = args->iterations;
+ fractal->samples = args->samples;
+
+ // Complex coordinate used for zooming into the fractal.
+ fractal->cx = args->cx;
+ fractal->cy = args->cy;
+ fractal->zoom = args->zoom;
+
+ // Initialized in main.
+ fractal->region = NULL;
+ fractal->image = NULL;
+ fractal->colour_base = NULL;
+
+ // Ensures thread-safety for random number generation, used by antialiasing.
+ random_init( fractal->random_state );
+}
+
+void fractal_parameters_validate( fractal_parameters *fractal ) {
+ if( fractal->width < 1 ) {
+ fractal->width = ARG_DEFAULT_WIDTH;
+ }
+
+ if( fractal->height < 1 ) {
+ fractal->height = ARG_DEFAULT_HEIGHT;
+ }
+
+ if( fractal->iterations < 1 ) {
+ fractal->iterations = ARG_DEFAULT_ITERATIONS;
+ }
+
+ if( fractal->samples < 1 ) {
+ fractal->samples = ARG_DEFAULT_SAMPLES;
+ }
+
+ if( fractal->zoom < 1 ) {
+ fractal->samples = ARG_DEFAULT_ZOOM;
+ }
+}
+
+void fractal_parameters_copy(
+ fractal_parameters *src, fractal_parameters *dst ) {
+
+ // Every thread needs its own copy of the fractal configuration options.
+ dst->width = src->width;
+ dst->height = src->height;
+ dst->iterations = src->iterations;
+ dst->samples = src->samples;
+
+ // Central coordinates for zooming into the fractal.
+ dst->cx = src->cx;
+ dst->cy = src->cy;
+ dst->zoom = src->zoom;
+
+ // Threads simultaneously write to this image.
+ dst->image = src->image;
+ dst->colour_base = src->colour_base;
+}
+
+void fractal_parameters_close( fractal_parameters *fractal ) {
+ memory_close( fractal );
+}
+
+bool fractal_inside( double complex c ) {
+ double absc = cabs( c );
+
+ // Used to determine whether point is inside the Mandelbrot heart shape.
+ double cardioid =
+ 256 * pow( absc, 4 ) -
+ 96 * pow( absc, 2 ) +
+ 32 * creal( c ) - 3;
+
+ // Used to determine whether point is inside the largest Mandelbrot circle.
+ double bulb = 16.0 * pow( cabs( c + 1 ), 2 ) - 1;
+
+ return cardioid < 0 || bulb < 0;
+}
+
+double fractal_distance( UNUSED int i, double complex z, double complex dC ) {
+ // Distance from "camera" to light source.
+ const double light_height = 1.5;
+
+ // Angle of light hitting the 2D surface.
+ const double light_angle = 45;
+
+ // Part of the normal calculation.
+ double complex v = cexp( 2.0 * light_angle * M_PI * (_Complex double)I );
+
+ double complex u = z / dC;
+ u = u / cabs( u );
+
+ // Determine the shading based on the surface normal.
+ double normal = cdot( u, v ) + light_height;
+ return normal / (1.0 + light_height);
+}
+
+double fractal_escape( double complex c, int power, int max_iterate ) {
+ // Escape boundary
+ const long B = 1000;
+
+ // Derivative of c
+ double complex dC = 0.0;
+ double complex z = 0.0;
+
+ double colour = 0.0;
+
+ // Loop until it is determined that z will iterate to infinity (or maximum
+ // iterations is met). This determines the boundary for the fractal's edge.
+ for( int i = 0; i < max_iterate; i++ ) {
+ dC = 2.0 * dC * z + 1.0;
+ z = cpow( z, power ) + c;
+
+ if( fractal_inside( c ) ) {
+ break;
+ }
+
+ if( cabs( z ) > B * B ) {
+ colour = fractal_distance( i, z, dC );
+ break;
+ }
+ }
+
+ return colour;
+}
+
+void *fractal_compute( void *f ) {
+ fractal_parameters *fractal = f;
+ struct region *region = fractal->region;
+
+ int i = fractal->iterations;
+ int s = fractal->samples;
+
+ // Allow the user to provide integer values as zoom parameters.
+ double z = 1 / fractal->zoom;
+ uint32_t *state = fractal->random_state;
+
+ colour colour_plot;
+
+ log_debug( "Translate coordinates to complex plane" );
+ double x_real = region->x1 * z - fractal->width / 2.0 * z + fractal->cx;
+ double y_start = region->y1 * z - fractal->height / 2.0 * z + fractal->cy;
+
+ // Area boundaries for sampling relative to real/imaginary coordinate.
+ unsigned int ssize = (unsigned int)(round( sqrt( s ) )) + 1;
+
+ log_debug( "Compute escape values for region" );
+ for( int x = region->x1; x < region->x2; x++, x_real += z ) {
+ double y_imag = y_start;
+
+ for( int y = region->y1; y < region->y2; y++, y_imag += z ) {
+ // Create complex variable c for Mandelbrot Set equation z = z^2 + c
+ double complex c = x_real + y_imag * (_Complex double)I;
+
+ // Compute the iterations (colour) from the escape.
+ double distance = fractal_escape( c, 2, i );
+ fractal_colour( distance, fractal->colour_base, &colour_plot );
+ colour_hsv_to_rgb( &colour_plot, &colour_plot );
+
+ // If antialiasing was requested...
+ if( s > 1 ) {
+ int rr = colour_plot.rgb[0];
+ int rg = colour_plot.rgb[1];
+ int rb = colour_plot.rgb[2];
+
+ // Average neighbouring pixels picked at random.
+ for( int p = 0; p < s; p++ ) {
+ double xsign = random_next( state ) % 2 ? 1 : -1;
+ double ysign = random_next( state ) % 2 ? 1 : -1;
+
+ double rx = x_real + ((random_next( state ) % ssize) * z / s) * xsign;
+ double ry = y_imag + ((random_next( state ) % ssize) * z / s) * ysign;
+
+ double complex rc = rx + ry * (_Complex double)I;
+ colour neighbour;
+
+ double rdistance = fractal_escape( rc, 2, i );
+ fractal_colour( rdistance, fractal->colour_base, &neighbour );
+ colour_hsv_to_rgb( &neighbour, &neighbour );
+ rr += neighbour.rgb[0];
+ rg += neighbour.rgb[1];
+ rb += neighbour.rgb[2];
+ }
+
+ // Determine antialiased colour by averaging randomly selected points.
+ colour_plot.rgb[0] = rr / (s + 1);
+ colour_plot.rgb[1] = rg / (s + 1);
+ colour_plot.rgb[2] = rb / (s + 1);
+ }
+
+ // Plot the pixel with or without antialiasing.
+ image_pixel( fractal->image, x, y, colour_plot );
+ }
+ }
+
+ pthread_exit( NULL );
+}
+
+void fractal_colour( double plotted, colour *base, colour *out ) {
+ if( plotted > 0 ) {
+ out->hsv[0] = 0.0;
+ out->hsv[1] = 0.0;
+ out->hsv[2] = plotted;
+ }
+ else {
+ out->hsv[0] = base->hsv[0];
+ out->hsv[1] = base->hsv[1];
+ out->hsv[2] = base->hsv[2];
+ }
+}
+
fractal.h
+#ifndef H_FRACTAL_MANDELBROT
+#define H_FRACTAL_MANDELBROT
+
+#include <complex.h>
+#include <math.h>
+#include <stdbool.h>
+#include <stdio.h>
+
+#include "algebra.h"
+#include "args.h"
+#include "colours.h"
+#include "errors.h"
+#include "image.h"
+#include "logging.h"
+#include "memory.h"
+#include "random.h"
+#include "threads.h"
+
+/**
+ * Controls how the final image appears when rendered.
+ */
+typedef struct fractal_parameters {
+ /** Canvas width in pixels. */
+ int width;
+ /** Canvas height in pixels. */
+ int height;
+
+ /** How many iterations to test for escaping to infinity. */
+ int iterations;
+ /** Number of neighbouring pixels to subsample. */
+ int samples;
+
+ /** Central x coordinate for fractal zoom. */
+ double cx;
+ /** Central y coordinate for fractal zoom. */
+ double cy;
+ /** Zoom into (cx, cy) by this amount. */
+ double zoom;
+
+ /** True colour canvas. */
+ Image image;
+
+ /** Area to draw; used by threads for embarassingly parallel work. */
+ struct region *region;
+
+ /** Colour of the Mandelbrot Set after parsing. */
+ colour *colour_base;
+
+ /** Used by the thread-safe random number generator. */
+ uint32_t random_state[ RANDOM_STATE_SIZE ];
+} fractal_parameters;
+
+/**
+ * Allocates enough memory to hold parameters for each distinct thread.
+ */
+fractal_parameters *fractal_parameters_open( void );
+
+/**
+ * Initializes memory for the fractal parameters.
+ *
+ * @param fractal The parameters used to configure the fractal.
+ * @param args Post-parsed commmand line parameters.
+ */
+void fractal_parameters_init( fractal_parameters *fractal, global_args *args );
+
+/**
+ * Ensure that all command line parameters are set to valid values.
+ */
+void fractal_parameters_validate( fractal_parameters *fractal );
+
+/**
+ * Initializes the destination parameters using the source parameters.
+ */
+void fractal_parameters_copy(
+ fractal_parameters *src, fractal_parameters *dst );
+
+/**
+ * Called to release memory allocated from thread_parameters_open.
+ */
+void fractal_parameters_close( fractal_parameters *fractal );
+
+/**
+ * Determines whether the given point is within either the main cardioid or
+ * period-2 bulb.
+ *
+ * @param c The point on the complex plane to test.
+ * @return true The given point iterates to infinity.
+ *
+ * @see https://en.wikipedia.org/wiki/fractal_set
+ * @see http://iquilezles.untergrund.net/www/articles/msets/msets.pdf
+ */
+bool fractal_inside( double complex c );
+
+/**
+ * Generates a distance for the given iteration, escape parameter, and
+ * derivative.
+ *
+ * @param i The iteration number up to max iterations.
+ * @param z The complex number that may (or may not) iterate to infinity.
+ * @param dC The derivative of c, the complex plane coordinate.
+ *
+ * @return A value used to pick a colour for the painting, or 0 for values
+ * that iterate to infinity.
+ */
+double fractal_distance( int i, double complex z, double complex dC );
+
+/**
+ * Returns a smoothed value representing the number of iterations before
+ * exiting from the iteration (to infinity).
+ *
+ * @return A number to use for colouring or 0.0 if iterated to infinity.
+ */
+double fractal_escape( double complex c, int power, int max_iterate );
+
+/**
+ * Run by a single thread to fill in part of a Mandelbrot Set image.
+ *
+ * @param f The fractal_parameters fractal controls.
+ */
+void *fractal_compute( void *f );
+
+/**
+ * Generate a colour for a point on the fractal plot.
+ *
+ * @param plotted Value returned from fractal_distance.
+ * @param base Base colour to use for Mandelbrot Set.
+ * @param out Returns red, green, and blue channels between 0 and 1.
+ */
+void fractal_colour( double plotted, colour *base, colour *out );
+
+/**
+ * Paint the image using the plotted data.
+ */
+void fractal_paint( fractal_parameters *fractal );
+
+#endif
+
image.c
+#include "image.h"
+
+#include "colours.h"
+#include "memory.h"
+
+Image image_open( int width, int height ) {
+ return gdImageCreateTrueColor( width, height );
+}
+
+struct region *image_region_open( Image image, int n, int regions ) {
+ int x1 = 0;
+ int y1 = 0;
+ int width = 0;
+ int height = 0;
+ struct region *region = memory_open( sizeof( struct region ) );
+
+ if( region != NULL ) {
+ // The parameters could have been passed in, but deriving them keeps the
+ // function prototype simpler.
+ gdImageGetClip( image, &x1, &y1, &width, &height );
+
+ // Determine the pixel area that each thread is responsible for rendering.
+ int step_size = width / regions;
+ int remainder = width - (step_size * regions);
+
+ region->x1 = step_size * n;
+
+ // Determine whether extra work is required by the last thread.
+ if( n < remainder ) {
+ // If so, lengthen the chunk and start from the corrected position.
+ step_size++;
+ region->x1 += n;
+ }
+ else {
+ // If not, start from the corrected position.
+ region->x1 += remainder;
+ }
+
+ // Will not exceed the image size.
+ region->x2 = region->x1 + step_size;
+
+ region->y1 = 0;
+ region->y2 = height;
+ }
+
+ return region;
+}
+
+void image_region_close( struct region *region ) {
+ memory_close( region );
+}
+
+void image_pixel( Image image, int x, int y, colour pixel ) {
+ // Convert three 8-bit colours to a single 24-bit ("true") colour.
+ int colour = (pixel.rgb[0] << 16) | (pixel.rgb[1] << 8) | (pixel.rgb[2]);
+
+ gdImageSetPixel( image, x, y, colour );
+}
+
+void image_save( Image image, char *filename ) {
+ FILE *fout = fopen( filename, "wb" );
+
+ if( fout != NULL ) {
+ // Persist the image.
+ gdImagePng( image, fout );
+
+ fclose( fout );
+ }
+}
+
+void image_close( Image image ) {
+ if( image != NULL ) {
+ gdImageDestroy( image );
+ }
+}
+
image.h
+#ifndef H_FRACTAL_IMAGE
+#define H_FRACTAL_IMAGE
+
+#include <math.h>
+#include <gd.h>
+
+#include "colours.h"
+
+/**
+ * Region to be painted by a thread.
+ */
+struct region {
+ /** Upper-left x coordinate. */
+ int x1;
+ /** Upper-left y coordinate. */
+ int y1;
+ /** Lower-right x coordinate. */
+ int x2;
+ /** Lower-right y coordinate. */
+ int y2;
+};
+
+/**
+ * Hides the library data type.
+ */
+typedef gdImagePtr Image;
+
+/**
+ * Opens an image of the given dimensions.
+ *
+ * @param width The number of pixels from left to right.
+ * @param height The number of pixels from top to bottom.
+ *
+ * @return Pointer to the canvas.
+ */
+Image image_open( int width, int height );
+
+/**
+ * Opens an image region boundary. The pointer to a region returned by
+ * this function must be closed using image_region_close. The regions
+ * created by this function should be non-overlapping so that individual
+ * threads can draw independently.
+ *
+ * @param image The image that was opened for drawing.
+ * @param n The region index (0 through regions - 1).
+ * @param regions The number of regions to create.
+ *
+ * @return Pointer to the region boundary.
+ */
+struct region *image_region_open( Image image, int n, int regions );
+
+/**
+ * Releases memory set aside for an image region boundary.
+ *
+ * @param region The region to deallocate.
+ */
+void image_region_close( struct region *region );
+
+/**
+ * Draw a pixel on the image at the given coordinates with the given
+ * RGB colour. This converts the 8-bit RGB triplet to a 24-bit colour.
+ *
+ * @param image Canvas for setting pixels
+ * @param x X coordinate to set a pixel
+ * @param y Y coordinate to set a pixel
+ * @param pixel Red, green, and blue channel components (0 - 255)
+ */
+void image_pixel( Image image, int x, int y, colour pixel );
+
+/**
+ * Export the given image to the specified file.
+ *
+ * @param image The painted canvas to export.
+ * @param filename Write the canvas to this file.
+ */
+void image_save( Image image, char *filename );
+
+/**
+ * Release image memory.
+ *
+ * @param image The allocated canvas memory.
+ */
+void image_close( Image image );
+
+#endif
+
logging.c
+#include "logging.h"
+
+/**
+ * Structure for controlling the application logging level.
+ */
+struct logging_log {
+ int level;
+};
+
+/** Locks logging to avoid thread contention. */
+static pthread_mutex_t lock;
+
+/**
+ * Globally available logging structure initialized to FATAL.
+ */
+static struct logging_log LOG = { LOG_FATAL };
+
+/**
+ * Human-readable strings for error messages.
+ */
+static const char *LOG_LEVELS[] = {
+ "TRACE", "DEBUG", "POSTS", "ALERT", "ERROR", "FATAL"
+};
+
+void logging_set_level( int level ) {
+ LOG.level = level;
+}
+
+__attribute__((__format__ (__printf__, 4, 0)))
+void logging_log( int level, const char *src, int line, char *message, ... ) {
+ if( level >= LOG.level ) {
+ pthread_mutex_lock( &lock );
+
+ struct timespec clock;
+ clock_gettime( CLOCK_REALTIME, &clock );
+
+ struct tm *time = localtime( &clock.tv_sec );
+
+ // Convert nanoseconds to milliseconds.
+ long millis = (long)(clock.tv_nsec / 1000000L);
+
+ // e.g., [ALERT 13:52:07.951]
+ printf( "[%s %02d:%02d:%02d.%.3ld] ",
+ LOG_LEVELS[ level ], time->tm_hour, time->tm_min, time->tm_sec, millis );
+
+ // e.g., (main.c:56)
+ if( LOG.level < LOG_POSTS ) {
+ printf( "(%s:%d) ", src, line );
+ }
+
+ // Pass along the variadic function parameters to vfprintf.
+ va_list argptr;
+ va_start( argptr, message );
+ vfprintf( stdout, message, argptr );
+ va_end( argptr );
+
+ printf( "\n" );
+
+ // Prevent threads from overlapping writes to standard out.
+ pthread_mutex_unlock( &lock );
+ }
+}
+
logging.h
+#ifndef H_FRACTAL_LOGGING
+#define H_FRACTAL_LOGGING
+
+#include <inttypes.h>
+#include <math.h>
+#include <pthread.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <time.h>
+
+/**
+ * List of log levels.
+ */
+enum { LOG_TRACE, LOG_DEBUG, LOG_POSTS, LOG_ALERT, LOG_ERROR, LOG_FATAL };
+
+#define log_trace(...) logging_log( LOG_TRACE, __FILE__, __LINE__, __VA_ARGS__ )
+#define log_debug(...) logging_log( LOG_DEBUG, __FILE__, __LINE__, __VA_ARGS__ )
+#define log_info(...) logging_log( LOG_POSTS, __FILE__, __LINE__, __VA_ARGS__ )
+#define log_warn(...) logging_log( LOG_ALERT, __FILE__, __LINE__, __VA_ARGS__ )
+#define log_error(...) logging_log( LOG_ERROR, __FILE__, __LINE__, __VA_ARGS__ )
+#define log_fatal(...) logging_log( LOG_FATAL, __FILE__, __LINE__, __VA_ARGS__ )
+
+/**
+ * Changes the logging level to give different levels of information while
+ * the program is running.
+ *
+ * @param level The new logging level.
+ */
+void logging_set_level( int level );
+
+/**
+ * Conditionally writes a message to standard output. The message will be
+ * formatted using printf, so any number of arguments afterwards are possible.
+ * Logs the source file, line number, and message if the level is above
+ * the actively set logging level.
+ *
+ * @param level One of the enumerated logging levels.
+ * @param src Name of the source file containing the logged message.
+ * @param line Line number in the source file.
+ * @param message Text to write to standard output.
+ *
+ * @see http://clang.llvm.org/docs/AttributeReference.html#format
+ */
+void logging_log( int level, const char *src, int line, char *message, ... );
+
+#endif
+
main.c
+#include "args.h"
+#include "fractal.h"
+#include "settings.h"
+
+/**
+ * Draws a fractal.
+ */
+int main( int c, char **v ) {
+ global_args args;
+ args_parse( v, &args );
+
+ settings_interpret( v, &args );
+
+ log_info( "Determine number of threads" );
+ int threads = (int)thread_cpu_count( args.threads );
+
+ fractal_parameters fractal;
+ fractal_parameters_init( &fractal, &args );
+
+ log_info( "Allocate memory for canvas" );
+ fractal.image = image_open( fractal.width, fractal.height );
+
+ log_info( "Allocate memory for fractal parameters" );
+ fractal_parameters **p =
+ memory_open( (size_t)sizeof( fractal_parameters * ) * (size_t)threads );
+
+ log_info( "Allocate memory for thread identifiers" );
+ pthread_t *thread_ids = thread_open( threads );
+
+ log_info( "Allocate memory for fractal palette" );
+ fractal.colour_base = colour_open();
+
+ log_info( "Verify memory allocations" );
+ if( fractal.colour_base == NULL ||
+ thread_ids == NULL ||
+ p == NULL ||
+ fractal.image == NULL ) {
+ colour_close( fractal.colour_base );
+ thread_close( thread_ids );
+ memory_close( p );
+ image_close( fractal.image );
+ error_terminate( ERROR_MEMORY, ERROR_MEMORY_TEXT );
+ }
+
+ log_info( "Parse base palette colour" );
+ colour_parse( args.palette, fractal.colour_base );
+
+ log_info( "Validate fractal settings" );
+ fractal_parameters_validate( &fractal );
+
+ log_info( "Setup: Canvas %d x %d pixels", fractal.width, fractal.height );
+ log_info( "Setup: (%f, %f) centre", fractal.cx, fractal.cy );
+ log_info( "Setup: %f zoom", fractal.zoom );
+ log_info( "Setup: %d threads", threads );
+ log_info( "Setup: hsv(%f, %f, %f)",
+ fractal.colour_base->hsv[0],
+ fractal.colour_base->hsv[1],
+ fractal.colour_base->hsv[2]
+ );
+
+ log_info( "Start threads to calculate escape iterations" );
+ for( int i = 0; i < threads; i++ ) {
+ fractal_parameters *worker = fractal_parameters_open();
+
+ if( worker == NULL ) {
+ // Insufficient memory; let the OS clean up the dangling pointers.
+ error_terminate( ERROR_MEMORY, ERROR_MEMORY_TEXT );
+ }
+
+ fractal_parameters_copy( &fractal, worker );
+
+ struct region *region = image_region_open( fractal.image, i, threads );
+
+ if( region == NULL ) {
+ error_terminate( ERROR_MEMORY, ERROR_MEMORY_TEXT );
+ }
+
+ worker->region = region;
+
+ // Retain a reference for free'ing memory.
+ p[i] = worker;
+
+ log_info( "Thread %03d region: (%04d, %04d)-(%04d, %04d)",
+ i, region->x1, region->y1, region->x2, region->y2 );
+
+ // Compute the iterations within a thread for a particular region.
+ if( pthread_create( &thread_ids[i], NULL, fractal_compute, worker ) ) {
+ // If pthread_create returns non-zero, then the call failed.
+ error_terminate( ERROR_THREAD, ERROR_THREAD_TEXT );
+ }
+ }
+
+ log_info( "Wait for threads to finish" );
+ for( int i = 0; i < threads; i++ ) {
+ pthread_join( thread_ids[i], NULL );
+
+ fractal_parameters *worker = p[i];
+ struct region *region = worker->region;
+
+ image_region_close( region );
+ fractal_parameters_close( worker );
+ }
+
+ log_info( "Save fractal as: %s", args.filename );
+ image_save( fractal.image, args.filename );
+
+ // Release memory in reverse order of allocation.
+ log_info( "Release memory for fractal palette" );
+ colour_close( fractal.colour_base );
+
+ log_info( "Release memory for thread identifiers" );
+ thread_close( thread_ids );
+
+ log_info( "Release memory for fractal parameters" );
+ memory_close( p );
+
+ log_info( "Release memory for canvas" );
+ image_close( fractal.image );
+
+ log_info( "Done" );
+ return 0;
+}
+
memory.c
+#include "memory.h"
+
+void *memory_open( size_t size ) {
+ return malloc( size );
+}
+
+void memory_close( void *ptr ) {
+ if( ptr != NULL ) {
+ free( ptr );
+ }
+}
+
memory.h
+#ifndef H_FRACTAL_MEMORY
+#define H_FRACTAL_MEMORY
+
+#include <stdlib.h>
+#include <stdio.h>
+
+/**
+ * Allocates the given amount of memory.
+ *
+ * @param size The number of bytes to allocate.
+ *
+ * @return NULL The memory could not be allocated.
+ */
+void *memory_open( size_t size );
+
+/**
+ * Releases memory previously allocated with memory_open.
+ *
+ * @param ptr Pointer to memory block to be closed, can be NULL.
+ */
+void memory_close( void *ptr );
+
+#endif
+
movie.sh
+#!/usr/bin/env bash
+
+# Example script to generate a sequence of still images that zooms into a
+# particular location in the fractal. These still images can be combined
+# to make a movie.
+
+# iterations
+i=250
+
+# zoom and steps
+z=781250
+z_step=2000
+
+# x, y coordinate
+x=-0.761574
+y=-0.0847596
+
+# samples
+s=4
+
+while true; do
+ f=$(printf "%07d" $z)
+ echo "Generating ($x, $y) @ $z:$i ..."
+
+ ./mandelbrot -t 128 -s $s -i $i -x $x -y $y -z $z \
+ -p "rgb(52,49,72)" -o $f.png
+
+ let z="$z+$z_step"
+ let i="$i+1"
+done
+
optparse.c
+#include "optparse.h"
+
+static int optparse_error(
+ struct optparse *options, const char *msg, const char *data) {
+ unsigned p = 0;
+ const char *sep = " -- '";
+ while (*msg)
+ options->errmsg[p++] = *msg++;
+ while (*sep)
+ options->errmsg[p++] = *sep++;
+ while (p < sizeof(options->errmsg) - 2 && *data)
+ options->errmsg[p++] = *data++;
+ options->errmsg[p++] = '\'';
+ options->errmsg[p++] = '\0';
+ return '?';
+}
+
+void optparse_init(struct optparse *options, char **argv) {
+ options->argv = argv;
+ options->permute = 1;
+ options->optind = 1;
+ options->subopt = 0;
+ options->optarg = 0;
+ options->errmsg[0] = '\0';
+}
+
+static int optparse_is_dashdash(const char *arg) {
+ return arg != 0 && arg[0] == '-' && arg[1] == '-' && arg[2] == '\0';
+}
+
+static int optparse_is_shortopt(const char *arg) {
+ return arg != 0 && arg[0] == '-' && arg[1] != '-' && arg[1] != '\0';
+}
+
+static int optparse_is_longopt(const char *arg) {
+ return arg != 0 && arg[0] == '-' && arg[1] == '-' && arg[2] != '\0';
+}
+
+static void optparse_permute(struct optparse *options, int index) {
+ char *nonoption = options->argv[index];
+ int i;
+ for (i = index; i < options->optind - 1; i++)
+ options->argv[i] = options->argv[i + 1];
+ options->argv[options->optind - 1] = nonoption;
+}
+
+static int optparse_argtype(const char *optstring, char c) {
+ int count = OPTPARSE_NONE;
+ if (c == ':')
+ return -1;
+ for (; *optstring && c != *optstring; optstring++);
+ if (!*optstring)
+ return -1;
+ if (optstring[1] == ':')
+ count += optstring[2] == ':' ? 2 : 1;
+ return count;
+}
+
+int optparse(struct optparse *options, const char *optstring) {
+ int type;
+ char *next;
+ char *option = options->argv[options->optind];
+ options->errmsg[0] = '\0';
+ options->optopt = 0;
+ options->optarg = 0;
+ if (option == 0) {
+ return -1;
+ } else if (optparse_is_dashdash(option)) {
+ options->optind++; /* consume "--" */
+ return -1;
+ } else if (!optparse_is_shortopt(option)) {
+ if (options->permute) {
+ int index = options->optind++;
+ int r = optparse(options, optstring);
+ optparse_permute(options, index);
+ options->optind--;
+ return r;
+ } else {
+ return -1;
+ }
+ }
+ option += options->subopt + 1;
+ options->optopt = option[0];
+ type = optparse_argtype(optstring, option[0]);
+ next = options->argv[options->optind + 1];
+ switch (type) {
+ case -1: {
+ char str[2] = {0, 0};
+ str[0] = option[0];
+ options->optind++;
+ return optparse_error(options, OPTPARSE_MSG_INVALID, str);
+ }
+ case OPTPARSE_NONE:
+ if (option[1]) {
+ options->subopt++;
+ } else {
+ options->subopt = 0;
+ options->optind++;
+ }
+ return option[0];
+ case OPTPARSE_REQUIRED:
+ options->subopt = 0;
+ options->optind++;
+ if (option[1]) {
+ options->optarg = option + 1;
+ } else if (next != 0) {
+ options->optarg = next;
+ options->optind++;
+ } else {
+ char str[2] = {0, 0};
+ str[0] = option[0];
+ options->optarg = 0;
+ return optparse_error(options, OPTPARSE_MSG_MISSING, str);
+ }
+ return option[0];
+ case OPTPARSE_OPTIONAL:
+ options->subopt = 0;
+ options->optind++;
+ if (option[1])
+ options->optarg = option + 1;
+ else
+ options->optarg = 0;
+ return option[0];
+ }
+ return 0;
+}
+
+char * optparse_arg(struct optparse *options) {
+ char *option = options->argv[options->optind];
+ options->subopt = 0;
+ if (option != 0)
+ options->optind++;
+ return option;
+}
+
+int optparse_longopts_end(const struct optparse_long *longopts, int i) {
+ return !longopts[i].longname && !longopts[i].shortname;
+}
+
+static void optparse_from_long(
+ const struct optparse_long *longopts,
+ char *optstring) {
+ char *p = optstring;
+ int i;
+ for (i = 0; !optparse_longopts_end(longopts, i); i++) {
+ if (longopts[i].shortname) {
+ int a;
+ *p++ = longopts[i].shortname;
+ for (a = 0; a < (int)longopts[i].argtype; a++)
+ *p++ = ':';
+ }
+ }
+ *p = '\0';
+}
+
+static int optparse_longopts_match(const char *longname, const char *option) {
+ const char *a = option, *n = longname;
+ if (longname == 0)
+ return 0;
+ for (; *a && *n && *a != '='; a++, n++)
+ if (*a != *n)
+ return 0;
+ return *n == '\0' && (*a == '\0' || *a == '=');
+}
+
+static char * optparse_longopts_arg(char *option) {
+ for (; *option && *option != '='; option++);
+
+ if (*option == '=')
+ return option + 1;
+
+ return 0;
+}
+
+static int optparse_long_fallback(
+ struct optparse *options,
+ const struct optparse_long *longopts,
+ int *longindex) {
+ int result;
+ char optstring[96 * 3 + 1]; /* 96 ASCII printable characters */
+ optparse_from_long(longopts, optstring);
+ result = optparse(options, optstring);
+ if (longindex != 0) {
+ *longindex = -1;
+ if (result != -1) {
+ int i;
+ for (i = 0; !optparse_longopts_end(longopts, i); i++)
+ if (longopts[i].shortname == options->optopt)
+ *longindex = i;
+ }
+ }
+ return result;
+}
+
+int optparse_long(
+ struct optparse *options,
+ const struct optparse_long *longopts,
+ int *longindex) {
+ int i;
+ char *option = options->argv[options->optind];
+ if (option == 0) {
+ return -1;
+ } else if (optparse_is_dashdash(option)) {
+ options->optind++; /* consume "--" */
+ return -1;
+ } else if (optparse_is_shortopt(option)) {
+ return optparse_long_fallback(options, longopts, longindex);
+ } else if (!optparse_is_longopt(option)) {
+ if (options->permute) {
+ int index = options->optind++;
+ int r = optparse_long(options, longopts, longindex);
+ optparse_permute(options, index);
+ options->optind--;
+ return r;
+ } else {
+ return -1;
+ }
+ }
+
+ /* Parse as long option. */
+ options->errmsg[0] = '\0';
+ options->optopt = 0;
+ options->optarg = 0;
+ option += 2; /* skip "--" */
+ options->optind++;
+ for (i = 0; !optparse_longopts_end(longopts, i); i++) {
+ const char *name = longopts[i].longname;
+ if (optparse_longopts_match(name, option)) {
+ char *arg;
+ if (longindex)
+ *longindex = i;
+ options->optopt = longopts[i].shortname;
+ arg = optparse_longopts_arg(option);
+ if (longopts[i].argtype == OPTPARSE_NONE && arg != 0) {
+ return optparse_error(options, OPTPARSE_MSG_TOOMANY, name);
+ } if (arg != 0) {
+ options->optarg = arg;
+ } else if (longopts[i].argtype == OPTPARSE_REQUIRED) {
+ options->optarg = options->argv[options->optind];
+ if (options->optarg == 0)
+ return optparse_error(options, OPTPARSE_MSG_MISSING, name);
+ else
+ options->optind++;
+ }
+ return options->optopt;
+ }
+ }
+ return optparse_error(options, OPTPARSE_MSG_INVALID, option);
+}
+
optparse.h
+/*
+ * Optparse is a public domain, portable, reentrant, embeddable,
+ * getopt-like option parser. It's a single header file and can be
+ * trivially dropped into any project. It supports POSIX getopt option
+ * strings, GNU-style long options, argument permutation, and
+ * subcommand processing.
+ *
+ * @see https://github.com/skeeto/optparse
+ * @author Christopher Wellons
+ */
+#ifndef H_FRACTAL_OPTPARSE
+#define H_FRACTAL_OPTPARSE
+
+/** Unknown command-line argument provided. */
+#define OPTPARSE_MSG_INVALID "invalid option"
+/** Missing command-line argument option . */
+#define OPTPARSE_MSG_MISSING "option requires an argument"
+/** Command-line argument given option, none expected. */
+#define OPTPARSE_MSG_TOOMANY "option takes no arguments"
+
+struct optparse {
+ char **argv;
+ int permute;
+ int optind;
+ int optopt;
+ char *optarg;
+ char errmsg[64];
+ int subopt;
+};
+
+enum optparse_argtype {
+ OPTPARSE_NONE,
+ OPTPARSE_REQUIRED,
+ OPTPARSE_OPTIONAL
+};
+
+struct optparse_long {
+ const char *longname;
+ int shortname;
+ enum optparse_argtype argtype;
+ const char *description;
+};
+
+/**
+ * Initializes the parser state.
+ */
+void optparse_init(struct optparse *options, char **argv);
+
+/**
+ * Read the next option in the argv array.
+ * @param options state structure for thread-safe execution.
+ * @param optstring a getopt()-formatted option string.
+ * @return the next option character, -1 for done, or '?' for error
+ *
+ * Just like getopt(), a character followed by no colons means no
+ * argument. One colon means the option has a required argument. Two
+ * colons means the option takes an optional argument.
+ */
+int optparse(struct optparse *options, const char *optstring);
+
+/**
+ * Handles GNU-style long options in addition to getopt() options.
+ * This works a lot like GNU's getopt_long(). The last option in
+ * longopts must be all zeros, marking the end of the array. The
+ * longindex argument may be NULL.
+ */
+int optparse_long(struct optparse *options,
+ const struct optparse_long *longopts,
+ int *longindex);
+
+/**
+ * Determines whether the given index into the long options is valid.
+ *
+ * @return !0 The indexed reference has no set values.
+ */
+int optparse_longopts_end(const struct optparse_long *longopts, int i);
+
+/**
+ * Used for stepping over non-option arguments.
+ * @return the next non-option argument, or NULL for no more arguments
+ *
+ * Argument parsing can continue with optparse() after using this
+ * function. That would be used to parse the options for the
+ * subcommand returned by optparse_arg(). This function allows you to
+ * ignore the value of optind.
+ */
+char *optparse_arg(struct optparse *options);
+
+#endif
random.c
+#include "random.h"
+
+void random_init( uint32_t state[ static RANDOM_STATE_SIZE ] ) {
+ // Seed with any value (e.g., i^i).
+ state[ 0 ] = 2078795764;
+
+ for( int i = 1; i < RANDOM_STATE_SIZE; i++ ) {
+ state[ i ] = random_seed( state[ i -1 ] );
+ }
+}
+
+uint32_t random_seed( uint32_t x ) {
+ uint32_t z = (x += 0x6D2B79F5UL);
+ z = (z ^ (z >> 15)) * (z | 1UL);
+ z ^= z + (z ^ (z >> 7)) * (z | 61UL);
+ return z ^ (z >> 14);
+}
+
+uint32_t random_next( uint32_t state[ static RANDOM_STATE_SIZE ] ) {
+ uint32_t s, t = state[3];
+ state[3] = state[2];
+ state[2] = state[1];
+ state[1] = s = state[0];
+ t ^= t >> 2;
+ t ^= t << 1;
+ state[0] = t ^= s ^ (s << 4);
+ return t + (state[4] += 362437);
+}
+
random.h
+#ifndef H_FRACTAL_RANDOM
+#define H_FRACTAL_RANDOM
+
+#include <stdint.h>
+#include <string.h>
+
+#define RANDOM_STATE_SIZE 5
+
+/**
+ * Populates the random number generator seeds.
+ *
+ * @param state Seeded with non-zero values.
+ */
+void random_init( uint32_t state[ static RANDOM_STATE_SIZE ] );
+
+/**
+ * Algorithm "Mulberry32".
+ *
+ * @param x The value to use to generate a random seed.
+ *
+ * @return A randomized value for use with random_init.
+ *
+ * @author Tommy Ettinger
+ */
+uint32_t random_seed( uint32_t x );
+
+/**
+ * Algorithm "xorwow".
+ *
+ * @param state Seed with non-zero values (call random_init).
+ *
+ * @return A pseudo-random number.
+ *
+ * @author George Marsaglia
+ */
+uint32_t random_next( uint32_t state[ static RANDOM_STATE_SIZE ] );
+
+#endif
+
settings.c
+#include "settings.h"
+
+/** Program name is displayed when help is requested. */
+const char *PROGRAM_NAME = "A fractal image generator";
+/** Version number is displayed when help is requested. */
+const char *PROGRAM_VERSION = "1.0.0";
+/** Repository link is displayed when help requested. */
+const char *PROGRAM_ISSUES = "https://github.com/DaveJarvis/mandelbrot/issues";
+
+void settings_interpret( char **v, global_args *args ) {
+ if( args->verbose ) {
+ logging_set_level( LOG_POSTS );
+ }
+
+ // Debug level also includes verbose level.
+ if( args->debug ) {
+ logging_set_level( LOG_DEBUG );
+ }
+
+ if( args->version ) {
+ settings_show_version();
+ settings_terminate( SETTINGS_EXIT_LEVEL_VERSION );
+ }
+
+ if( args->help ) {
+ settings_show_help( v[0] );
+ settings_terminate( SETTINGS_EXIT_LEVEL_HELP );
+ }
+}
+
+noreturn void settings_terminate( int exit_level ) {
+ exit( exit_level );
+}
+
+void settings_show_version( void ) {
+ printf( "%s\n", PROGRAM_VERSION );
+}
+
+void settings_show_help( char *program ) {
+ printf( "%s\n\n", PROGRAM_NAME );
+ printf( "Usage: %s [OPTION...]\n", program );
+ printf( "Where [OPTION] includes:\n" );
+
+ for( int i = 0; !optparse_longopts_end( longopts, i ); i++) {
+ const struct optparse_long *opt = &longopts[i];
+ printf( " -%c, --%-10s %s\n",
+ opt->shortname, opt->longname, opt->description );
+ }
+
+ printf( "\nReport issues at: %s\n", PROGRAM_ISSUES );
+}
+
settings.h
+#ifndef H_FRACTAL_SETTINGS
+#define H_FRACTAL_SETTINGS
+
+#include <stdnoreturn.h>
+
+#include "args.h"
+#include "logging.h"
+#include "optparse.h"
+
+#define SETTINGS_EXIT_LEVEL_VERSION 2
+#define SETTINGS_EXIT_LEVEL_HELP 3
+
+/**
+ * Responsible for interpreting post-parsed command line parameters. This
+ * will set the log level, show help, show version information, etc.
+ *
+ * @param argv The command line arguments before processing.
+ * @param args The command line arguments structure.
+ */
+void settings_interpret( char **argv, global_args *args );
+
+/**
+ * Exits the application, nothing written to the console.
+ *
+ * @param exit_level Program exit level.
+ */
+noreturn void settings_terminate( int exit_level );
+
+/**
+ * Write the version number to standard output then exit.
+ */
+void settings_show_version( void );
+
+/**
+ * Write usage to standard output then exit.
+ *
+ * @param program Name of the program being run (argsv[0]).
+ */
+void settings_show_help( char *program );
+
+#endif
+
threads.c
+#include "threads.h"
+
+pthread_t *thread_open( int threads ) {
+ return memory_open( (size_t)sizeof( pthread_t ) * (size_t)threads );
+}
+
+void thread_close( pthread_t *thread_ids ) {
+ memory_close( thread_ids );
+}
+
+long thread_cpu_count( long default_value ) {
+ // If no thread count has been set, use all available CPUs.
+ return default_value == ARG_UNDEFINED ?
+ sysconf( _SC_NPROCESSORS_ONLN ) :
+ default_value;
+}
+
threads.h
+#ifndef H_FRACTAL_THREADS
+#define H_FRACTAL_THREADS
+
+#include <pthread.h>
+#include <unistd.h>
+
+#include "args.h"
+#include "memory.h"
+
+/**
+ * Returns memory for storing a list of thread IDs.
+ *
+ * @param threads The number of threads to use.
+ *
+ * @return A pointer to the thread identifier structure.
+ */
+pthread_t *thread_open( int threads );
+
+/**
+ * Deallocates memory for thread IDs.
+ *
+ * @param thread_ids Reference to the value returned by thread_open(int).
+ */
+void thread_close( pthread_t *thread_ids );
+
+/**
+ * Returns the number of processors available, or the default value if
+ * set. On an octocore processor, 128 threads seems to be optimal.
+ *
+ * @param default_value Number of threads to use; set to DEFAULT_UNDEFINED to
+ * use the active number of CPUs.
+ *
+ * @return The number of threads or CPUs to use.
+ */
+long thread_cpu_count( long default_value );
+
+#endif
+
Delta4507 lines added, 0 lines removed, 4507-line increase