diff --git a/.gitignore b/.gitignore
index 6ebc1f5d11e2158e895383297863436b651309f1..c1e09d2e36074cd6cea7aaf6edc06becf5a826c3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,7 +2,7 @@
.vscode/
build*/
bin*/
-logs/
+doc/
dist/
CMakeLists.txt.user*
*.autosave
@@ -33,4 +33,4 @@ env/
venv/
*.pyd
*.so
-_b_asic_debug_log.txt
\ No newline at end of file
+_b_asic_debug_log.txt
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 85ecb3db700070ccf262b61002b8d8bf927e856a..3f8304e375e1442932b0cf79e2855505c74690d3 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.8)
project(
"B-ASIC"
- VERSION 0.0.1
+ VERSION 1.0.0
DESCRIPTION "Better ASIC Toolbox for Python 3"
LANGUAGES C CXX
)
@@ -98,4 +98,4 @@ if(NOT ASIC_BUILDING_PYTHON_DISTRIBUTION)
COMMENT "Copying binaries to ${CMAKE_CURRENT_LIST_DIR}"
DEPENDS "${TARGET_NAME}"
)
-endif()
\ No newline at end of file
+endif()
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000000000000000000000000000000000000..6ee7c4a5c8fbda53c512e45642de09d3ef65ff16
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,2553 @@
+# Doxyfile 1.8.18
+
+# 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 = "B-ASIC"
+
+# 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 =
+
+# 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 = "Better ASIC Toolbox for Python 3"
+
+# 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 = "logo_tiny.png"
+
+# 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 = "doc"
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise 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 = NO
+
+# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
+# such as
+# /***************
+# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
+# Javadoc-style will behave just like regular comments and it will not be
+# interpreted by doxygen.
+# The default value is: NO.
+
+JAVADOC_BANNER = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the 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 =
+
+# 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 = NO
+
+# 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 = YES
+
+# 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, VHDL,
+# 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). 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: 5.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 5
+
+# 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 = NO
+
+# 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_PRIV_VIRTUAL tag is set to YES, documented private virtual
+# methods of a class will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIV_VIRTUAL = 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
+# 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
+# (including Cygwin) ands Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = YES
+
+# 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 = NO
+
+# 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 = b_asic
+
+# 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 (to be provided as doxygen C comment),
+# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
+# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
+# *.vhdl, *.ucf, *.qsf and *.ice.
+
+FILE_PATTERNS = *.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 \
+ *.doc \
+ *.txt \
+ *.py \
+ *.pyw \
+ *.f90 \
+ *.f95 \
+ *.f03 \
+ *.f08 \
+ *.f18 \
+ *.f \
+ *.for \
+ *.vhd \
+ *.vhdl \
+ *.ucf \
+ *.qsf \
+ *.ice
+
+# 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: https://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: https://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: https://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: https://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:
+# https://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 = NO
+
+# 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
+
+# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
+# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
+# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
+# the HTML output. These images will generally look nicer at scaled resolutions.
+# Possible values are: png The default and svg Looks nicer but requires the
+# pdf2svg tool.
+# The default value is: png.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FORMULA_FORMAT = png
+
+# 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
+
+# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
+# to create new LaTeX commands to be used in formulas as building blocks. See
+# the section "Including formulas" for details.
+
+FORMULA_MACROFILE =
+
+# 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://cdn.jsdelivr.net/npm/mathjax@2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
+
+# 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 = YES
+
+# 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 = YES
+
+# 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. In case there is no backslash (\) as first character
+# it will be automatically added in the LaTeX code.
+# 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
+
+#---------------------------------------------------------------------------
+# 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 = YES
+
+# 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
diff --git a/README.md b/README.md
index b2972f30828f19038e5efe612831f989b8f5ffd5..db11db76c8a3053acb05f3430f2b19a4aedee5a5 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,12 @@ How to build and debug the library during development.
### Prerequisites
The following packages are required in order to build the library:
-* C++:
- * cmake 3.8+
- * gcc 7+/clang 7+/msvc 16+
- * fmtlib 5.2.1+
- * pybind11 2.3.0+
+* cmake 3.8+
+* gcc 7+/clang 7+/msvc 16+
+* fmtlib
+* pybind11 2.3.0+
+* python 3.6+
* Python:
- * python 3.6+
* setuptools
* pybind11
* numpy
@@ -28,6 +27,9 @@ To run the test suite, the following additional packages are required:
* Python:
* pytest
* pytest-cov (for testing with coverage)
+
+To generate the documentation, the following additional packages are required:
+* doxygen
### Using CMake directly
How to build using CMake.
@@ -109,6 +111,13 @@ pytest
pytest --cov=b_asic --cov-report html test
```
+### Generating documentation
+In `B-ASIC`:
+```
+doxygen
+```
+The output gets written to `B-ASIC/doc`.
+
## Usage
How to build and use the library as a user.
diff --git a/b_asic/GUI/__init__.py b/b_asic/GUI/__init__.py
index 0b0902af19e41d0855dd13d5cea45ceb950a082b..f330b58905bbebb411b1c96f877955b7ef644e28 100644
--- a/b_asic/GUI/__init__.py
+++ b/b_asic/GUI/__init__.py
@@ -1,6 +1,6 @@
-"""
-Better ASIC Toolbox GUI.
-TODO: More info.
+"""B-ASIC GUI Module.
+
+Graphical user interface for B-ASIC.
"""
from b_asic.GUI.main_window import *
from b_asic.GUI.about_window import *
diff --git a/b_asic/GUI/drag_button.py b/b_asic/GUI/drag_button.py
index d300315f0217f203bf1c849ce04d614fddfc87e1..a1d8118e094bd80d9c37c838e56b6746969b4453 100644
--- a/b_asic/GUI/drag_button.py
+++ b/b_asic/GUI/drag_button.py
@@ -1,6 +1,6 @@
-"""@package docstring
-Drag button class.
-This class creates a dragbutton which can be clicked, dragged and dropped.
+"""B-ASIC Drag Button Module.
+
+Contains a GUI class for drag buttons.
"""
import os.path
@@ -15,9 +15,15 @@ from PySide2.QtGui import QIcon
@decorate_class(handle_error)
class DragButton(QPushButton):
+ """Drag button class.
+
+ This class creates a drag button which can be clicked, dragged and dropped.
+ """
+
connectionRequested = Signal(QPushButton)
moved = Signal()
- def __init__(self, name, operation, operation_path_name, is_show_name, window, parent = None):
+
+ def __init__(self, name, operation, operation_path_name, is_show_name, window, parent=None):
self.name = name
self.ports = []
self.is_show_name = is_show_name
@@ -67,7 +73,8 @@ class DragButton(QPushButton):
if button is self:
continue
- button.move(button.mapToParent(event.pos() - self._mouse_press_pos))
+ button.move(button.mapToParent(
+ event.pos() - self._mouse_press_pos))
self._window.scene.update()
self._window.graphic_view.update()
@@ -92,7 +99,8 @@ class DragButton(QPushButton):
self.pressed = not pressed
self.setStyleSheet(f"background-color: {'white' if not self.pressed else 'grey'}; border-style: solid;\
border-color: black; border-width: 2px")
- path_to_image = os.path.join(os.path.dirname(__file__), 'operation_icons', f"{self.operation_path_name}{'_grey.png' if self.pressed else '.png'}")
+ path_to_image = os.path.join(os.path.dirname(
+ __file__), 'operation_icons', f"{self.operation_path_name}{'_grey.png' if self.pressed else '.png'}")
self.setIcon(QIcon(path_to_image))
self.setIconSize(QSize(55, 55))
@@ -115,22 +123,27 @@ class DragButton(QPushButton):
signal.update()
def remove(self):
- self._window.logger.info(f"Removing operation with name {self.operation.name}.")
- self._window.scene.removeItem(self._window.dragOperationSceneDict[self])
+ self._window.logger.info(
+ f"Removing operation with name {self.operation.name}.")
+ self._window.scene.removeItem(
+ self._window.dragOperationSceneDict[self])
_signals = []
for signal, ports in self._window.signalPortDict.items():
if any(map(lambda port: set(port).intersection(set(self._window.portDict[self])), ports)):
- self._window.logger.info(f"Removed signal with name: {signal.signal.name} to/from operation: {self.operation.name}.")
+ self._window.logger.info(
+ f"Removed signal with name: {signal.signal.name} to/from operation: {self.operation.name}.")
_signals.append(signal)
for signal in _signals:
signal.remove()
if self in self._window.opToSFG:
- self._window.logger.info(f"Operation detected in existing sfg, removing sfg with name: {self._window.opToSFG[self].name}.")
+ self._window.logger.info(
+ f"Operation detected in existing sfg, removing sfg with name: {self._window.opToSFG[self].name}.")
del self._window.sfg_dict[self._window.opToSFG[self].name]
- self._window.opToSFG = {op: self._window.opToSFG[op] for op in self._window.opToSFG if self._window.opToSFG[op] is not self._window.opToSFG[self]}
+ self._window.opToSFG = {
+ op: self._window.opToSFG[op] for op in self._window.opToSFG if self._window.opToSFG[op] is not self._window.opToSFG[self]}
for port in self._window.portDict[self]:
if port in self._window.pressed_ports:
diff --git a/b_asic/GUI/main_window.py b/b_asic/GUI/main_window.py
index 5c78e69d8ba78ec43f417af2f6b106c06909f194..630e4af04affe5be9e84559d52d58ec99092bf41 100644
--- a/b_asic/GUI/main_window.py
+++ b/b_asic/GUI/main_window.py
@@ -1,8 +1,33 @@
-"""@package docstring
-B-ASIC GUI Module.
-This python file is the main window of the GUI for B-ASIC.
+"""B-ASIC Main Window Module.
+
+This file opens the main window of the GUI for B-ASIC when run.
"""
+from tkinter.filedialog import askopenfilename, askopenfile
+from tkinter import Tk
+from PySide2.QtGui import QIcon, QFont, QPainter, QPen, QBrush, QKeySequence
+from PySide2.QtCore import Qt, QSize, QFileInfo
+from PySide2.QtWidgets import QApplication, QWidget, QMainWindow, QLabel, QAction,\
+ QStatusBar, QMenuBar, QLineEdit, QPushButton, QSlider, QScrollArea, QVBoxLayout,\
+ QHBoxLayout, QDockWidget, QToolBar, QMenu, QLayout, QSizePolicy, QListWidget,\
+ QListWidgetItem, QGraphicsView, QGraphicsScene, QShortcut, QGraphicsTextItem,\
+ QGraphicsProxyWidget, QInputDialog, QTextEdit, QFileDialog
+from numpy import linspace
+from b_asic.save_load_structure import *
+from select_sfg_window import SelectSFGWindow
+from simulate_sfg_window import SimulateSFGWindow, Plot
+from utils import decorate_class, handle_error
+import b_asic.special_operations as s_oper
+import b_asic.core_operations as c_oper
+from b_asic import Operation, SFG, InputPort, OutputPort, Input, Output, FastSimulation
+from b_asic.simulation import Simulation
+from show_pc_window import ShowPCWindow
+from port_button import PortButton
+from arrow import Arrow
+from gui_interface import Ui_main_window
+from drag_button import DragButton
+from about_window import AboutWindow, FaqWindow, KeybindsWindow
+import sys
from pprint import pprint
from os import getcwd, path
import importlib
@@ -32,10 +57,10 @@ from b_asic.save_load_structure import *
from numpy import linspace
from PySide2.QtWidgets import QApplication, QWidget, QMainWindow, QLabel, QAction,\
-QStatusBar, QMenuBar, QLineEdit, QPushButton, QSlider, QScrollArea, QVBoxLayout,\
-QHBoxLayout, QDockWidget, QToolBar, QMenu, QLayout, QSizePolicy, QListWidget,\
-QListWidgetItem, QGraphicsView, QGraphicsScene, QShortcut, QGraphicsTextItem,\
-QGraphicsProxyWidget, QInputDialog, QTextEdit, QFileDialog
+ QStatusBar, QMenuBar, QLineEdit, QPushButton, QSlider, QScrollArea, QVBoxLayout,\
+ QHBoxLayout, QDockWidget, QToolBar, QMenu, QLayout, QSizePolicy, QListWidget,\
+ QListWidgetItem, QGraphicsView, QGraphicsScene, QShortcut, QGraphicsTextItem,\
+ QGraphicsProxyWidget, QInputDialog, QTextEdit, QFileDialog
from PySide2.QtCore import Qt, QSize, QFileInfo
from PySide2.QtGui import QIcon, QFont, QPainter, QPen, QBrush, QKeySequence
@@ -69,11 +94,15 @@ class MainWindow(QMainWindow):
self._window = self
self.logger = logging.getLogger(__name__)
self.init_ui()
- self.add_operations_from_namespace(c_oper, self.ui.core_operations_list)
- self.add_operations_from_namespace(s_oper, self.ui.special_operations_list)
-
- self.shortcut_core = QShortcut(QKeySequence("Ctrl+R"), self.ui.operation_box)
- self.shortcut_core.activated.connect(self._refresh_operations_list_from_namespace)
+ self.add_operations_from_namespace(
+ c_oper, self.ui.core_operations_list)
+ self.add_operations_from_namespace(
+ s_oper, self.ui.special_operations_list)
+
+ self.shortcut_core = QShortcut(
+ QKeySequence("Ctrl+R"), self.ui.operation_box)
+ self.shortcut_core.activated.connect(
+ self._refresh_operations_list_from_namespace)
self.scene.selectionChanged.connect(self._select_operations)
self.move_button_index = 0
@@ -90,9 +119,12 @@ class MainWindow(QMainWindow):
self.ui.faqBASIC.triggered.connect(self.display_faq_page)
self.ui.aboutBASIC.triggered.connect(self.display_about_page)
self.ui.keybindsBASIC.triggered.connect(self.display_keybinds_page)
- self.ui.core_operations_list.itemClicked.connect(self.on_list_widget_item_clicked)
- self.ui.special_operations_list.itemClicked.connect(self.on_list_widget_item_clicked)
- self.ui.custom_operations_list.itemClicked.connect(self.on_list_widget_item_clicked)
+ self.ui.core_operations_list.itemClicked.connect(
+ self.on_list_widget_item_clicked)
+ self.ui.special_operations_list.itemClicked.connect(
+ self.on_list_widget_item_clicked)
+ self.ui.custom_operations_list.itemClicked.connect(
+ self.on_list_widget_item_clicked)
self.ui.save_menu.triggered.connect(self.save_work)
self.ui.load_menu.triggered.connect(self.load_work)
self.ui.load_operations.triggered.connect(self.add_namespace)
@@ -107,7 +139,8 @@ class MainWindow(QMainWindow):
self.shortcut_signal.activated.connect(self._connect_button)
self.logger.info("Finished setting up GUI")
- self.logger.info("For questions please refer to 'Ctrl+?', or visit the 'Help' section on the toolbar.")
+ self.logger.info(
+ "For questions please refer to 'Ctrl+?', or visit the 'Help' section on the toolbar.")
def init_ui(self):
self.create_toolbar_view()
@@ -117,7 +150,8 @@ class MainWindow(QMainWindow):
self.scene = QGraphicsScene(self)
self.graphic_view = QGraphicsView(self.scene, self)
self.graphic_view.setRenderHint(QPainter.Antialiasing)
- self.graphic_view.setGeometry(self.ui.operation_box.width(), 20, self.width(), self.height())
+ self.graphic_view.setGeometry(
+ self.ui.operation_box.width(), 20, self.width(), self.height())
self.graphic_view.setDragMode(QGraphicsView.RubberBandDrag)
def create_toolbar_view(self):
@@ -126,8 +160,10 @@ class MainWindow(QMainWindow):
self.toolbar.addAction("Clear Workspace", self.clear_workspace)
def resizeEvent(self, event):
- self.ui.operation_box.setGeometry(10, 10, self.ui.operation_box.width(), self.height())
- self.graphic_view.setGeometry(self.ui.operation_box.width() + 20, 60, self.width() - self.ui.operation_box.width() - 20, self.height()-30)
+ self.ui.operation_box.setGeometry(
+ 10, 10, self.ui.operation_box.width(), self.height())
+ self.graphic_view.setGeometry(self.ui.operation_box.width(
+ ) + 20, 60, self.width() - self.ui.operation_box.width() - 20, self.height()-30)
super(MainWindow, self).resizeEvent(event)
def wheelEvent(self, event):
@@ -158,13 +194,16 @@ class MainWindow(QMainWindow):
self.logger.info(f"Saving sfg to path: {module}.")
operation_positions = dict()
for operation_drag, operation_scene in self.dragOperationSceneDict.items():
- operation_positions[operation_drag.operation.graph_id] = (operation_scene.x(), operation_scene.y())
+ operation_positions[operation_drag.operation.graph_id] = (
+ operation_scene.x(), operation_scene.y())
try:
with open(module, "w+") as file_obj:
- file_obj.write(sfg_to_python(sfg, suffix=f"positions = {str(operation_positions)}"))
+ file_obj.write(sfg_to_python(
+ sfg, suffix=f"positions = {str(operation_positions)}"))
except Exception as e:
- self.logger.error(f"Failed to save sfg to path: {module}, with error: {e}.")
+ self.logger.error(
+ f"Failed to save sfg to path: {module}, with error: {e}.")
return
self.logger.info(f"Saved sfg to path: {module}.")
@@ -185,25 +224,31 @@ class MainWindow(QMainWindow):
try:
sfg, positions = python_to_sfg(module)
except ImportError as e:
- self.logger.error(f"Failed to load module: {module} with the following error: {e}.")
+ self.logger.error(
+ f"Failed to load module: {module} with the following error: {e}.")
return
while sfg.name in self.sfg_dict:
- self.logger.warning(f"Duplicate sfg with name: {sfg.name} detected. Please choose a new name.")
- name, accepted = QInputDialog.getText(self, "Change SFG Name", "Name: ", QLineEdit.Normal)
+ self.logger.warning(
+ f"Duplicate sfg with name: {sfg.name} detected. Please choose a new name.")
+ name, accepted = QInputDialog.getText(
+ self, "Change SFG Name", "Name: ", QLineEdit.Normal)
if not accepted:
return
sfg.name = name
for op in sfg.split():
- self.create_operation(op, positions[op.graph_id] if op.graph_id in positions else None)
+ self.create_operation(
+ op, positions[op.graph_id] if op.graph_id in positions else None)
def connect_ports(ports):
for port in ports:
for signal in port.signals:
- source = [source for source in self.portDict[self.operationDragDict[signal.source.operation]] if source.port is signal.source]
- destination = [destination for destination in self.portDict[self.operationDragDict[signal.destination.operation]] if destination.port is signal.destination]
+ source = [source for source in self.portDict[self.operationDragDict[signal.source.operation]]
+ if source.port is signal.source]
+ destination = [destination for destination in self.portDict[self.operationDragDict[
+ signal.destination.operation]] if destination.port is signal.destination]
if source and destination:
self.connect_button(source[0], destination[0])
@@ -249,7 +294,8 @@ class MainWindow(QMainWindow):
elif isinstance(op.operation, Output):
outputs.append(op.operation)
- name, accepted = QInputDialog.getText(self, "Create SFG", "Name: ", QLineEdit.Normal)
+ name, accepted = QInputDialog.getText(
+ self, "Create SFG", "Name: ", QLineEdit.Normal)
if not accepted:
return
@@ -257,37 +303,43 @@ class MainWindow(QMainWindow):
self.logger.warning(f"Failed to initialize SFG with empty name.")
return
- self.logger.info(f"Creating SFG with name: {name} from selected operations.")
+ self.logger.info(
+ f"Creating SFG with name: {name} from selected operations.")
sfg = SFG(inputs=inputs, outputs=outputs, name=name)
- self.logger.info(f"Created SFG with name: {name} from selected operations.")
+ self.logger.info(
+ f"Created SFG with name: {name} from selected operations.")
def check_equality(signal, signal_2):
- if not (signal.source.operation.type_name() == signal_2.source.operation.type_name() \
- and signal.destination.operation.type_name() == signal_2.destination.operation.type_name()):
+ if not (signal.source.operation.type_name() == signal_2.source.operation.type_name()
+ and signal.destination.operation.type_name() == signal_2.destination.operation.type_name()):
return False
if hasattr(signal.source.operation, "value") and hasattr(signal_2.source.operation, "value") \
- and hasattr(signal.destination.operation, "value") and hasattr(signal_2.destination.operation, "value"):
- if not (signal.source.operation.value == signal_2.source.operation.value \
- and signal.destination.operation.value == signal_2.destination.operation.value):
+ and hasattr(signal.destination.operation, "value") and hasattr(signal_2.destination.operation, "value"):
+ if not (signal.source.operation.value == signal_2.source.operation.value
+ and signal.destination.operation.value == signal_2.destination.operation.value):
return False
if hasattr(signal.source.operation, "name") and hasattr(signal_2.source.operation, "name") \
- and hasattr(signal.destination.operation, "name") and hasattr(signal_2.destination.operation, "name"):
- if not (signal.source.operation.name == signal_2.source.operation.name \
- and signal.destination.operation.name == signal_2.destination.operation.name):
+ and hasattr(signal.destination.operation, "name") and hasattr(signal_2.destination.operation, "name"):
+ if not (signal.source.operation.name == signal_2.source.operation.name
+ and signal.destination.operation.name == signal_2.destination.operation.name):
return False
try:
- _signal_source_index = [signal.source.operation.outputs.index(port) for port in signal.source.operation.outputs if signal in port.signals]
- _signal_2_source_index = [signal_2.source.operation.outputs.index(port) for port in signal_2.source.operation.outputs if signal_2 in port.signals]
+ _signal_source_index = [signal.source.operation.outputs.index(
+ port) for port in signal.source.operation.outputs if signal in port.signals]
+ _signal_2_source_index = [signal_2.source.operation.outputs.index(
+ port) for port in signal_2.source.operation.outputs if signal_2 in port.signals]
except ValueError:
return False # Signal output connections not matching
try:
- _signal_destination_index = [signal.destination.operation.inputs.index(port) for port in signal.destination.operation.inputs if signal in port.signals]
- _signal_2_destination_index = [signal_2.destination.operation.inputs.index(port) for port in signal_2.destination.operation.inputs if signal_2 in port.signals]
+ _signal_destination_index = [signal.destination.operation.inputs.index(
+ port) for port in signal.destination.operation.inputs if signal in port.signals]
+ _signal_2_destination_index = [signal_2.destination.operation.inputs.index(
+ port) for port in signal_2.destination.operation.inputs if signal_2 in port.signals]
except ValueError:
return False # Signal input connections not matching
@@ -330,26 +382,31 @@ class MainWindow(QMainWindow):
return [length / 2] if ports == 1 else linspace(0, length, ports)
def add_ports(self, operation):
- _output_ports_dist = self._determine_port_distance(55 - 17, operation.operation.output_count)
- _input_ports_dist = self._determine_port_distance(55 - 17, operation.operation.input_count)
+ _output_ports_dist = self._determine_port_distance(
+ 55 - 17, operation.operation.output_count)
+ _input_ports_dist = self._determine_port_distance(
+ 55 - 17, operation.operation.input_count)
self.portDict[operation] = list()
for i, dist in enumerate(_input_ports_dist):
- port = PortButton(">", operation, operation.operation.input(i), self)
+ port = PortButton(
+ ">", operation, operation.operation.input(i), self)
self.portDict[operation].append(port)
operation.ports.append(port)
port.move(0, dist)
port.show()
for i, dist in enumerate(_output_ports_dist):
- port = PortButton(">", operation, operation.operation.output(i), self)
+ port = PortButton(
+ ">", operation, operation.operation.output(i), self)
self.portDict[operation].append(port)
operation.ports.append(port)
port.move(55 - 12, dist)
port.show()
def get_operations_from_namespace(self, namespace):
- self.logger.info(f"Fetching operations from namespace: {namespace.__name__}.")
+ self.logger.info(
+ f"Fetching operations from namespace: {namespace.__name__}.")
return [comp for comp in dir(namespace) if hasattr(getattr(namespace, comp), "type_name")]
def add_operations_from_namespace(self, namespace, _list):
@@ -363,22 +420,26 @@ class MainWindow(QMainWindow):
except NotImplementedError:
pass
- self.logger.info(f"Added operations from namespace: {namespace.__name__}.")
+ self.logger.info(
+ f"Added operations from namespace: {namespace.__name__}.")
def add_namespace(self):
module, accepted = QFileDialog().getOpenFileName()
if not accepted:
return
- spec = importlib.util.spec_from_file_location(f"{QFileInfo(module).fileName()}", module)
+ spec = importlib.util.spec_from_file_location(
+ f"{QFileInfo(module).fileName()}", module)
namespace = importlib.util.module_from_spec(spec)
spec.loader.exec_module(namespace)
- self.add_operations_from_namespace(namespace, self.ui.custom_operations_list)
+ self.add_operations_from_namespace(
+ namespace, self.ui.custom_operations_list)
def create_operation(self, op, position=None):
try:
- attr_button = DragButton(op.graph_id, op, op.type_name().lower(), True, window = self)
+ attr_button = DragButton(
+ op.graph_id, op, op.type_name().lower(), True, window=self)
if position is None:
attr_button.move(250, 100)
else:
@@ -389,9 +450,11 @@ class MainWindow(QMainWindow):
border-color: black; border-width: 2px")
self.add_ports(attr_button)
- icon_path = path.join(path.dirname(__file__), "operation_icons", f"{op.type_name().lower()}.png")
+ icon_path = path.join(path.dirname(
+ __file__), "operation_icons", f"{op.type_name().lower()}.png")
if not path.exists(icon_path):
- icon_path = path.join(path.dirname(__file__), "operation_icons", f"custom_operation.png")
+ icon_path = path.join(path.dirname(
+ __file__), "operation_icons", f"custom_operation.png")
attr_button.setIcon(QIcon(icon_path))
attr_button.setIconSize(QSize(55, 55))
attr_button.setToolTip("No sfg")
@@ -400,18 +463,21 @@ class MainWindow(QMainWindow):
attr_button.setParent(None)
attr_button_scene = self.scene.addWidget(attr_button)
if position is None:
- attr_button_scene.moveBy(int(self.scene.width() / 2), int(self.scene.height() / 2))
+ attr_button_scene.moveBy(
+ int(self.scene.width() / 2), int(self.scene.height() / 2))
attr_button_scene.setFlag(attr_button_scene.ItemIsSelectable, True)
operation_label = QGraphicsTextItem(op.name, attr_button_scene)
if not self.is_show_names:
operation_label.setOpacity(0)
- operation_label.setTransformOriginPoint(operation_label.boundingRect().center())
+ operation_label.setTransformOriginPoint(
+ operation_label.boundingRect().center())
operation_label.moveBy(10, -20)
attr_button.add_label(operation_label)
self.operationDragDict[op] = attr_button
self.dragOperationSceneDict[attr_button] = attr_button_scene
except Exception as e:
- self.logger.error(f"Unexpected error occured while creating operation: {e}.")
+ self.logger.error(
+ f"Unexpected error occured while creating operation: {e}.")
def _create_operation_item(self, item):
self.logger.info(f"Creating operation of type: {item.text()}.")
@@ -419,15 +485,18 @@ class MainWindow(QMainWindow):
attr_oper = self._operations_from_name[item.text()]()
self.create_operation(attr_oper)
except Exception as e:
- self.logger.error(f"Unexpected error occured while creating operation: {e}.")
+ self.logger.error(
+ f"Unexpected error occured while creating operation: {e}.")
def _refresh_operations_list_from_namespace(self):
self.logger.info("Refreshing operation list.")
self.ui.core_operations_list.clear()
self.ui.special_operations_list.clear()
- self.add_operations_from_namespace(c_oper, self.ui.core_operations_list)
- self.add_operations_from_namespace(s_oper, self.ui.special_operations_list)
+ self.add_operations_from_namespace(
+ c_oper, self.ui.core_operations_list)
+ self.add_operations_from_namespace(
+ s_oper, self.ui.special_operations_list)
self.logger.info("Finished refreshing operation list.")
def on_list_widget_item_clicked(self, item):
@@ -443,18 +512,22 @@ class MainWindow(QMainWindow):
def _connect_button(self, *event):
if len(self.pressed_ports) < 2:
- self.logger.warning("Can't connect less than two ports. Please select more.")
+ self.logger.warning(
+ "Can't connect less than two ports. Please select more.")
return
for i in range(len(self.pressed_ports) - 1):
- source = self.pressed_ports[i] if isinstance(self.pressed_ports[i].port, OutputPort) else self.pressed_ports[i + 1]
- destination = self.pressed_ports[i + 1] if source is not self.pressed_ports[i + 1] else self.pressed_ports[i]
+ source = self.pressed_ports[i] if isinstance(
+ self.pressed_ports[i].port, OutputPort) else self.pressed_ports[i + 1]
+ destination = self.pressed_ports[i +
+ 1] if source is not self.pressed_ports[i + 1] else self.pressed_ports[i]
if source.port.operation is destination.port.operation:
self.logger.warning("Can't connect to the same port")
continue
if type(source.port) == type(destination.port):
- self.logger.warning(f"Can't connect port of type: {type(source.port).__name__} to port of type: {type(destination.port).__name__}.")
+ self.logger.warning(
+ f"Can't connect port of type: {type(source.port).__name__} to port of type: {type(destination.port).__name__}.")
continue
self.connect_button(source, destination)
@@ -463,8 +536,10 @@ class MainWindow(QMainWindow):
port.select_port()
def connect_button(self, source, destination):
- signal_exists = (signal for signal in source.port.signals if signal.destination is destination.port)
- self.logger.info(f"Connecting: {source.operation.operation.type_name()} -> {destination.operation.operation.type_name()}.")
+ signal_exists = (
+ signal for signal in source.port.signals if signal.destination is destination.port)
+ self.logger.info(
+ f"Connecting: {source.operation.operation.type_name()} -> {destination.operation.operation.type_name()}.")
try:
line = Arrow(source, destination, self, signal=next(signal_exists))
except StopIteration:
@@ -497,16 +572,21 @@ class MainWindow(QMainWindow):
def _simulate_sfg(self):
for sfg, properties in self.dialog.properties.items():
self.logger.info(f"Simulating sfg with name: {sfg.name}.")
- simulation = FastSimulation(sfg, input_providers=properties["input_values"])
- l_result = simulation.run_for(properties["iteration_count"], save_results=properties["all_results"])
+ simulation = FastSimulation(
+ sfg, input_providers=properties["input_values"])
+ l_result = simulation.run_for(
+ properties["iteration_count"], save_results=properties["all_results"])
print(f"{'=' * 10} {sfg.name} {'=' * 10}")
- pprint(simulation.results if properties["all_results"] else l_result)
+ pprint(
+ simulation.results if properties["all_results"] else l_result)
print(f"{'=' * 10} /{sfg.name} {'=' * 10}")
if properties["show_plot"]:
- self.logger.info(f"Opening plot for sfg with name: {sfg.name}.")
- self.logger.info("To save the plot press 'Ctrl+S' when the plot is focused.")
+ self.logger.info(
+ f"Opening plot for sfg with name: {sfg.name}.")
+ self.logger.info(
+ "To save the plot press 'Ctrl+S' when the plot is focused.")
self.plot = Plot(simulation, sfg, self)
self.plot.show()
@@ -543,4 +623,3 @@ def start_gui():
if __name__ == "__main__":
start_gui()
-
diff --git a/b_asic/__init__.py b/b_asic/__init__.py
index 9405cbcb3d106a344d160d40108bc41fff1537d9..e69f04987f4ff2921e57d7f0274e1c8c1e5c3ebd 100644
--- a/b_asic/__init__.py
+++ b/b_asic/__init__.py
@@ -1,8 +1,12 @@
+"""B-ASIC - Better ASIC Toolbox.
+ASIC toolbox that simplifies circuit design and optimization.
"""
-Better ASIC Toolbox.
-TODO: More info.
-"""
+# Extension module (C++).
+# NOTE: If this import gives an error,
+# make sure the C++ module has been compiled and installed properly.
+# See the included README.md for more information on how to build/install.
from _b_asic import *
+# Python modules.
from b_asic.core_operations import *
from b_asic.graph_component import *
from b_asic.operation import *
diff --git a/b_asic/core_operations.py b/b_asic/core_operations.py
index 9a11d91943e9621e43daa3c88ddfa67d3441060c..c822fe8f4843c26f5dfabc33a48f3cbe92d74eef 100644
--- a/b_asic/core_operations.py
+++ b/b_asic/core_operations.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Core Operations Module.
-TODO: More info.
+"""B-ASIC Core Operations Module.
+
+Contains some of the most commonly used mathematical operations.
"""
from numbers import Number
@@ -14,10 +14,14 @@ from b_asic.graph_component import Name, TypeName
class Constant(AbstractOperation):
"""Constant value operation.
- TODO: More info.
+
+ Gives a specified value that remains constant for every iteration.
+
+ output(0): self.param("value")
"""
def __init__(self, value: Number = 0, name: Name = ""):
+ """Construct a Constant operation with the given value."""
super().__init__(input_count=0, output_count=1, name=name)
self.set_param("value", value)
@@ -41,10 +45,14 @@ class Constant(AbstractOperation):
class Addition(AbstractOperation):
"""Binary addition operation.
- TODO: More info.
+
+ Gives the result of adding two inputs.
+
+ output(0): input(0) + input(1)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct an Addition operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -58,10 +66,14 @@ class Addition(AbstractOperation):
class Subtraction(AbstractOperation):
"""Binary subtraction operation.
- TODO: More info.
+
+ Gives the result of subtracting the second input from the first one.
+
+ output(0): input(0) - input(1)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Subtraction operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -75,10 +87,14 @@ class Subtraction(AbstractOperation):
class Multiplication(AbstractOperation):
"""Binary multiplication operation.
- TODO: More info.
+
+ Gives the result of multiplying two inputs.
+
+ output(0): input(0) * input(1)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Multiplication operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -92,10 +108,14 @@ class Multiplication(AbstractOperation):
class Division(AbstractOperation):
"""Binary division operation.
- TODO: More info.
+
+ Gives the result of dividing the first input by the second one.
+
+ output(0): input(0) / input(1)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Division operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -109,10 +129,15 @@ class Division(AbstractOperation):
class Min(AbstractOperation):
"""Binary min operation.
- TODO: More info.
+
+ Gives the minimum value of two inputs.
+ NOTE: Non-real numbers are not supported.
+
+ output(0): min(input(0), input(1))
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Min operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -128,10 +153,15 @@ class Min(AbstractOperation):
class Max(AbstractOperation):
"""Binary max operation.
- TODO: More info.
+
+ Gives the maximum value of two inputs.
+ NOTE: Non-real numbers are not supported.
+
+ output(0): max(input(0), input(1))
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Max operation."""
super().__init__(input_count=2, output_count=1, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -146,11 +176,15 @@ class Max(AbstractOperation):
class SquareRoot(AbstractOperation):
- """Unary square root operation.
- TODO: More info.
+ """Square root operation.
+
+ Gives the square root of its input.
+
+ output(0): sqrt(input(0))
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a SquareRoot operation."""
super().__init__(input_count=1, output_count=1, name=name, input_sources=[src0],
latency=latency, latency_offsets=latency_offsets)
@@ -163,11 +197,15 @@ class SquareRoot(AbstractOperation):
class ComplexConjugate(AbstractOperation):
- """Unary complex conjugate operation.
- TODO: More info.
+ """Complex conjugate operation.
+
+ Gives the complex conjugate of its input.
+
+ output(0): conj(input(0))
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a ComplexConjugate operation."""
super().__init__(input_count=1, output_count=1, name=name, input_sources=[src0],
latency=latency, latency_offsets=latency_offsets)
@@ -180,11 +218,15 @@ class ComplexConjugate(AbstractOperation):
class Absolute(AbstractOperation):
- """Unary absolute value operation.
- TODO: More info.
+ """Absolute value operation.
+
+ Gives the absolute value of its input.
+
+ output(0): abs(input(0))
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct an Absolute operation."""
super().__init__(input_count=1, output_count=1, name=name, input_sources=[src0],
latency=latency, latency_offsets=latency_offsets)
@@ -197,11 +239,15 @@ class Absolute(AbstractOperation):
class ConstantMultiplication(AbstractOperation):
- """Unary constant multiplication operation.
- TODO: More info.
+ """Constant multiplication operation.
+
+ Gives the result of multiplying its input by a specified value.
+
+ output(0): self.param("value") * input(0)
"""
- def __init__(self, value: Number = 0, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, value: Number = 0, src0: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a ConstantMultiplication operation with the given value."""
super().__init__(input_count=1, output_count=1, name=name, input_sources=[src0],
latency=latency, latency_offsets=latency_offsets)
self.set_param("value", value)
@@ -225,12 +271,17 @@ class ConstantMultiplication(AbstractOperation):
class Butterfly(AbstractOperation):
- """Butterfly operation that returns two outputs.
- The first output is a + b and the second output is a - b.
- TODO: More info.
+ """Butterfly operation.
+
+ Gives the result of adding its two inputs, as well as the result of
+ subtracting the second input from the first one.
+
+ output(0): input(0) + input(1)
+ output(1): input(0) - input(1)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a Butterfly operation."""
super().__init__(input_count=2, output_count=2, name=name, input_sources=[src0, src1],
latency=latency, latency_offsets=latency_offsets)
@@ -243,11 +294,16 @@ class Butterfly(AbstractOperation):
class MAD(AbstractOperation):
- """Multiply-and-add operation.
- TODO: More info.
+ """Multiply-add operation.
+
+ Gives the result of multiplying the first input by the second input and
+ then adding the third input.
+
+ output(0): (input(0) * input(1)) + input(2)
"""
- def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, src2: Optional[SignalSourceProvider] = None, name: Name = "", latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, src0: Optional[SignalSourceProvider] = None, src1: Optional[SignalSourceProvider] = None, src2: Optional[SignalSourceProvider] = None, name: Name = "", latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct a MAD operation."""
super().__init__(input_count=3, output_count=1, name=name, input_sources=[src0, src1, src2],
latency=latency, latency_offsets=latency_offsets)
diff --git a/b_asic/graph_component.py b/b_asic/graph_component.py
index e08422a842a84d08dcab58ab03d7f581cb1bc664..8a0b4a9a6e7385ed2ababd28cc5b4619c1c586d7 100644
--- a/b_asic/graph_component.py
+++ b/b_asic/graph_component.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Operation Module.
-TODO: More info.
+"""B-ASIC Graph Component Module.
+
+Contains the base for all components with an ID in a signal flow graph.
"""
from abc import ABC, abstractmethod
@@ -17,7 +17,14 @@ GraphIDNumber = NewType("GraphIDNumber", int)
class GraphComponent(ABC):
"""Graph component interface.
- TODO: More info.
+
+ Each graph component has a type name, a name and a unique ID.
+ Graph components also contain parameters and provide an interface for
+ copying that automatically copies each parameter in its default
+ implementation.
+
+ Graph components also provide an interface for traversing connected graph
+ components and accessing their direct neighbors.
"""
@classmethod
@@ -92,8 +99,10 @@ class GraphComponent(ABC):
class AbstractGraphComponent(GraphComponent):
- """Abstract Graph Component class which is a component of a signal flow graph.
- TODO: More info.
+ """Generic abstract graph component base class.
+
+ Concrete graph components should normally derive from this to get the
+ default behavior.
"""
_name: Name
@@ -101,13 +110,16 @@ class AbstractGraphComponent(GraphComponent):
_parameters: Dict[str, Any]
def __init__(self, name: Name = ""):
+ """Construct a graph component."""
self._name = name
self._graph_id = ""
self._parameters = {}
- def __str__(self):
+ def __str__(self) -> str:
+ """Get a string representation of this graph component."""
return f"id: {self.graph_id if self.graph_id else 'no_id'}, \tname: {self.name if self.name else 'no_name'}" + \
- "".join((f", \t{key}: {str(param)}" for key, param in self._parameters.items()))
+ "".join((f", \t{key}: {str(param)}" for key,
+ param in self._parameters.items()))
@property
def name(self) -> Name:
@@ -140,7 +152,8 @@ class AbstractGraphComponent(GraphComponent):
new_component.name = copy(self.name)
new_component.graph_id = copy(self.graph_id)
for name, value in self.params.items():
- new_component.set_param(copy(name), deepcopy(value)) # pylint: disable=no-member
+ new_component.set_param(copy(name), deepcopy(
+ value)) # pylint: disable=no-member
return new_component
def traverse(self) -> Generator[GraphComponent, None, None]:
diff --git a/b_asic/operation.py b/b_asic/operation.py
index 0778b5747fd8ad342bc076187293b65a0524741e..2ce783963d883f65c1ec29d3dddb7bf0eeccbd6f 100644
--- a/b_asic/operation.py
+++ b/b_asic/operation.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Operation Module.
-TODO: More info.
+"""B-ASIC Operation Module.
+
+Contains the base for operations that are used by B-ASIC.
"""
from b_asic.signal import Signal
@@ -21,9 +21,16 @@ MutableResultMap = MutableMapping[ResultKey, Optional[Number]]
DelayMap = Mapping[ResultKey, Number]
MutableDelayMap = MutableMapping[ResultKey, Number]
+
class Operation(GraphComponent, SignalSourceProvider):
"""Operation interface.
- TODO: More info.
+
+ Operations are graph components that perform a certain function.
+ They are connected to eachother by signals through their input/output
+ ports.
+
+ Operations can be evaluated independently using evaluate_output().
+ Operations may specify how to truncate inputs through truncate_input().
"""
@abstractmethod
@@ -83,7 +90,7 @@ class Operation(GraphComponent, SignalSourceProvider):
object that is connected to the self and other objects.
"""
raise NotImplementedError
-
+
@abstractmethod
def __lshift__(self, src: SignalSourceProvider) -> Signal:
"""Overloads the left shift operator to make it connect the provided signal source
@@ -191,6 +198,13 @@ class Operation(GraphComponent, SignalSourceProvider):
"""
raise NotImplementedError
+ @abstractmethod
+ def to_sfg(self) -> "SFG":
+ """Convert the operation into its corresponding SFG.
+ If the operation is composed by multiple operations, the operation will be split.
+ """
+ raise NotImplementedError
+
@abstractmethod
def inputs_required_for_output(self, output_index: int) -> Iterable[int]:
"""Get the input indices of all inputs in this operation whose values are required in order to evaluate the output at the given output index."""
@@ -201,13 +215,6 @@ class Operation(GraphComponent, SignalSourceProvider):
"""Truncate the value to be used as input at the given index to a certain bit length."""
raise NotImplementedError
- @abstractmethod
- def to_sfg(self) -> "SFG":
- """Convert the operation into its corresponding SFG.
- If the operation is composed by multiple operations, the operation will be split.
- """
- raise NotImplementedError
-
@property
@abstractmethod
def latency(self) -> int:
@@ -243,14 +250,24 @@ class Operation(GraphComponent, SignalSourceProvider):
class AbstractOperation(Operation, AbstractGraphComponent):
- """Generic abstract operation class which most implementations will derive from.
- TODO: More info.
+ """Generic abstract operation base class.
+
+ Concrete operations should normally derive from this to get the default
+ behavior.
"""
_input_ports: List[InputPort]
_output_ports: List[OutputPort]
- def __init__(self, input_count: int, output_count: int, name: Name = "", input_sources: Optional[Sequence[Optional[SignalSourceProvider]]] = None, latency: int = None, latency_offsets: Dict[str, int] = None):
+ def __init__(self, input_count: int, output_count: int, name: Name = "", input_sources: Optional[Sequence[Optional[SignalSourceProvider]]] = None, latency: Optional[int] = None, latency_offsets: Optional[Dict[str, int]] = None):
+ """Construct an operation with the given input/output count.
+
+ A list of input sources may be specified to automatically connect
+ to the input ports.
+ If provided, the number of sources must match the number of inputs.
+
+ The latency offsets may also be specified to be initialized.
+ """
super().__init__(name)
self._input_ports = [InputPort(self, i) for i in range(input_count)]
@@ -333,8 +350,9 @@ class AbstractOperation(Operation, AbstractGraphComponent):
raise TypeError(
f"{self.__class__.__name__} cannot be used as a destination because it has {diff} than 1 input")
return self.input(0).connect(src)
-
- def __str__(self):
+
+ def __str__(self) -> str:
+ """Get a string representation of this operation."""
inputs_dict = dict()
for i, port in enumerate(self.inputs):
if port.signal_count == 0:
@@ -422,7 +440,7 @@ class AbstractOperation(Operation, AbstractGraphComponent):
elif not key:
key = str(index)
return key
-
+
def current_output(self, index: int, delays: Optional[DelayMap] = None, prefix: str = "") -> Optional[Number]:
return None
@@ -431,9 +449,11 @@ class AbstractOperation(Operation, AbstractGraphComponent):
raise IndexError(
f"Output index out of range (expected 0-{self.output_count - 1}, got {index})")
if len(input_values) != self.input_count:
- raise ValueError(f"Wrong number of input values supplied to operation (expected {self.input_count}, got {len(input_values)})")
+ raise ValueError(
+ f"Wrong number of input values supplied to operation (expected {self.input_count}, got {len(input_values)})")
- values = self.evaluate(*(self.truncate_inputs(input_values, bits_override) if truncate else input_values))
+ values = self.evaluate(
+ *(self.truncate_inputs(input_values, bits_override) if truncate else input_values))
if isinstance(values, collections.abc.Sequence):
if len(values) != self.output_count:
raise RuntimeError(
@@ -486,7 +506,7 @@ class AbstractOperation(Operation, AbstractGraphComponent):
last_operations = [last_operations]
outputs = [Output(o) for o in last_operations]
except TypeError:
- operation_copy = self.copy_component()
+ operation_copy: Operation = self.copy_component()
inputs = []
for i in range(self.input_count):
_input = Input()
@@ -497,8 +517,8 @@ class AbstractOperation(Operation, AbstractGraphComponent):
return SFG(inputs=inputs, outputs=outputs)
- def copy_component(self, *args, **kwargs) -> Operation:
- new_component = super().copy_component(*args, **kwargs)
+ def copy_component(self, *args, **kwargs) -> GraphComponent:
+ new_component: Operation = super().copy_component(*args, **kwargs)
for i, inp in enumerate(self.inputs):
new_component.input(i).latency_offset = inp.latency_offset
for i, outp in enumerate(self.outputs):
@@ -507,8 +527,10 @@ class AbstractOperation(Operation, AbstractGraphComponent):
def inputs_required_for_output(self, output_index: int) -> Iterable[int]:
if output_index < 0 or output_index >= self.output_count:
- raise IndexError(f"Output index out of range (expected 0-{self.output_count - 1}, got {output_index})")
- return [i for i in range(self.input_count)] # By default, assume each output depends on all inputs.
+ raise IndexError(
+ f"Output index out of range (expected 0-{self.output_count - 1}, got {output_index})")
+ # By default, assume each output depends on all inputs.
+ return [i for i in range(self.input_count)]
@property
def neighbors(self) -> Iterable[GraphComponent]:
@@ -545,7 +567,8 @@ class AbstractOperation(Operation, AbstractGraphComponent):
bits = input_port.signals[0].bits
if bits_override is not None:
if isinstance(value, complex):
- raise TypeError("Complex value cannot be truncated to {bits} bits as requested by the signal connected to input #{i}")
+ raise TypeError(
+ "Complex value cannot be truncated to {bits} bits as requested by the signal connected to input #{i}")
value = self.truncate_input(i, value, bits)
args.append(value)
return args
@@ -553,17 +576,11 @@ class AbstractOperation(Operation, AbstractGraphComponent):
@property
def latency(self) -> int:
if None in [inp.latency_offset for inp in self.inputs] or None in [outp.latency_offset for outp in self.outputs]:
- raise ValueError("All native offsets have to set to a non-negative value to calculate the latency.")
+ raise ValueError(
+ "All native offsets have to set to a non-negative value to calculate the latency.")
return max(((outp.latency_offset - inp.latency_offset) for outp, inp in it.product(self.outputs, self.inputs)))
- def set_latency(self, latency: int) -> None:
- assert latency >= 0, "Negative latency entered."
- for inport in self.inputs:
- inport.latency_offset = 0
- for outport in self.outputs:
- outport.latency_offset = latency
-
@property
def latency_offsets(self) -> Sequence[Sequence[int]]:
latency_offsets = dict()
@@ -576,6 +593,13 @@ class AbstractOperation(Operation, AbstractGraphComponent):
return latency_offsets
+ def set_latency(self, latency: int) -> None:
+ assert latency >= 0, "Negative latency entered."
+ for inport in self.inputs:
+ inport.latency_offset = 0
+ for outport in self.outputs:
+ outport.latency_offset = latency
+
def set_latency_offsets(self, latency_offsets: Dict[str, int]) -> None:
for port_str, latency_offset in latency_offsets.items():
port_str = port_str.lower()
@@ -588,4 +612,5 @@ class AbstractOperation(Operation, AbstractGraphComponent):
assert index_str.isdigit(), "Incorrectly formatted index in string, expected 'out' + index"
self.output(int(index_str)).latency_offset = latency_offset
else:
- raise ValueError("Incorrectly formatted string, expected 'in' + index or 'out' + index")
+ raise ValueError(
+ "Incorrectly formatted string, expected 'in' + index or 'out' + index")
diff --git a/b_asic/port.py b/b_asic/port.py
index 2d6093886992922f22af1ac0c3f09c25696301b8..25197891d452b7844545cdae144979d73f6345d5 100644
--- a/b_asic/port.py
+++ b/b_asic/port.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Port Module.
-TODO: More info.
+"""B-ASIC Port Module.
+
+Contains classes for managing the ports of operations.
"""
from abc import ABC, abstractmethod
@@ -15,9 +15,15 @@ if TYPE_CHECKING:
class Port(ABC):
- """Port Interface.
+ """Port interface.
+
+ Ports serve as connection points for connecting signals between operations.
+ They also store information about the latency of the corresponding
+ calculations of the operation.
- TODO: More documentaiton?
+ Aside from connected signals, each port also provides a reference to the
+ parent operation that "owns" it as well as the operation's port index at
+ which the port resides.
"""
@property
@@ -59,7 +65,7 @@ class Port(ABC):
@abstractmethod
def add_signal(self, signal: Signal) -> None:
"""Connect this port to the entered signal. If the entered signal isn't connected to
- this port then connect the entered signal to the port aswell.
+ this port then connect the entered signal to the port as well.
"""
raise NotImplementedError
@@ -67,7 +73,7 @@ class Port(ABC):
def remove_signal(self, signal: Signal) -> None:
"""Remove the signal that was entered from the Ports signals.
If the entered signal still is connected to this port then disconnect the
- entered signal from the port aswell.
+ entered signal from the port as well.
Keyword arguments:
- signal: Signal to remove.
@@ -81,16 +87,18 @@ class Port(ABC):
class AbstractPort(Port):
- """Abstract port class.
+ """Generic abstract port base class.
- Handles functionality for port id and saves the connection to the parent operation.
+ Concrete ports should normally derive from this to get the default
+ behavior.
"""
_operation: "Operation"
_index: int
_latency_offset: Optional[int]
- def __init__(self, operation: "Operation", index: int, latency_offset: int = None):
+ def __init__(self, operation: "Operation", index: int, latency_offset: Optional[int] = None):
+ """Construct a port of the given operation at the given port index."""
self._operation = operation
self._index = index
self._latency_offset = latency_offset
@@ -114,7 +122,9 @@ class AbstractPort(Port):
class SignalSourceProvider(ABC):
"""Signal source provider interface.
- TODO: More info.
+
+ Signal source providers give access to a single output port that can be
+ used to connect signals from.
"""
@property
@@ -126,12 +136,14 @@ class SignalSourceProvider(ABC):
class InputPort(AbstractPort):
"""Input port.
- TODO: More info.
+
+ May have one or zero signals connected to it.
"""
_source_signal: Optional[Signal]
def __init__(self, operation: "Operation", index: int):
+ """Construct an InputPort."""
super().__init__(operation, index)
self._source_signal = None
@@ -172,7 +184,7 @@ class InputPort(AbstractPort):
assert self._source_signal is None, "Attempted to connect already connected input port."
# self._source_signal is set by the signal constructor.
return Signal(source=src.source, destination=self, name=name)
-
+
def __lshift__(self, src: SignalSourceProvider) -> Signal:
"""Overloads the left shift operator to make it connect the provided signal source to this input port.
Returns the new signal.
@@ -182,12 +194,14 @@ class InputPort(AbstractPort):
class OutputPort(AbstractPort, SignalSourceProvider):
"""Output port.
- TODO: More info.
+
+ May have zero or more signals connected to it.
"""
_destination_signals: List[Signal]
def __init__(self, operation: "Operation", index: int):
+ """Construct an OutputPort."""
super().__init__(operation, index)
self._destination_signals = []
diff --git a/b_asic/save_load_structure.py b/b_asic/save_load_structure.py
index 165461236beb47cdba624bcb01eb5ba6609f5ef3..222e474193691ce9b1ca9b7320dc5ffd6fd9b75d 100644
--- a/b_asic/save_load_structure.py
+++ b/b_asic/save_load_structure.py
@@ -1,7 +1,7 @@
-"""@package docstring
-B-ASIC Save/Load SFG Module.
-Given a structure try to serialize it and save it to a file.
-Given a serialized file try to deserialize it and load it to the library.
+"""B-ASIC Save/Load Structure Module.
+
+Contains functions for saving/loading SFGs to/from strings that can be stored
+as files.
"""
from b_asic.signal_flow_graph import SFG
@@ -11,7 +11,9 @@ from datetime import datetime
from inspect import signature
from os import path
+
def sfg_to_python(sfg: SFG, counter: int = 0, suffix: str = None) -> str:
+ """Given an SFG structure try to serialize it for saving to a file."""
result = (
"\n\"\"\"\nB-ASIC automatically generated SFG file.\n" +
"Name: " + f"{sfg.name}" + "\n" +
@@ -25,8 +27,10 @@ def sfg_to_python(sfg: SFG, counter: int = 0, suffix: str = None) -> str:
def kwarg_unpacker(comp: GraphComponent, params=None) -> str:
if params is None:
- params_filtered = {attr: getattr(op, attr) for attr in signature(op.__init__).parameters if attr != "latency" and hasattr(op, attr)}
- params = {attr: getattr(op, attr) if not isinstance(getattr(op, attr), str) else f'"{getattr(op, attr)}"' for attr in params_filtered}
+ params_filtered = {attr: getattr(op, attr) for attr in signature(
+ op.__init__).parameters if attr != "latency" and hasattr(op, attr)}
+ params = {attr: getattr(op, attr) if not isinstance(getattr(
+ op, attr), str) else f'"{getattr(op, attr)}"' for attr in params_filtered}
return ", ".join([f"{param[0]}={param[1]}" for param in params.items()])
@@ -48,7 +52,8 @@ def sfg_to_python(sfg: SFG, counter: int = 0, suffix: str = None) -> str:
result += f"{op.graph_id} = {op.__class__.__name__}({kwarg_unpacker(op)})\n"
result += "\n# Signals:\n"
- connections = list() # Keep track of already existing connections to avoid adding duplicates
+ # Keep track of already existing connections to avoid adding duplicates
+ connections = list()
for op in sfg.split():
for out in op.outputs:
for signal in out.signals:
@@ -61,18 +66,23 @@ def sfg_to_python(sfg: SFG, counter: int = 0, suffix: str = None) -> str:
connections.append(connection)
inputs = "[" + ", ".join(op.graph_id for op in sfg.input_operations) + "]"
- outputs = "[" + ", ".join(op.graph_id for op in sfg.output_operations) + "]"
- sfg_name = sfg.name if sfg.name else "sfg" + str(counter) if counter > 0 else 'sfg'
+ outputs = "[" + \
+ ", ".join(op.graph_id for op in sfg.output_operations) + "]"
+ sfg_name = sfg.name if sfg.name else "sfg" + \
+ str(counter) if counter > 0 else 'sfg'
sfg_name_var = sfg_name.replace(" ", "_")
result += f"\n{sfg_name_var} = SFG(inputs={inputs}, outputs={outputs}, name='{sfg_name}')\n"
- result += "\n# SFG Properties:\n" + "prop = {'name':" + f"{sfg_name_var}" + "}"
+ result += "\n# SFG Properties:\n" + \
+ "prop = {'name':" + f"{sfg_name_var}" + "}"
if suffix is not None:
result += "\n" + suffix + "\n"
return result
+
def python_to_sfg(path: str) -> SFG:
+ """Given a serialized file try to deserialize it and load it to the library."""
with open(path) as f:
code = compile(f.read(), path, 'exec')
exec(code, globals(), locals())
diff --git a/b_asic/schema.py b/b_asic/schema.py
index 157ed3b8ec57a35ffe66f1de476e2d77c3e28abd..25f18eb6fb423009edd52f3d2f40024fb37e3422 100644
--- a/b_asic/schema.py
+++ b/b_asic/schema.py
@@ -1,9 +1,9 @@
-"""@package docstring
-This module contains the Schema class.
-TODO: More info
+"""B-ASIC Schema Module.
+
+Contains the schema class for scheduling operations in an SFG.
"""
-from typing import Dict, List
+from typing import Dict, List, Optional
from b_asic.signal_flow_graph import SFG
from b_asic.graph_component import GraphID
@@ -11,7 +11,7 @@ from b_asic.operation import Operation
class Schema:
- """A class that represents an SFG with scheduled Operations."""
+ """Schema of an SFG with scheduled Operations."""
_sfg: SFG
_start_times: Dict[GraphID, int]
@@ -20,8 +20,8 @@ class Schema:
_cyclic: bool
_resolution: int
- def __init__(self, sfg: SFG, schedule_time: int = None, cyclic: bool = False, resolution: int = 1, scheduling_alg: str = "ASAP"):
-
+ def __init__(self, sfg: SFG, schedule_time: Optional[int] = None, cyclic: bool = False, resolution: int = 1, scheduling_alg: str = "ASAP"):
+ """Construct a Schema from an SFG."""
self._sfg = sfg
self._start_times = dict()
self._laps = dict()
@@ -31,37 +31,40 @@ class Schema:
if scheduling_alg == "ASAP":
self._schedule_asap()
else:
- raise NotImplementedError(f"No algorithm with name: {scheduling_alg} defined.")
+ raise NotImplementedError(
+ f"No algorithm with name: {scheduling_alg} defined.")
max_end_time = 0
for op_id, op_start_time in self._start_times.items():
op = self._sfg.find_by_id(op_id)
for outport in op.outputs:
- max_end_time = max(max_end_time, op_start_time + outport.latency_offset)
+ max_end_time = max(
+ max_end_time, op_start_time + outport.latency_offset)
if not self._cyclic:
if schedule_time is None:
self._schedule_time = max_end_time
elif schedule_time < max_end_time:
- raise ValueError("Too short schedule time for non-cyclic Schedule entered.")
+ raise ValueError(
+ "Too short schedule time for non-cyclic Schedule entered.")
else:
self._schedule_time = schedule_time
- def start_time_of_operation(self, op_id: GraphID):
+ def start_time_of_operation(self, op_id: GraphID) -> int:
"""Get the start time of the operation with the specified by the op_id."""
assert op_id in self._start_times, "No operation with the specified op_id in this schema."
return self._start_times[op_id]
- def forward_slack(self, op_id):
+ def forward_slack(self, op_id: GraphID) -> int:
raise NotImplementedError
- def backward_slack(self, op_id):
+ def backward_slack(self, op_id: GraphID) -> int:
raise NotImplementedError
- def print_slacks(self):
+ def print_slacks(self) -> None:
raise NotImplementedError
- def _schedule_asap(self):
+ def _schedule_asap(self) -> None:
pl = self._sfg.get_precedence_list()
if len(pl) < 2:
@@ -84,7 +87,8 @@ class Schema:
op_start_time = 0
for inport in op.inputs:
print(inport.operation.graph_id)
- assert len(inport.signals) == 1, "Error in scheduling, dangling input port detected."
+ assert len(
+ inport.signals) == 1, "Error in scheduling, dangling input port detected."
assert inport.signals[0].source is not None, "Error in scheduling, signal with no source detected."
source_port = inport.signals[0].source
@@ -102,6 +106,7 @@ class Schema:
source_end_time = source_op_time + source_port.latency_offset
op_start_time_from_in = source_end_time - inport.latency_offset
- op_start_time = max(op_start_time, op_start_time_from_in)
+ op_start_time = max(
+ op_start_time, op_start_time_from_in)
self._start_times[op.graph_id] = op_start_time
diff --git a/b_asic/signal.py b/b_asic/signal.py
index 24e8cc81566b7ba5dfb961dadb137f74afe2e111..747b25fc9c51c1cde707066e42778514b80f9eb6 100644
--- a/b_asic/signal.py
+++ b/b_asic/signal.py
@@ -1,5 +1,6 @@
-"""@package docstring
-B-ASIC Signal Module.
+"""B-ASIC Signal Module.
+
+Contains the class for representing the connections between operations.
"""
from typing import Optional, Iterable, TYPE_CHECKING
@@ -16,6 +17,7 @@ class Signal(AbstractGraphComponent):
_destination: Optional["InputPort"]
def __init__(self, source: Optional["OutputPort"] = None, destination: Optional["InputPort"] = None, bits: Optional[int] = None, name: Name = ""):
+ """Construct a Signal."""
super().__init__(name)
self._source = None
self._destination = None
diff --git a/b_asic/signal_flow_graph.py b/b_asic/signal_flow_graph.py
index 3abe54b66a9d5645bd72a197227aea19d29e0501..1c0f48708eaaa761ffc822f46e24c3d88df04eb9 100644
--- a/b_asic/signal_flow_graph.py
+++ b/b_asic/signal_flow_graph.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Signal Flow Graph Module.
-TODO: More info.
+"""B-ASIC Signal Flow Graph Module.
+
+Contains the signal flow graph operation.
"""
from typing import List, Iterable, Sequence, Dict, Optional, DefaultDict, MutableSet, Tuple
@@ -22,11 +22,12 @@ DelayQueue = List[Tuple[str, ResultKey, OutputPort]]
class GraphIDGenerator:
- """A class that generates Graph IDs for objects."""
+ """Generates Graph IDs for objects."""
_next_id_number: DefaultDict[TypeName, GraphIDNumber]
def __init__(self, id_number_offset: GraphIDNumber = 0):
+ """Construct a GraphIDGenerator."""
self._next_id_number = defaultdict(lambda: id_number_offset)
def next_id(self, type_name: TypeName) -> GraphID:
@@ -42,7 +43,9 @@ class GraphIDGenerator:
class SFG(AbstractOperation):
"""Signal flow graph.
- TODO: More info.
+
+ Contains a set of connected operations, forming a new operation.
+ Used as a base for simulation, scheduling, etc.
"""
_components_by_id: Dict[GraphID, GraphComponent]
@@ -58,10 +61,22 @@ class SFG(AbstractOperation):
_original_output_signals_to_indices: Dict[Signal, int]
_precedence_list: Optional[List[List[OutputPort]]]
- def __init__(self, input_signals: Optional[Sequence[Signal]] = None, output_signals: Optional[Sequence[Signal]] = None,
- inputs: Optional[Sequence[Input]] = None, outputs: Optional[Sequence[Output]] = None,
+ def __init__(self, inputs: Optional[Sequence[Input]] = None, outputs: Optional[Sequence[Output]] = None,
+ input_signals: Optional[Sequence[Signal]] = None, output_signals: Optional[Sequence[Signal]] = None,
id_number_offset: GraphIDNumber = 0, name: Name = "",
input_sources: Optional[Sequence[Optional[SignalSourceProvider]]] = None):
+ """Construct an SFG given its inputs and outputs.
+
+ Inputs/outputs may be specified using either Input/Output operations
+ directly with the inputs/outputs parameters, or using signals with the
+ input_signals/output_signals parameters. If signals are used, the
+ corresponding Input/Output operations will be created automatically.
+
+ The id_number_offset parameter specifies what number graph IDs will be
+ offset by for each new graph component type. IDs start at 1 by default,
+ so the default offset of 0 will result in IDs like "c1", "c2", etc.
+ while an offset of 3 will result in "c4", "c5", etc.
+ """
input_signal_count = 0 if input_signals is None else len(input_signals)
input_operation_count = 0 if inputs is None else len(inputs)
@@ -216,17 +231,19 @@ class SFG(AbstractOperation):
results = {}
if delays is None:
delays = {}
-
+
# Set the values of our input operations to the given input values.
for op, arg in zip(self._input_operations, self.truncate_inputs(input_values, bits_override) if truncate else input_values):
op.value = arg
-
+
deferred_delays = []
- value = self._evaluate_source(self._output_operations[index].input(0).signals[0].source, results, delays, prefix, bits_override, truncate, deferred_delays)
+ value = self._evaluate_source(self._output_operations[index].input(
+ 0).signals[0].source, results, delays, prefix, bits_override, truncate, deferred_delays)
while deferred_delays:
new_deferred_delays = []
for key_base, key, src in deferred_delays:
- self._do_evaluate_source(key_base, key, src, results, delays, prefix, bits_override, truncate, new_deferred_delays)
+ self._do_evaluate_source(
+ key_base, key, src, results, delays, prefix, bits_override, truncate, new_deferred_delays)
deferred_delays = new_deferred_delays
results[self.key(index, prefix)] = value
return value
@@ -235,9 +252,11 @@ class SFG(AbstractOperation):
""" Connects any external signals to this SFG's internal operations. This SFG becomes unconnected to the SFG
it is a component off, causing it to become invalid afterwards. Returns True if succesful, False otherwise. """
if len(self.inputs) != len(self.input_operations):
- raise IndexError(f"Number of inputs does not match the number of input_operations in SFG.")
+ raise IndexError(
+ f"Number of inputs does not match the number of input_operations in SFG.")
if len(self.outputs) != len(self.output_operations):
- raise IndexError(f"Number of outputs does not match the number of output_operations SFG.")
+ raise IndexError(
+ f"Number of outputs does not match the number of output_operations SFG.")
if len(self.input_signals) == 0:
return False
if len(self.output_signals) == 0:
@@ -319,8 +338,9 @@ class SFG(AbstractOperation):
"""Get all operations of this graph in depth-first order."""
return self._operations_dfs_order
- def get_components_with_type_name(self, type_name: TypeName) -> List[GraphComponent]:
- """Get a list with all components in this graph with the specified type_name.
+ def find_by_type_name(self, type_name: TypeName) -> Sequence[GraphComponent]:
+ """Find all components in this graph with the specified type name.
+ Returns an empty sequence if no components were found.
Keyword arguments:
type_name: The type_name of the desired components.
@@ -367,38 +387,37 @@ class SFG(AbstractOperation):
if isinstance(comp, Operation):
keys.append(comp.key(output_index, comp.graph_id))
return keys
-
- def replace_component(self, component: Operation, _id: GraphID):
+
+ def replace_component(self, component: Operation, graph_id: GraphID) -> "SFG":
"""Find and replace all components matching either on GraphID, Type or both.
Then return a new deepcopy of the sfg with the replaced component.
Arguments:
component: The new component(s), e.g Multiplication
- _id: The GraphID to match the component to replace.
+ graph_id: The GraphID to match the component to replace.
"""
- _sfg_copy = self()
- _component = _sfg_copy.find_by_id(_id)
+ sfg_copy = self() # Copy to not mess with this SFG.
+ component_copy = sfg_copy.find_by_id(graph_id)
- assert _component is not None and isinstance(_component, Operation), \
+ assert component_copy is not None and isinstance(component_copy, Operation), \
"No operation matching the criteria found"
- assert _component.output_count == component.output_count, \
+ assert component_copy.output_count == component.output_count, \
"The output count may not differ between the operations"
- assert _component.input_count == component.input_count, \
+ assert component_copy.input_count == component.input_count, \
"The input count may not differ between the operations"
- for index_in, _inp in enumerate(_component.inputs):
- for _signal in _inp.signals:
- _signal.remove_destination()
- _signal.set_destination(component.input(index_in))
+ for index_in, inp in enumerate(component_copy.inputs):
+ for signal in inp.signals:
+ signal.remove_destination()
+ signal.set_destination(component.input(index_in))
- for index_out, _out in enumerate(_component.outputs):
- for _signal in _out.signals:
- _signal.remove_source()
- _signal.set_source(component.output(index_out))
+ for index_out, outp in enumerate(component_copy.outputs):
+ for signal in outp.signals:
+ signal.remove_source()
+ signal.set_source(component.output(index_out))
- # The old SFG will be deleted by Python GC
- return _sfg_copy()
+ return sfg_copy() # Copy again to update IDs.
def insert_operation(self, component: Operation, output_comp_id: GraphID) -> Optional["SFG"]:
"""Insert an operation in the SFG after a given source operation.
@@ -441,7 +460,8 @@ class SFG(AbstractOperation):
return None
if operation.input_count != operation.output_count:
- raise ValueError("Different number of input and output ports of operation with the specified id")
+ raise ValueError(
+ "Different number of input and output ports of operation with the specified id")
for i, outport in enumerate(operation.outputs):
if outport.signal_count > 0:
@@ -462,7 +482,7 @@ class SFG(AbstractOperation):
return sfg_copy()
- def get_precedence_list(self) -> List[List[OutputPort]]:
+ def get_precedence_list(self) -> Sequence[Sequence[OutputPort]]:
"""Returns a Precedence list of the SFG where each element in n:th the list consists
of elements that are executed in the n:th step. If the precedence list already has been
calculated for the current SFG then returns the cached version."""
@@ -470,44 +490,19 @@ class SFG(AbstractOperation):
return self._precedence_list
# Find all operations with only outputs and no inputs.
- no_input_ops = list(filter(lambda op: op.input_count == 0, self.operations))
- delay_ops = self.get_components_with_type_name(Delay.type_name())
+ no_input_ops = list(
+ filter(lambda op: op.input_count == 0, self.operations))
+ delay_ops = self.find_by_type_name(Delay.type_name())
# Find all first iter output ports for precedence
- first_iter_ports = [op.output(i) for op in (no_input_ops + delay_ops) for i in range(op.output_count)]
+ first_iter_ports = [op.output(i) for op in (
+ no_input_ops + delay_ops) for i in range(op.output_count)]
- self._precedence_list = self._traverse_for_precedence_list(first_iter_ports)
+ self._precedence_list = self._traverse_for_precedence_list(
+ first_iter_ports)
return self._precedence_list
- def _traverse_for_precedence_list(self, first_iter_ports: List[OutputPort]) -> List[List[OutputPort]]:
- # Find dependencies of output ports and input ports.
- remaining_inports_per_operation = {op: op.input_count for op in self.operations}
-
- # Traverse output ports for precedence
- curr_iter_ports = first_iter_ports
- precedence_list = []
-
- while curr_iter_ports:
- # Add the found ports to the current iter
- precedence_list.append(curr_iter_ports)
-
- next_iter_ports = []
-
- for outport in curr_iter_ports:
- for signal in outport.signals:
- new_inport = signal.destination
- # Don't traverse over delays.
- if new_inport is not None and not isinstance(new_inport.operation, Delay):
- new_op = new_inport.operation
- remaining_inports_per_operation[new_op] -= 1
- if remaining_inports_per_operation[new_op] == 0:
- next_iter_ports.extend(new_op.outputs)
-
- curr_iter_ports = next_iter_ports
-
- return precedence_list
-
def show_precedence_graph(self) -> None:
p_list = self.get_precedence_list()
pg = Digraph()
@@ -525,9 +520,12 @@ class SFG(AbstractOperation):
ports = p_list[i]
for port in ports:
for signal in port.signals:
- pg.edge(port.operation.graph_id + '.' + str(port.index), signal.destination.operation.graph_id)
- pg.node(signal.destination.operation.graph_id, shape='square')
- pg.edge(port.operation.graph_id, port.operation.graph_id + '.' + str(port.index))
+ pg.edge(port.operation.graph_id + '.' + str(port.index),
+ signal.destination.operation.graph_id)
+ pg.node(signal.destination.operation.graph_id,
+ shape='square')
+ pg.edge(port.operation.graph_id,
+ port.operation.graph_id + '.' + str(port.index))
pg.node(port.operation.graph_id, shape='square')
pg.view()
@@ -568,22 +566,26 @@ class SFG(AbstractOperation):
if self._operations_topological_order:
return self._operations_topological_order
- no_inputs_queue = deque(list(filter(lambda op: op.input_count == 0, self.operations)))
- remaining_inports_per_operation = {op: op.input_count for op in self.operations}
+ no_inputs_queue = deque(
+ list(filter(lambda op: op.input_count == 0, self.operations)))
+ remaining_inports_per_operation = {
+ op: op.input_count for op in self.operations}
# Maps number of input counts to a queue of seen objects with such a size.
seen_with_inputs_dict = defaultdict(deque)
seen = set()
top_order = []
- assert len(no_inputs_queue) > 0, "Illegal SFG state, dangling signals in SFG."
+ assert len(
+ no_inputs_queue) > 0, "Illegal SFG state, dangling signals in SFG."
first_op = no_inputs_queue.popleft()
visited = set([first_op])
p_queue = PriorityQueue()
p_queue_entry_num = it.count()
# Negative priority as max-heap popping is wanted
- p_queue.put((-first_op.output_count, -next(p_queue_entry_num), first_op))
+ p_queue.put((-first_op.output_count, -
+ next(p_queue_entry_num), first_op))
operations_left = len(self.operations) - 1
@@ -604,23 +606,27 @@ class SFG(AbstractOperation):
remaining_inports = remaining_inports_per_operation[neighbor_op]
if remaining_inports == 0:
- p_queue.put((-neighbor_op.output_count, -next(p_queue_entry_num), neighbor_op))
+ p_queue.put(
+ (-neighbor_op.output_count, -next(p_queue_entry_num), neighbor_op))
elif remaining_inports > 0:
if neighbor_op in seen:
- seen_with_inputs_dict[remaining_inports + 1].remove(neighbor_op)
+ seen_with_inputs_dict[remaining_inports +
+ 1].remove(neighbor_op)
else:
seen.add(neighbor_op)
seen_but_not_visited_count += 1
- seen_with_inputs_dict[remaining_inports].append(neighbor_op)
+ seen_with_inputs_dict[remaining_inports].append(
+ neighbor_op)
# Check if have to fetch Operations from somewhere else since p_queue is empty
if operations_left > 0:
# First check if can fetch from Operations with no input ports
if no_inputs_queue:
new_op = no_inputs_queue.popleft()
- p_queue.put((-new_op.output_count, -next(p_queue_entry_num), new_op))
+ p_queue.put((-new_op.output_count, -
+ next(p_queue_entry_num), new_op))
# Else fetch operation with lowest input count that is not zero
elif seen_but_not_visited_count > 0:
@@ -628,7 +634,8 @@ class SFG(AbstractOperation):
seen_inputs_queue = seen_with_inputs_dict[i]
if seen_inputs_queue:
new_op = seen_inputs_queue.popleft()
- p_queue.put((-new_op.output_count, -next(p_queue_entry_num), new_op))
+ p_queue.put((-new_op.output_count, -
+ next(p_queue_entry_num), new_op))
seen_but_not_visited_count -= 1
break
else:
@@ -636,17 +643,46 @@ class SFG(AbstractOperation):
self._operations_topological_order = top_order
return self._operations_topological_order
-
+
def set_latency_of_type(self, type_name: TypeName, latency: int) -> None:
- """TODO: docstring"""
- for op in self.get_components_with_type_name(type_name):
+ """Set the latency of all components with the given type name."""
+ for op in self.find_by_type_name(type_name):
op.set_latency(latency)
def set_latency_offsets_of_type(self, type_name: TypeName, latency_offsets: Dict[str, int]) -> None:
- """TODO: docstring"""
- for op in self.get_components_with_type_name(type_name):
+ """Set the latency offset of all components with the given type name."""
+ for op in self.find_by_type_name(type_name):
op.set_latency_offsets(latency_offsets)
+ def _traverse_for_precedence_list(self, first_iter_ports: List[OutputPort]) -> List[List[OutputPort]]:
+ # Find dependencies of output ports and input ports.
+ remaining_inports_per_operation = {
+ op: op.input_count for op in self.operations}
+
+ # Traverse output ports for precedence
+ curr_iter_ports = first_iter_ports
+ precedence_list = []
+
+ while curr_iter_ports:
+ # Add the found ports to the current iter
+ precedence_list.append(curr_iter_ports)
+
+ next_iter_ports = []
+
+ for outport in curr_iter_ports:
+ for signal in outport.signals:
+ new_inport = signal.destination
+ # Don't traverse over delays.
+ if new_inport is not None and not isinstance(new_inport.operation, Delay):
+ new_op = new_inport.operation
+ remaining_inports_per_operation[new_op] -= 1
+ if remaining_inports_per_operation[new_op] == 0:
+ next_iter_ports.extend(new_op.outputs)
+
+ curr_iter_ports = next_iter_ports
+
+ return precedence_list
+
def _add_component_unconnected_copy(self, original_component: GraphComponent) -> GraphComponent:
assert original_component not in self._original_components_to_new, "Tried to add duplicate SFG component"
new_component = original_component.copy_component()
@@ -680,18 +716,24 @@ class SFG(AbstractOperation):
if original_signal in self._original_input_signals_to_indices:
# New signal already created during first step of constructor.
new_signal = self._original_components_to_new[original_signal]
- new_signal.set_destination(new_op.input(original_input_port.index))
+ new_signal.set_destination(
+ new_op.input(original_input_port.index))
- self._components_dfs_order.extend([new_signal, new_signal.source.operation])
- self._operations_dfs_order.append(new_signal.source.operation)
+ self._components_dfs_order.extend(
+ [new_signal, new_signal.source.operation])
+ self._operations_dfs_order.append(
+ new_signal.source.operation)
# Check if the signal has not been added before.
elif original_signal not in self._original_components_to_new:
if original_signal.source is None:
- raise ValueError("Dangling signal without source in SFG")
+ raise ValueError(
+ "Dangling signal without source in SFG")
- new_signal = self._add_component_unconnected_copy(original_signal)
- new_signal.set_destination(new_op.input(original_input_port.index))
+ new_signal = self._add_component_unconnected_copy(
+ original_signal)
+ new_signal.set_destination(
+ new_op.input(original_input_port.index))
self._components_dfs_order.append(new_signal)
@@ -703,8 +745,10 @@ class SFG(AbstractOperation):
original_signal.source.index))
else:
# Create new operation, set signal source to it.
- new_connected_op = self._add_component_unconnected_copy(original_connected_op)
- new_signal.set_source(new_connected_op.output(original_signal.source.index))
+ new_connected_op = self._add_component_unconnected_copy(
+ original_connected_op)
+ new_signal.set_source(new_connected_op.output(
+ original_signal.source.index))
self._components_dfs_order.append(new_connected_op)
self._operations_dfs_order.append(new_connected_op)
@@ -719,18 +763,24 @@ class SFG(AbstractOperation):
if original_signal in self._original_output_signals_to_indices:
# New signal already created during first step of constructor.
new_signal = self._original_components_to_new[original_signal]
- new_signal.set_source(new_op.output(original_output_port.index))
+ new_signal.set_source(
+ new_op.output(original_output_port.index))
- self._components_dfs_order.extend([new_signal, new_signal.destination.operation])
- self._operations_dfs_order.append(new_signal.destination.operation)
+ self._components_dfs_order.extend(
+ [new_signal, new_signal.destination.operation])
+ self._operations_dfs_order.append(
+ new_signal.destination.operation)
# Check if signal has not been added before.
elif original_signal not in self._original_components_to_new:
if original_signal.source is None:
- raise ValueError("Dangling signal without source in SFG")
+ raise ValueError(
+ "Dangling signal without source in SFG")
- new_signal = self._add_component_unconnected_copy(original_signal)
- new_signal.set_source(new_op.output(original_output_port.index))
+ new_signal = self._add_component_unconnected_copy(
+ original_signal)
+ new_signal.set_source(
+ new_op.output(original_output_port.index))
self._components_dfs_order.append(new_signal)
@@ -742,8 +792,10 @@ class SFG(AbstractOperation):
original_signal.destination.index))
else:
# Create new operation, set destination to it.
- new_connected_op = self._add_component_unconnected_copy(original_connected_op)
- new_signal.set_destination(new_connected_op.input(original_signal.destination.index))
+ new_connected_op = self._add_component_unconnected_copy(
+ original_connected_op)
+ new_signal.set_destination(new_connected_op.input(
+ original_signal.destination.index))
self._components_dfs_order.append(new_connected_op)
self._operations_dfs_order.append(new_connected_op)
@@ -752,39 +804,30 @@ class SFG(AbstractOperation):
op_stack.append(original_connected_op)
def _evaluate_source(self, src: OutputPort, results: MutableResultMap, delays: MutableDelayMap, prefix: str, bits_override: Optional[int], truncate: bool, deferred_delays: DelayQueue) -> Number:
- key_base = (prefix + "." + src.operation.graph_id) if prefix else src.operation.graph_id
+ key_base = (
+ prefix + "." + src.operation.graph_id) if prefix else src.operation.graph_id
key = src.operation.key(src.index, key_base)
if key in results:
value = results[key]
if value is None:
- raise RuntimeError("Direct feedback loop detected when evaluating operation.")
+ raise RuntimeError(
+ "Direct feedback loop detected when evaluating operation.")
return value
-
+
value = src.operation.current_output(src.index, delays, key_base)
results[key] = value
if value is None:
- value = self._do_evaluate_source(key_base, key, src, results, delays, prefix, bits_override, truncate, deferred_delays)
+ value = self._do_evaluate_source(
+ key_base, key, src, results, delays, prefix, bits_override, truncate, deferred_delays)
else:
- deferred_delays.append((key_base, key, src)) # Evaluate later. Use current value for now.
+ # Evaluate later. Use current value for now.
+ deferred_delays.append((key_base, key, src))
return value
def _do_evaluate_source(self, key_base: str, key: ResultKey, src: OutputPort, results: MutableResultMap, delays: MutableDelayMap, prefix: str, bits_override: Optional[int], truncate: bool, deferred_delays: DelayQueue) -> Number:
- input_values = [self._evaluate_source(input_port.signals[0].source, results, delays, prefix, bits_override, truncate, deferred_delays) for input_port in src.operation.inputs]
- value = src.operation.evaluate_output(src.index, input_values, results, delays, key_base, bits_override, truncate)
+ input_values = [self._evaluate_source(input_port.signals[0].source, results, delays, prefix,
+ bits_override, truncate, deferred_delays) for input_port in src.operation.inputs]
+ value = src.operation.evaluate_output(
+ src.index, input_values, results, delays, key_base, bits_override, truncate)
results[key] = value
return value
-
- def _inputs_required_for_source(self, src: OutputPort, visited: MutableSet[Operation]) -> Sequence[bool]:
- if src.operation in visited:
- return []
- visited.add(src.operation)
-
- if isinstance(src.operation, Input):
- for i, input_operation in enumerate(self._input_operations):
- if input_operation is src.operation:
- return [i]
-
- input_indices = []
- for i in src.operation.inputs_required_for_output(src.index):
- input_indices.extend(self._inputs_required_for_source(src.operation.input(i).signals[0].source, visited))
- return input_indices
diff --git a/b_asic/simulation.py b/b_asic/simulation.py
index 7829d171a38ff74c9a90b513e5a21034727e7492..5fece8d78f08b5273313bedf7e0a7bdbeebe483b 100644
--- a/b_asic/simulation.py
+++ b/b_asic/simulation.py
@@ -1,6 +1,6 @@
-"""@package docstring
-B-ASIC Simulation Module.
-TODO: More info.
+"""B-ASIC Simulation Module.
+
+Contains a class for simulating the result of an SFG given a set of input values.
"""
import numpy as np
@@ -20,8 +20,10 @@ InputProvider = Union[Number, Sequence[Number], InputFunction]
class Simulation:
- """Simulation.
- TODO: More info.
+ """Simulation of an SFG.
+
+ Use FastSimulation (from the C++ extension module) for a more effective
+ simulation when running many iterations.
"""
_sfg: SFG
@@ -32,11 +34,13 @@ class Simulation:
_input_length: Optional[int]
def __init__(self, sfg: SFG, input_providers: Optional[Sequence[Optional[InputProvider]]] = None):
- self._sfg = sfg
+ """Construct a Simulation of an SFG."""
+ self._sfg = sfg() # Copy the SFG to make sure it's not modified from the outside.
self._results = defaultdict(list)
self._delays = {}
self._iteration = 0
- self._input_functions = [lambda _: 0 for _ in range(self._sfg.input_count)]
+ self._input_functions = [
+ lambda _: 0 for _ in range(self._sfg.input_count)]
self._input_length = None
if input_providers is not None:
self.set_inputs(input_providers)
@@ -54,13 +58,15 @@ class Simulation:
if self._input_length is None:
self._input_length = len(input_provider)
elif self._input_length != len(input_provider):
- raise ValueError(f"Inconsistent input length for simulation (was {self._input_length}, got {len(input_provider)})")
+ raise ValueError(
+ f"Inconsistent input length for simulation (was {self._input_length}, got {len(input_provider)})")
self._input_functions[index] = lambda n: input_provider[n]
def set_inputs(self, input_providers: Sequence[Optional[InputProvider]]) -> None:
"""Set the input functions used to get values for the inputs to the internal SFG."""
if len(input_providers) != self._sfg.input_count:
- raise ValueError(f"Wrong number of inputs supplied to simulation (expected {self._sfg.input_count}, got {len(input_providers)})")
+ raise ValueError(
+ f"Wrong number of inputs supplied to simulation (expected {self._sfg.input_count}, got {len(input_providers)})")
for index, input_provider in enumerate(input_providers):
if input_provider is not None:
self.set_input(index, input_provider)
@@ -75,9 +81,11 @@ class Simulation:
"""
result = []
while self._iteration < iteration:
- input_values = [self._input_functions[i](self._iteration) for i in range(self._sfg.input_count)]
+ input_values = [self._input_functions[i](
+ self._iteration) for i in range(self._sfg.input_count)]
results = {}
- result = self._sfg.evaluate_outputs(input_values, results, self._delays, "", bits_override, truncate)
+ result = self._sfg.evaluate_outputs(
+ input_values, results, self._delays, "", bits_override, truncate)
if save_results:
for key, value in results.items():
self._results[key].append(value)
diff --git a/b_asic/special_operations.py b/b_asic/special_operations.py
index 8c15c55aed2ab7821467b51e84750a86743bde7a..dc84f0bcb8186b0db31ca96551f2876f48b9b523 100644
--- a/b_asic/special_operations.py
+++ b/b_asic/special_operations.py
@@ -1,6 +1,7 @@
-"""@package docstring
-B-ASIC Special Operations Module.
-TODO: More info.
+"""B-ASIC Special Operations Module.
+
+Contains operations with special purposes that may be treated differently from
+normal operations in an SFG.
"""
from numbers import Number
@@ -13,10 +14,13 @@ from b_asic.port import SignalSourceProvider
class Input(AbstractOperation):
"""Input operation.
- TODO: More info.
+
+ Marks an input port to an SFG.
+ Its value will be updated on each iteration when simulating the SFG.
"""
def __init__(self, name: Name = ""):
+ """Construct an Input operation."""
super().__init__(input_count=0, output_count=1, name=name)
self.set_param("value", 0)
@@ -40,10 +44,14 @@ class Input(AbstractOperation):
class Output(AbstractOperation):
"""Output operation.
- TODO: More info.
+
+ Marks an output port to an SFG.
+ The SFG will forward its input to the corresponding output signal
+ destinations.
"""
def __init__(self, src0: Optional[SignalSourceProvider] = None, name: Name = ""):
+ """Construct an Output operation."""
super().__init__(input_count=1, output_count=0,
name=name, input_sources=[src0])
@@ -57,10 +65,13 @@ class Output(AbstractOperation):
class Delay(AbstractOperation):
"""Unit delay operation.
- TODO: More info.
+
+ Represents one unit of delay in a circuit, typically a clock cycle.
+ Can be thought of as a register or a D flip-flop.
"""
def __init__(self, src0: Optional[SignalSourceProvider] = None, initial_value: Number = 0, name: Name = ""):
+ """Construct a Delay operation."""
super().__init__(input_count=1, output_count=1,
name=name, input_sources=[src0])
self.set_param("initial_value", initial_value)
@@ -76,7 +87,7 @@ class Delay(AbstractOperation):
if delays is not None:
return delays.get(self.key(index, prefix), self.param("initial_value"))
return self.param("initial_value")
-
+
def evaluate_output(self, index: int, input_values: Sequence[Number], results: Optional[MutableResultMap] = None, delays: Optional[MutableDelayMap] = None, prefix: str = "", bits_override: Optional[int] = None, truncate: bool = True) -> Number:
if index != 0:
raise IndexError(
@@ -89,7 +100,8 @@ class Delay(AbstractOperation):
value = self.param("initial_value")
if delays is not None:
value = delays.get(key, value)
- delays[key] = self.truncate_inputs(input_values, bits_override)[0] if truncate else input_values[0]
+ delays[key] = self.truncate_inputs(input_values, bits_override)[
+ 0] if truncate else input_values[0]
if results is not None:
results[key] = value
return value
diff --git a/logo_tiny.png b/logo_tiny.png
new file mode 100644
index 0000000000000000000000000000000000000000..ae5359b69cdb0b04f1be87da750bccc9fbe16ac2
Binary files /dev/null and b/logo_tiny.png differ
diff --git a/setup.py b/setup.py
index 37a143a1ccdf4de1fd8b35d31c2d67e6cb1f78b3..e58603441c1c1c95a5870ce79f7a660fe025eaad 100644
--- a/setup.py
+++ b/setup.py
@@ -8,21 +8,25 @@ from setuptools.command.build_ext import build_ext
CMAKE_EXE = os.environ.get("CMAKE_EXE", shutil.which("cmake"))
+
class CMakeExtension(Extension):
- def __init__(self, name, sourcedir = ""):
+ def __init__(self, name, sourcedir=""):
super().__init__(name, sources=[])
self.sourcedir = os.path.abspath(sourcedir)
+
class CMakeBuild(build_ext):
def build_extension(self, ext):
if not isinstance(ext, CMakeExtension):
return super().build_extension(ext)
if not CMAKE_EXE:
- raise RuntimeError(f"Cannot build extension {ext.name}: CMake executable not found! Set the CMAKE_EXE environment variable or update your path.")
+ raise RuntimeError(
+ f"Cannot build extension {ext.name}: CMake executable not found! Set the CMAKE_EXE environment variable or update your path.")
cmake_build_type = "Debug" if self.debug else "Release"
- cmake_output_dir = os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.name)))
+ cmake_output_dir = os.path.abspath(
+ os.path.dirname(self.get_ext_fullpath(ext.name)))
cmake_configure_argv = [
CMAKE_EXE, ext.sourcedir,
"-DASIC_BUILDING_PYTHON_DISTRIBUTION=true",
@@ -43,7 +47,8 @@ class CMakeBuild(build_ext):
print(f"=== Configuring {ext.name} ===")
print(f"Temp dir: {self.build_temp}")
print(f"Output dir: {cmake_output_dir}")
- subprocess.check_call(cmake_configure_argv, cwd=self.build_temp, env=env)
+ subprocess.check_call(cmake_configure_argv,
+ cwd=self.build_temp, env=env)
print(f"=== Building {ext.name} ===")
print(f"Temp dir: {self.build_temp}")
@@ -53,32 +58,33 @@ class CMakeBuild(build_ext):
print()
+
setuptools.setup(
- name = "b-asic",
- version = "0.0.1",
- author = "Adam Jakobsson, Angus Lothian, Arvid Westerlund, Felix Goding, Ivar Härnqvist, Jacob Wahlman, Kevin Scott, Rasmus Karlsson",
- author_email = "adaja901@student.liu.se, anglo547@student.liu.se, arvwe160@student.liu.se, felgo673@student.liu.se, ivaha717@student.liu.se, jacwa448@student.liu.se, kevsc634@student.liu.se, raska119@student.liu.se",
- description = "Better ASIC Toolbox",
- long_description = open("README.md", "r").read(),
- long_description_content_type = "text/markdown",
- url = "https://gitlab.liu.se/PUM_TDDD96/B-ASIC",
- license = "MIT",
- classifiers = [
+ name="b-asic",
+ version="1.0.0",
+ author="Adam Jakobsson, Angus Lothian, Arvid Westerlund, Felix Goding, Ivar Härnqvist, Jacob Wahlman, Kevin Scott, Rasmus Karlsson",
+ author_email="adaja901@student.liu.se, anglo547@student.liu.se, arvwe160@student.liu.se, felgo673@student.liu.se, ivaha717@student.liu.se, jacwa448@student.liu.se, kevsc634@student.liu.se, raska119@student.liu.se",
+ description="Better ASIC Toolbox",
+ long_description=open("README.md", "r").read(),
+ long_description_content_type="text/markdown",
+ url="https://gitlab.liu.se/PUM_TDDD96/B-ASIC",
+ license="MIT",
+ classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
- python_requires = ">=3.6",
- install_requires = [
+ python_requires=">=3.6",
+ install_requires=[
"pybind11>=2.3.0",
"numpy",
"pyside2",
"graphviz",
"matplotlib"
],
- packages = ["b_asic", "b_asic/GUI"],
- ext_modules = [CMakeExtension("b_asic")],
- cmdclass = {"build_ext": CMakeBuild},
- zip_safe = False,
- include_package_data = True
+ packages=["b_asic", "b_asic/GUI"],
+ ext_modules=[CMakeExtension("b_asic")],
+ cmdclass={"build_ext": CMakeBuild},
+ zip_safe=False,
+ include_package_data=True
)
diff --git a/test/test_sfg.py b/test/test_sfg.py
index b71eaa477b32b198b76a0148867fb18424fbfdec..2124daa9f9694d395292485ed1036efe63c9c088 100644
--- a/test/test_sfg.py
+++ b/test/test_sfg.py
@@ -7,8 +7,8 @@ import sys
from b_asic import SFG, Signal, Input, Output, Delay, FastSimulation
from b_asic.core_operations import Constant, Addition, Subtraction, Multiplication, \
-Division, Min, Max, SquareRoot, ComplexConjugate, Absolute, ConstantMultiplication, \
-Butterfly
+ Division, Min, Max, SquareRoot, ComplexConjugate, Absolute, ConstantMultiplication, \
+ Butterfly
from b_asic.save_load_structure import sfg_to_python, python_to_sfg
@@ -238,7 +238,7 @@ class TestReplaceComponents:
component_id = "add1"
sfg = sfg.replace_component(
- Multiplication(name="Multi"), _id=component_id)
+ Multiplication(name="Multi"), graph_id=component_id)
assert component_id not in sfg._components_by_id.keys()
assert "Multi" in sfg._components_by_name.keys()
@@ -247,17 +247,17 @@ class TestReplaceComponents:
component_id = "add3"
sfg = sfg.replace_component(
- Multiplication(name="Multi"), _id=component_id)
+ Multiplication(name="Multi"), graph_id=component_id)
assert "Multi" in sfg._components_by_name.keys()
assert component_id not in sfg._components_by_id.keys()
def test_replace_no_input_component(self, operation_tree):
sfg = SFG(outputs=[Output(operation_tree)])
component_id = "c1"
- _const = sfg.find_by_id(component_id)
+ const_ = sfg.find_by_id(component_id)
- sfg = sfg.replace_component(Constant(1), _id=component_id)
- assert _const is not sfg.find_by_id(component_id)
+ sfg = sfg.replace_component(Constant(1), graph_id=component_id)
+ assert const_ is not sfg.find_by_id(component_id)
def test_no_match_on_replace(self, large_operation_tree):
sfg = SFG(outputs=[Output(large_operation_tree)])
@@ -265,7 +265,7 @@ class TestReplaceComponents:
try:
sfg = sfg.replace_component(
- Multiplication(name="Multi"), _id=component_id)
+ Multiplication(name="Multi"), graph_id=component_id)
except AssertionError:
assert True
else:
@@ -277,7 +277,7 @@ class TestReplaceComponents:
try:
sfg = sfg.replace_component(
- Multiplication(name="Multi"), _id=component_id)
+ Multiplication(name="Multi"), graph_id=component_id)
except AssertionError:
assert True
else:
@@ -294,7 +294,7 @@ class TestConstructSFG:
sim = FastSimulation(sfg)
sim.step()
assert sim.results["0"][0].real == 2000
-
+
def test_1k_subtractions(self):
prev_op = Subtraction(Constant(0), Constant(2))
for _ in range(999):
@@ -303,7 +303,7 @@ class TestConstructSFG:
sim = FastSimulation(sfg)
sim.step()
assert sim.results["0"][0].real == -2000
-
+
def test_1k_butterfly(self):
prev_op_add = Addition(Constant(1), Constant(1))
prev_op_sub = Subtraction(Constant(-1), Constant(1))
@@ -312,7 +312,8 @@ class TestConstructSFG:
for _ in range(499):
prev_op_sub = Subtraction(prev_op_sub, Constant(2))
butterfly = Butterfly(prev_op_add, prev_op_sub)
- sfg = SFG(outputs=[Output(butterfly.output(0)), Output(butterfly.output(1))])
+ sfg = SFG(outputs=[Output(butterfly.output(0)),
+ Output(butterfly.output(1))])
sim = FastSimulation(sfg)
sim.step()
assert sim.results["0"][0].real == 0
@@ -397,19 +398,25 @@ class TestInsertComponent:
sfg = SFG(outputs=[Output(large_operation_tree_names)])
sqrt = SquareRoot()
- _sfg = sfg.insert_operation(sqrt, sfg.find_by_name("constant4")[0].graph_id)
+ _sfg = sfg.insert_operation(
+ sqrt, sfg.find_by_name("constant4")[0].graph_id)
assert _sfg.evaluate() != sfg.evaluate()
assert any([isinstance(comp, SquareRoot) for comp in _sfg.operations])
- assert not any([isinstance(comp, SquareRoot) for comp in sfg.operations])
+ assert not any([isinstance(comp, SquareRoot)
+ for comp in sfg.operations])
- assert not isinstance(sfg.find_by_name("constant4")[0].output(0).signals[0].destination.operation, SquareRoot)
- assert isinstance(_sfg.find_by_name("constant4")[0].output(0).signals[0].destination.operation, SquareRoot)
+ assert not isinstance(sfg.find_by_name("constant4")[0].output(
+ 0).signals[0].destination.operation, SquareRoot)
+ assert isinstance(_sfg.find_by_name("constant4")[0].output(
+ 0).signals[0].destination.operation, SquareRoot)
- assert sfg.find_by_name("constant4")[0].output(0).signals[0].destination.operation is sfg.find_by_id("add3")
+ assert sfg.find_by_name("constant4")[0].output(
+ 0).signals[0].destination.operation is sfg.find_by_id("add3")
assert _sfg.find_by_name("constant4")[0].output(
0).signals[0].destination.operation is not _sfg.find_by_id("add3")
- assert _sfg.find_by_id("sqrt1").output(0).signals[0].destination.operation is _sfg.find_by_id("add3")
+ assert _sfg.find_by_id("sqrt1").output(
+ 0).signals[0].destination.operation is _sfg.find_by_id("add3")
def test_insert_invalid_component_in_sfg(self, large_operation_tree):
sfg = SFG(outputs=[Output(large_operation_tree)])
@@ -443,8 +450,10 @@ class TestInsertComponent:
1).signals[0].destination.operation is _sfg.find_by_name("n_bfly")[0]
# Correctly connected new input -> old output
- assert _sfg.find_by_name("n_bfly")[0].input(0).signals[0].source.operation is _sfg.find_by_name("bfly3")[0]
- assert _sfg.find_by_name("n_bfly")[0].input(1).signals[0].source.operation is _sfg.find_by_name("bfly3")[0]
+ assert _sfg.find_by_name("n_bfly")[0].input(
+ 0).signals[0].source.operation is _sfg.find_by_name("bfly3")[0]
+ assert _sfg.find_by_name("n_bfly")[0].input(
+ 1).signals[0].source.operation is _sfg.find_by_name("bfly3")[0]
# Correctly connected new output -> next input
assert _sfg.find_by_name("n_bfly")[0].output(
@@ -453,8 +462,10 @@ class TestInsertComponent:
1).signals[0].destination.operation is _sfg.find_by_name("bfly2")[0]
# Correctly connected next input -> new output
- assert _sfg.find_by_name("bfly2")[0].input(0).signals[0].source.operation is _sfg.find_by_name("n_bfly")[0]
- assert _sfg.find_by_name("bfly2")[0].input(1).signals[0].source.operation is _sfg.find_by_name("n_bfly")[0]
+ assert _sfg.find_by_name("bfly2")[0].input(
+ 0).signals[0].source.operation is _sfg.find_by_name("n_bfly")[0]
+ assert _sfg.find_by_name("bfly2")[0].input(
+ 1).signals[0].source.operation is _sfg.find_by_name("n_bfly")[0]
class TestFindComponentsWithTypeName:
@@ -477,19 +488,19 @@ class TestFindComponentsWithTypeName:
mac_sfg = SFG(inputs=[inp1, inp2], outputs=[out1], name="mac_sfg")
- assert {comp.name for comp in mac_sfg.get_components_with_type_name(
+ assert {comp.name for comp in mac_sfg.find_by_type_name(
inp1.type_name())} == {"INP1", "INP2", "INP3"}
- assert {comp.name for comp in mac_sfg.get_components_with_type_name(
+ assert {comp.name for comp in mac_sfg.find_by_type_name(
add1.type_name())} == {"ADD1", "ADD2"}
- assert {comp.name for comp in mac_sfg.get_components_with_type_name(
+ assert {comp.name for comp in mac_sfg.find_by_type_name(
mul1.type_name())} == {"MUL1"}
- assert {comp.name for comp in mac_sfg.get_components_with_type_name(
+ assert {comp.name for comp in mac_sfg.find_by_type_name(
out1.type_name())} == {"OUT1"}
- assert {comp.name for comp in mac_sfg.get_components_with_type_name(
+ assert {comp.name for comp in mac_sfg.find_by_type_name(
Signal.type_name())} == {"S1", "S2", "S3", "S4", "S5", "S6", "S7"}
@@ -814,32 +825,41 @@ class TestTopologicalOrderOperations:
def test_feedback_sfg(self, sfg_simple_filter):
topological_order = sfg_simple_filter.get_operations_topological_order()
- assert [comp.name for comp in topological_order] == ["IN1", "ADD1", "T1", "CMUL1", "OUT1"]
+ assert [comp.name for comp in topological_order] == [
+ "IN1", "ADD1", "T1", "CMUL1", "OUT1"]
def test_multiple_independent_inputs(self, sfg_two_inputs_two_outputs_independent):
topological_order = sfg_two_inputs_two_outputs_independent.get_operations_topological_order()
- assert [comp.name for comp in topological_order] == ["IN1", "OUT1", "IN2", "C1", "ADD1", "OUT2"]
+ assert [comp.name for comp in topological_order] == [
+ "IN1", "OUT1", "IN2", "C1", "ADD1", "OUT2"]
def test_complex_graph(self, precedence_sfg_delays):
topological_order = precedence_sfg_delays.get_operations_topological_order()
assert [comp.name for comp in topological_order] == \
- ['IN1', 'C0', 'ADD1', 'Q1', 'A0', 'T1', 'B1', 'A1', 'T2', 'B2', 'ADD2', 'A2', 'ADD3', 'ADD4', 'OUT1']
+ ['IN1', 'C0', 'ADD1', 'Q1', 'A0', 'T1', 'B1', 'A1',
+ 'T2', 'B2', 'ADD2', 'A2', 'ADD3', 'ADD4', 'OUT1']
class TestRemove:
def test_remove_single_input_outputs(self, sfg_simple_filter):
new_sfg = sfg_simple_filter.remove_operation("cmul1")
- assert set(op.name for op in sfg_simple_filter.find_by_name("T1")[0].subsequent_operations) == {"CMUL1", "OUT1"}
- assert set(op.name for op in new_sfg.find_by_name("T1")[0].subsequent_operations) == {"ADD1", "OUT1"}
+ assert set(op.name for op in sfg_simple_filter.find_by_name(
+ "T1")[0].subsequent_operations) == {"CMUL1", "OUT1"}
+ assert set(op.name for op in new_sfg.find_by_name("T1")[
+ 0].subsequent_operations) == {"ADD1", "OUT1"}
- assert set(op.name for op in sfg_simple_filter.find_by_name("ADD1")[0].preceding_operations) == {"CMUL1", "IN1"}
- assert set(op.name for op in new_sfg.find_by_name("ADD1")[0].preceding_operations) == {"T1", "IN1"}
+ assert set(op.name for op in sfg_simple_filter.find_by_name(
+ "ADD1")[0].preceding_operations) == {"CMUL1", "IN1"}
+ assert set(op.name for op in new_sfg.find_by_name(
+ "ADD1")[0].preceding_operations) == {"T1", "IN1"}
- assert "S1" in set([sig.name for sig in sfg_simple_filter.find_by_name("T1")[0].output(0).signals])
- assert "S2" in set([sig.name for sig in new_sfg.find_by_name("T1")[0].output(0).signals])
+ assert "S1" in set(
+ [sig.name for sig in sfg_simple_filter.find_by_name("T1")[0].output(0).signals])
+ assert "S2" in set(
+ [sig.name for sig in new_sfg.find_by_name("T1")[0].output(0).signals])
def test_remove_multiple_inputs_outputs(self, butterfly_operation_tree):
out1 = Output(butterfly_operation_tree.output(0), "OUT1")
@@ -852,8 +872,10 @@ class TestRemove:
assert sfg.find_by_name("bfly3")[0].output(0).signal_count == 1
assert new_sfg.find_by_name("bfly3")[0].output(0).signal_count == 1
- sfg_dest_0 = sfg.find_by_name("bfly3")[0].output(0).signals[0].destination
- new_sfg_dest_0 = new_sfg.find_by_name("bfly3")[0].output(0).signals[0].destination
+ sfg_dest_0 = sfg.find_by_name(
+ "bfly3")[0].output(0).signals[0].destination
+ new_sfg_dest_0 = new_sfg.find_by_name(
+ "bfly3")[0].output(0).signals[0].destination
assert sfg_dest_0.index == 0
assert new_sfg_dest_0.index == 0
@@ -863,8 +885,10 @@ class TestRemove:
assert sfg.find_by_name("bfly3")[0].output(1).signal_count == 1
assert new_sfg.find_by_name("bfly3")[0].output(1).signal_count == 1
- sfg_dest_1 = sfg.find_by_name("bfly3")[0].output(1).signals[0].destination
- new_sfg_dest_1 = new_sfg.find_by_name("bfly3")[0].output(1).signals[0].destination
+ sfg_dest_1 = sfg.find_by_name(
+ "bfly3")[0].output(1).signals[0].destination
+ new_sfg_dest_1 = new_sfg.find_by_name(
+ "bfly3")[0].output(1).signals[0].destination
assert sfg_dest_1.index == 1
assert new_sfg_dest_1.index == 1
@@ -875,7 +899,8 @@ class TestRemove:
assert new_sfg.find_by_name("bfly1")[0].input(0).signal_count == 1
sfg_source_0 = sfg.find_by_name("bfly1")[0].input(0).signals[0].source
- new_sfg_source_0 = new_sfg.find_by_name("bfly1")[0].input(0).signals[0].source
+ new_sfg_source_0 = new_sfg.find_by_name(
+ "bfly1")[0].input(0).signals[0].source
assert sfg_source_0.index == 0
assert new_sfg_source_0.index == 0
@@ -883,7 +908,8 @@ class TestRemove:
assert new_sfg_source_0.operation.name == "bfly3"
sfg_source_1 = sfg.find_by_name("bfly1")[0].input(1).signals[0].source
- new_sfg_source_1 = new_sfg.find_by_name("bfly1")[0].input(1).signals[0].source
+ new_sfg_source_1 = new_sfg.find_by_name(
+ "bfly1")[0].input(1).signals[0].source
assert sfg_source_1.index == 1
assert new_sfg_source_1.index == 1
@@ -901,7 +927,8 @@ class TestSaveLoadSFG:
def get_path(self, existing=False):
path_ = "".join(random.choices(string.ascii_uppercase, k=4)) + ".py"
while path.exists(path_) if not existing else not path.exists(path_):
- path_ = "".join(random.choices(string.ascii_uppercase, k=4)) + ".py"
+ path_ = "".join(random.choices(
+ string.ascii_uppercase, k=4)) + ".py"
return path_
@@ -964,7 +991,8 @@ class TestSaveLoadSFG:
precedence_sfg_registers_and_constants_, _ = python_to_sfg(path_)
- assert str(precedence_sfg_delays_and_constants) == str(precedence_sfg_registers_and_constants_)
+ assert str(precedence_sfg_delays_and_constants) == str(
+ precedence_sfg_registers_and_constants_)
remove(path_)
@@ -976,15 +1004,15 @@ class TestSaveLoadSFG:
class TestGetComponentsOfType:
def test_get_no_operations_of_type(self, sfg_two_inputs_two_outputs):
- assert [op.name for op in sfg_two_inputs_two_outputs.get_components_with_type_name(Multiplication.type_name())] \
+ assert [op.name for op in sfg_two_inputs_two_outputs.find_by_type_name(Multiplication.type_name())] \
== []
def test_get_multple_operations_of_type(self, sfg_two_inputs_two_outputs):
- assert [op.name for op in sfg_two_inputs_two_outputs.get_components_with_type_name(Addition.type_name())] \
+ assert [op.name for op in sfg_two_inputs_two_outputs.find_by_type_name(Addition.type_name())] \
== ["ADD1", "ADD2"]
- assert [op.name for op in sfg_two_inputs_two_outputs.get_components_with_type_name(Input.type_name())] \
+ assert [op.name for op in sfg_two_inputs_two_outputs.find_by_type_name(Input.type_name())] \
== ["IN1", "IN2"]
- assert [op.name for op in sfg_two_inputs_two_outputs.get_components_with_type_name(Output.type_name())] \
+ assert [op.name for op in sfg_two_inputs_two_outputs.find_by_type_name(Output.type_name())] \
== ["OUT1", "OUT2"]