kopia lustrzana https://github.com/Dsplib/libdspl-2.0
changed documteation groups
Dsplib
rodzic
973a6495c6
commit
8cea265a9b
334
dox/doxyfile_ru
334
dox/doxyfile_ru
|
|
@ -1,4 +1,4 @@
|
|||
# Doxyfile 1.8.10
|
||||
# Doxyfile 1.8.15
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
# doxygen (www.doxygen.org) for a project.
|
||||
|
|
@ -17,11 +17,11 @@
|
|||
# Project related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# This tag specifies the encoding used for all characters in the config file
|
||||
# that follow. The default is UTF-8 which is also the encoding used for all text
|
||||
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
|
||||
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
|
||||
# for the list of possible encodings.
|
||||
# This tag specifies the encoding used for all characters in the 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
|
||||
|
|
@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
|||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
PROJECT_NAME =
|
||||
PROJECT_NAME = libdspl-2.0
|
||||
|
||||
# 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 =
|
||||
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
|
||||
|
|
@ -93,6 +93,14 @@ ALLOW_UNICODE_NAMES = YES
|
|||
|
||||
OUTPUT_LANGUAGE = Russian
|
||||
|
||||
# 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.
|
||||
|
|
@ -135,7 +143,7 @@ ABBREVIATE_BRIEF = "The $name class" \
|
|||
# description.
|
||||
# The default value is: NO.
|
||||
|
||||
ALWAYS_DETAILED_SEC = NO
|
||||
ALWAYS_DETAILED_SEC = YES
|
||||
|
||||
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
||||
# inherited members of a class in the documentation of that class as if those
|
||||
|
|
@ -162,7 +170,7 @@ FULL_PATH_NAMES = YES
|
|||
# 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 =
|
||||
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
|
||||
|
|
@ -171,7 +179,7 @@ STRIP_FROM_PATH =
|
|||
# specify the list of include paths that are normally passed to the compiler
|
||||
# using the -I flag.
|
||||
|
||||
STRIP_FROM_INC_PATH =
|
||||
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
|
||||
|
|
@ -236,15 +244,20 @@ TAB_SIZE = 2
|
|||
# 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.
|
||||
# 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 =
|
||||
ALIASES =
|
||||
|
||||
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
||||
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
||||
# will allow you to use the command class in the itcl::class meaning.
|
||||
|
||||
TCL_SUBST =
|
||||
TCL_SUBST =
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
||||
# only. Doxygen will then generate output that is more tailored for C. For
|
||||
|
|
@ -274,28 +287,37 @@ OPTIMIZE_FOR_FORTRAN = 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,
|
||||
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
|
||||
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
|
||||
# Fortran. In the later case the parser tries to guess whether the code is fixed
|
||||
# or free formatted code, this is the default for Fortran type files), VHDL. 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.
|
||||
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
|
||||
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
|
||||
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
|
||||
# tries to guess whether the code is fixed or free formatted code, this is the
|
||||
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
|
||||
# .inc files as Fortran files (default is PHP), and .f files as C (default is
|
||||
# Fortran), use: inc=Fortran f=C.
|
||||
#
|
||||
# Note: For files without extension you can use no_extension as a placeholder.
|
||||
#
|
||||
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
||||
# the files are not read by doxygen.
|
||||
|
||||
EXTENSION_MAPPING =
|
||||
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 http://daringfireball.net/projects/markdown/ for details.
|
||||
# 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.
|
||||
|
|
@ -303,6 +325,15 @@ EXTENSION_MAPPING =
|
|||
|
||||
MARKDOWN_SUPPORT = YES
|
||||
|
||||
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
|
||||
# to that level are automatically included in the table of contents, even if
|
||||
# they do not have an id attribute.
|
||||
# Note: This feature currently applies only to Markdown headings.
|
||||
# Minimum value: 0, maximum value: 99, default value: 0.
|
||||
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
|
||||
|
||||
TOC_INCLUDE_HEADINGS = 0
|
||||
|
||||
# When enabled doxygen tries to link words that correspond to documented
|
||||
# classes, or namespaces to their corresponding documentation. Such a link can
|
||||
# be prevented in individual cases by putting a % sign in front of the word or
|
||||
|
|
@ -328,7 +359,7 @@ BUILTIN_STL_SUPPORT = NO
|
|||
CPP_CLI_SUPPORT = NO
|
||||
|
||||
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
|
||||
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
|
||||
# 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.
|
||||
|
|
@ -639,7 +670,7 @@ GENERATE_DEPRECATEDLIST= YES
|
|||
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
|
||||
# ... \endcond blocks.
|
||||
|
||||
ENABLED_SECTIONS =
|
||||
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
|
||||
|
|
@ -681,7 +712,7 @@ SHOW_NAMESPACES = YES
|
|||
# by doxygen. Whatever the program writes to standard output is used as the file
|
||||
# version. For an example see the documentation.
|
||||
|
||||
FILE_VERSION_FILTER =
|
||||
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
|
||||
|
|
@ -694,17 +725,17 @@ FILE_VERSION_FILTER =
|
|||
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
||||
# tag is left empty.
|
||||
|
||||
LAYOUT_FILE =
|
||||
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 http://en.wikipedia.org/wiki/BibTeX for more info.
|
||||
# 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 =
|
||||
CITE_BIB_FILES =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to warning and progress messages
|
||||
|
|
@ -744,11 +775,18 @@ 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.
|
||||
# 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
|
||||
|
|
@ -763,7 +801,7 @@ WARN_FORMAT = "$file:$line: $text"
|
|||
# messages should be written. If left blank the output is written to standard
|
||||
# error (stderr).
|
||||
|
||||
WARN_LOGFILE =
|
||||
WARN_LOGFILE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the input files
|
||||
|
|
@ -786,7 +824,7 @@ INPUT = ru \
|
|||
# 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: http://www.gnu.org/software/libiconv) for the list of
|
||||
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
|
||||
# possible encodings.
|
||||
# The default value is: UTF-8.
|
||||
|
||||
|
|
@ -803,8 +841,8 @@ INPUT_ENCODING = UTF-8
|
|||
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
|
||||
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
|
||||
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
|
||||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
|
||||
# *.vhdl, *.ucf, *.qsf, *.as and *.js.
|
||||
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
|
||||
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
|
||||
|
||||
FILE_PATTERNS = *.c \
|
||||
*.cc \
|
||||
|
|
@ -864,7 +902,7 @@ RECURSIVE = YES
|
|||
# Note that relative paths are relative to the directory from which doxygen is
|
||||
# run.
|
||||
|
||||
EXCLUDE =
|
||||
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
|
||||
|
|
@ -880,7 +918,7 @@ EXCLUDE_SYMLINKS = NO
|
|||
# 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 =
|
||||
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
|
||||
|
|
@ -891,7 +929,7 @@ EXCLUDE_PATTERNS =
|
|||
# Note that the wildcards are matched against the file with absolute path, so to
|
||||
# exclude all test directories use the pattern */test/*
|
||||
|
||||
EXCLUDE_SYMBOLS =
|
||||
EXCLUDE_SYMBOLS =
|
||||
|
||||
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
|
||||
# that contain example code fragments that are included (see the \include
|
||||
|
|
@ -937,8 +975,12 @@ IMAGE_PATH = ru/img \
|
|||
# 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 =
|
||||
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
|
||||
|
|
@ -946,8 +988,12 @@ INPUT_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 =
|
||||
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
|
||||
|
|
@ -962,14 +1008,14 @@ FILTER_SOURCE_FILES = NO
|
|||
# *.ext= (so without naming a filter).
|
||||
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
|
||||
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
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 =
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
|
|
@ -998,7 +1044,7 @@ INLINE_SOURCES = NO
|
|||
STRIP_CODE_COMMENTS = YES
|
||||
|
||||
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
|
||||
# function all documented functions referencing it will be listed.
|
||||
# entity all documented functions referencing it will be listed.
|
||||
# The default value is: NO.
|
||||
|
||||
REFERENCED_BY_RELATION = YES
|
||||
|
|
@ -1030,12 +1076,12 @@ 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 http://www.gnu.org/software/global/global.html). You will need version
|
||||
# (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 config file
|
||||
# - 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
|
||||
#
|
||||
|
|
@ -1063,7 +1109,7 @@ VERBATIM_HEADERS = YES
|
|||
# rich C++ code for which doxygen's built-in parser lacks the necessary type
|
||||
# information.
|
||||
# Note: The availability of this option depends on whether or not doxygen was
|
||||
# compiled with the --with-libclang option.
|
||||
# generated with the -Duse_libclang=ON option for CMake.
|
||||
# The default value is: NO.
|
||||
|
||||
CLANG_ASSISTED_PARSING = NO
|
||||
|
|
@ -1074,7 +1120,17 @@ CLANG_ASSISTED_PARSING = NO
|
|||
# specified with INPUT and INCLUDE_PATH.
|
||||
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
|
||||
|
||||
CLANG_OPTIONS =
|
||||
CLANG_OPTIONS =
|
||||
|
||||
# If clang assisted parsing is enabled you can provide the clang parser with the
|
||||
# path to the compilation database (see:
|
||||
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
|
||||
# were built. This is equivalent to specifying the "-p" option to a clang tool,
|
||||
# such as clang-check. These options will then be passed to the parser.
|
||||
# Note: The availability of this option depends on whether or not doxygen was
|
||||
# generated with the -Duse_libclang=ON option for CMake.
|
||||
|
||||
CLANG_DATABASE_PATH =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the alphabetical class index
|
||||
|
|
@ -1100,7 +1156,7 @@ COLS_IN_ALPHA_INDEX = 5
|
|||
# while generating the index headers.
|
||||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
|
||||
|
||||
IGNORE_PREFIX =
|
||||
IGNORE_PREFIX =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the HTML output
|
||||
|
|
@ -1179,7 +1235,7 @@ HTML_STYLESHEET = doxy_stylesheet.css
|
|||
# list). For an example see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_EXTRA_STYLESHEET =
|
||||
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
|
||||
|
|
@ -1189,12 +1245,12 @@ HTML_EXTRA_STYLESHEET =
|
|||
# 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 =
|
||||
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
|
||||
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
|
||||
# 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.
|
||||
|
|
@ -1230,6 +1286,17 @@ HTML_COLORSTYLE_GAMMA = 80
|
|||
|
||||
HTML_TIMESTAMP = YES
|
||||
|
||||
# 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.
|
||||
|
|
@ -1253,13 +1320,13 @@ 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: http://developer.apple.com/tools/xcode/), introduced with
|
||||
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
|
||||
# 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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
||||
# for more information.
|
||||
# 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.
|
||||
|
||||
|
|
@ -1298,7 +1365,7 @@ 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: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
|
||||
# (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
|
||||
|
|
@ -1318,7 +1385,7 @@ GENERATE_HTMLHELP = NO
|
|||
# written to the html output directory.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
CHM_FILE =
|
||||
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,
|
||||
|
|
@ -1326,7 +1393,7 @@ CHM_FILE =
|
|||
# The file has to be specified with full path.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
HHC_LOCATION =
|
||||
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).
|
||||
|
|
@ -1339,7 +1406,7 @@ GENERATE_CHI = NO
|
|||
# and project file content.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
CHM_INDEX_ENCODING =
|
||||
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
|
||||
|
|
@ -1370,11 +1437,11 @@ GENERATE_QHP = NO
|
|||
# the HTML output folder.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QCH_FILE =
|
||||
QCH_FILE =
|
||||
|
||||
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
|
||||
# Project output. For more information please see Qt Help Project / Namespace
|
||||
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
|
||||
# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
|
||||
# The default value is: org.doxygen.Project.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
|
|
@ -1382,7 +1449,7 @@ QHP_NAMESPACE = org.doxygen.Project
|
|||
|
||||
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
|
||||
# Help Project output. For more information please see Qt Help Project / Virtual
|
||||
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
|
||||
# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
|
||||
# folders).
|
||||
# The default value is: doc.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
|
@ -1391,33 +1458,33 @@ QHP_VIRTUAL_FOLDER = doc
|
|||
|
||||
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
|
||||
# filter to add. For more information please see Qt Help Project / Custom
|
||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
|
||||
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
|
||||
# filters).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_CUST_FILTER_NAME =
|
||||
QHP_CUST_FILTER_NAME =
|
||||
|
||||
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
|
||||
# custom filter to add. For more information please see Qt Help Project / Custom
|
||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
|
||||
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
|
||||
# filters).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_CUST_FILTER_ATTRS =
|
||||
QHP_CUST_FILTER_ATTRS =
|
||||
|
||||
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
||||
# project's filter section matches. Qt Help Project / Filter Attributes (see:
|
||||
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
|
||||
# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_SECT_FILTER_ATTRS =
|
||||
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 =
|
||||
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
|
||||
|
|
@ -1500,7 +1567,7 @@ EXT_LINKS_IN_WINDOW = NO
|
|||
|
||||
FORMULA_FONTSIZE = 14
|
||||
|
||||
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
||||
# 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.
|
||||
#
|
||||
|
|
@ -1512,7 +1579,7 @@ FORMULA_FONTSIZE = 14
|
|||
FORMULA_TRANSPARENT = YES
|
||||
|
||||
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
||||
# http://www.mathjax.org) which uses client side Javascript for the rendering
|
||||
# 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
|
||||
|
|
@ -1539,8 +1606,8 @@ MATHJAX_FORMAT = HTML-CSS
|
|||
# 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 http://www.mathjax.org before deployment.
|
||||
# The default value is: http://cdn.mathjax.org/mathjax/latest.
|
||||
# MathJax from https://www.mathjax.org before deployment.
|
||||
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
||||
|
|
@ -1550,7 +1617,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
|||
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_EXTENSIONS =
|
||||
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
|
||||
|
|
@ -1558,7 +1625,7 @@ MATHJAX_EXTENSIONS =
|
|||
# example see the documentation.
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_CODEFILE =
|
||||
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
|
||||
|
|
@ -1601,7 +1668,7 @@ SERVER_BASED_SEARCH = NO
|
|||
#
|
||||
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
||||
# (doxysearch.cgi) which are based on the open source search engine library
|
||||
# Xapian (see: http://xapian.org/).
|
||||
# Xapian (see: https://xapian.org/).
|
||||
#
|
||||
# See the section "External Indexing and Searching" for details.
|
||||
# The default value is: NO.
|
||||
|
|
@ -1614,11 +1681,11 @@ EXTERNAL_SEARCH = NO
|
|||
#
|
||||
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
||||
# (doxysearch.cgi) which are based on the open source search engine library
|
||||
# Xapian (see: http://xapian.org/). See the section "External Indexing and
|
||||
# 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 =
|
||||
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
|
||||
|
|
@ -1634,7 +1701,7 @@ SEARCHDATA_FILE = searchdata.xml
|
|||
# projects and redirect the results back to the right project.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
EXTERNAL_SEARCH_ID =
|
||||
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
|
||||
|
|
@ -1644,7 +1711,7 @@ EXTERNAL_SEARCH_ID =
|
|||
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
EXTRA_SEARCH_MAPPINGS =
|
||||
EXTRA_SEARCH_MAPPINGS =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the LaTeX output
|
||||
|
|
@ -1666,21 +1733,34 @@ LATEX_OUTPUT = latex
|
|||
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
||||
# invoked.
|
||||
#
|
||||
# Note that when enabling USE_PDFLATEX this option is only used for generating
|
||||
# bitmaps for formulas in the HTML output, but not in the Makefile that is
|
||||
# written to the output directory.
|
||||
# The default file is: latex.
|
||||
# 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 = latex
|
||||
|
||||
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
|
||||
# index for LaTeX.
|
||||
# Note: This tag is used in the Makefile / make.bat.
|
||||
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
|
||||
# (.tex).
|
||||
# The default file is: makeindex.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
MAKEINDEX_CMD_NAME = makeindex
|
||||
|
||||
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
|
||||
# generate index for LaTeX.
|
||||
# Note: This tag is used in the generated output file (.tex).
|
||||
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
|
||||
# The default value is: \makeindex.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_MAKEINDEX_CMD = \makeindex
|
||||
|
||||
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
|
||||
# documents. This may be useful for small projects and may help to save some
|
||||
# trees in general.
|
||||
|
|
@ -1708,7 +1788,7 @@ PAPER_TYPE = a4
|
|||
# If left blank no extra packages will be included.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
EXTRA_PACKAGES =
|
||||
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
|
||||
|
|
@ -1724,7 +1804,7 @@ EXTRA_PACKAGES =
|
|||
# to HTML_HEADER.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_HEADER =
|
||||
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
|
||||
|
|
@ -1735,7 +1815,7 @@ LATEX_HEADER =
|
|||
# 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 =
|
||||
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
|
||||
|
|
@ -1746,7 +1826,7 @@ LATEX_FOOTER =
|
|||
# list).
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_EXTRA_STYLESHEET =
|
||||
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
|
||||
|
|
@ -1754,7 +1834,7 @@ LATEX_EXTRA_STYLESHEET =
|
|||
# markers available.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_EXTRA_FILES =
|
||||
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
|
||||
|
|
@ -1801,12 +1881,28 @@ 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
|
||||
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
|
||||
# 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
|
||||
#---------------------------------------------------------------------------
|
||||
|
|
@ -1846,22 +1942,22 @@ COMPACT_RTF = NO
|
|||
|
||||
RTF_HYPERLINKS = NO
|
||||
|
||||
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
|
||||
# file, i.e. a series of assignments. You only have to provide replacements,
|
||||
# missing definitions are set to their default value.
|
||||
# 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 =
|
||||
RTF_STYLESHEET_FILE =
|
||||
|
||||
# Set optional variables used in the generation of an RTF document. Syntax is
|
||||
# similar to doxygen's config file. A template extensions file can be generated
|
||||
# using doxygen -e rtf extensionFile.
|
||||
# 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 =
|
||||
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.
|
||||
|
|
@ -1906,7 +2002,7 @@ MAN_EXTENSION = .3
|
|||
# MAN_EXTENSION with the initial . removed.
|
||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||
|
||||
MAN_SUBDIR =
|
||||
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
|
||||
|
|
@ -1944,6 +2040,13 @@ XML_OUTPUT = xml
|
|||
|
||||
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
|
||||
#---------------------------------------------------------------------------
|
||||
|
|
@ -1976,9 +2079,9 @@ DOCBOOK_PROGRAMLISTING = NO
|
|||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
|
||||
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
|
||||
# structure of the code including all documentation. Note that this feature is
|
||||
# still experimental and incomplete at the moment.
|
||||
# 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
|
||||
|
|
@ -2019,7 +2122,7 @@ PERLMOD_PRETTY = YES
|
|||
# overwrite each other's variables.
|
||||
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
||||
|
||||
PERLMOD_MAKEVAR_PREFIX =
|
||||
PERLMOD_MAKEVAR_PREFIX =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
|
|
@ -2060,7 +2163,7 @@ SEARCH_INCLUDES = YES
|
|||
# preprocessor.
|
||||
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
|
||||
|
||||
INCLUDE_PATH =
|
||||
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
|
||||
|
|
@ -2068,7 +2171,7 @@ INCLUDE_PATH =
|
|||
# used.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
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.
|
||||
|
|
@ -2118,13 +2221,13 @@ SKIP_FUNCTION_MACROS = YES
|
|||
# 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 =
|
||||
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 =
|
||||
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
|
||||
|
|
@ -2173,14 +2276,14 @@ CLASS_DIAGRAMS = NO
|
|||
# the mscgen tool resides. If left empty the tool is assumed to be found in the
|
||||
# default search path.
|
||||
|
||||
MSCGEN_PATH =
|
||||
MSCGEN_PATH =
|
||||
|
||||
# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
||||
# then run dia to produce the diagram and insert it in the documentation. The
|
||||
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
||||
# If left empty dia is assumed to be found in the default search path.
|
||||
|
||||
DIA_PATH =
|
||||
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.
|
||||
|
|
@ -2229,7 +2332,7 @@ DOT_FONTSIZE = 10
|
|||
# the path where dot can find it using this tag.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_FONTPATH =
|
||||
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.
|
||||
|
|
@ -2373,26 +2476,26 @@ INTERACTIVE_SVG = NO
|
|||
# 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 =
|
||||
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 =
|
||||
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 =
|
||||
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 =
|
||||
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
|
||||
|
|
@ -2400,12 +2503,17 @@ DIAFILE_DIRS =
|
|||
# generate a warning when it encounters a \startuml command in this case and
|
||||
# will not generate output for the diagram.
|
||||
|
||||
PLANTUML_JAR_PATH =
|
||||
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 =
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,135 +1,115 @@
|
|||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def RES_OK
|
||||
\brief Функция завершилась корректно.
|
||||
Ошибки отсутствуют.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def RES_OK
|
||||
\brief Функция завершилась корректно. Ошибки отсутствуют.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_ELLIP_K
|
||||
\brief Модуль эллиптического интеграла Якоби должен быть от 0 до 1.
|
||||
Данная ошибка возникает при расчете эллиптических функций Якоби при неверном задании параметра эллиптического модуля.
|
||||
Функция завершает работу и возвращает данный код ошибки.
|
||||
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_ELLIP_K
|
||||
\brief Модуль эллиптического интеграла Якоби должен быть от 0 до 1.
|
||||
Данная ошибка возникает при расчете эллиптических функций Якоби при неверном задании параметра эллиптического модуля.
|
||||
Функция завершает работу и возвращает данный код ошибки.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FFT_SIZE
|
||||
\brief Неверно задан размер БПФ.
|
||||
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FFT_SIZE
|
||||
\brief Неверно задан размер БПФ.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_ORD
|
||||
\brief Порядок фильтра задан не верно. Порядок фильтра должен быть задан положительным целым значением.
|
||||
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_ORD
|
||||
\brief Порядок фильтра задан неверно. Порядок фильтра должен быть задан положительным целым значением.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_RP
|
||||
\brief Параметр неравномерности фильтра в полосе пропускания задан не верно.
|
||||
Данный параметр задается в дБ и должен быть положительным числом.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_RS
|
||||
\brief Параметр подавления фильтра в полосе заграждения задан не верно.
|
||||
Данный параметр задается в дБ и должен быть положительным числом.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_RP
|
||||
\brief Параметр неравномерности фильтра в полосе пропускания задан неверно.
|
||||
Данный параметр задается в дБ и должен быть положительным числом.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_WP
|
||||
\brief Параметр частоты среза фильтра задан не верно.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_RS
|
||||
\brief Параметр подавления фильтра в полосе заграждения задан неверно.
|
||||
Данный параметр задается в дБ и должен быть положительным числом.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_WP
|
||||
\brief Параметр частоты среза фильтра задан неверно.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_A0
|
||||
\brief Коэффициент \f$a_0\f$ знаменателя передаточной функции фильтра равен нулю.
|
||||
Необходимо задать параметр \f$a_0\f$ отличным от нуля.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FILTER_A0
|
||||
\brief Коэффициент \f$a_0\f$ знаменателя передаточной функции фильтра равен нулю.
|
||||
Необходимо задать параметр \f$a_0\f$ отличным от нуля.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FNAME
|
||||
\brief Ошибка в имени файла. Необходимо задать корректное имя файла.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FNAME
|
||||
\brief Ошибка в имени файла. Необходимо задать корректное имя файла.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FOPEN
|
||||
\brief Ошибка открытия файла. Файл с заданным именем не может быть открыт для записи и чтения.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FOPEN
|
||||
\brief Ошибка открытия файла. Файл с заданным именем не может быть открыт для записи и чтения.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FS
|
||||
\brief Частота дискретизации задана неверно. Частота дискретизации должна быть положительным числом.
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_FS
|
||||
\brief Частота дискретизации задана неверно. Частота дискретизации должна быть положительным числом.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_PTR
|
||||
\brief Ошибка указателя.
|
||||
Данная ошибка означает, что один из обязательных указателей
|
||||
(память под который должна быть выделена) передан как `NULL`. При возникновении данной ошибки,
|
||||
функция завершает работу и возвращает данный код ошибки.
|
||||
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_PTR
|
||||
\brief Ошибка указателя.
|
||||
Данная ошибка означает, что один из обязательных указателей
|
||||
(память под который должна быть выделена) передан как `NULL`.
|
||||
При возникновении данной ошибки, функция завершает работу
|
||||
и возвращает данный код ошибки.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_SIZE
|
||||
\brief Ошибка при передаче размера массива.
|
||||
Данная ошибка возникает когда помимо указателя
|
||||
на массив входных или выходных данных передается неверный размер массива (меньше или равный нулю).
|
||||
При возникновении данной ошибки,
|
||||
функция завершает работу и возвращает данный код ошибки.
|
||||
|
||||
\ingroup ERROR_CODE_GROUP
|
||||
\def ERROR_SIZE
|
||||
\brief Ошибка при передаче размера массива.
|
||||
Данная ошибка возникает когда помимо указателя
|
||||
на массив входных или выходных данных передается неверный размер массива (меньше или равный нулю).
|
||||
При возникновении данной ошибки,
|
||||
функция завершает работу и возвращает данный код ошибки.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,99 +1,59 @@
|
|||
/*!
|
||||
\defgroup MAIN_GROUP Библиотека DSPL
|
||||
|
||||
\defgroup GETTING_START Быстрый старт использования библиотеки DSPL
|
||||
\ingroup MAIN_GROUP
|
||||
\defgroup GETTING_START Быстрый старт использования библиотеки DSPL
|
||||
|
||||
\defgroup TYPES_GROUP Типы данных DSPL
|
||||
\ingroup MAIN_GROUP
|
||||
В данной группе описаны типы данных библиотеки DSPL и методы их преобразования.
|
||||
|
||||
\defgroup TYPES_GROUP Типы данных DSPL
|
||||
В данной группе описаны типы данных библиотеки DSPL и методы их преобразования.
|
||||
|
||||
|
||||
\defgroup DFT_GROUP Алгоритмы дискретного и быстрого преобразования Фурье
|
||||
Алгоритмы дискретного и быстрого преобразования Фурье.
|
||||
|
||||
\defgroup WIN_GROUP Функции оконного взвешивания
|
||||
|
||||
\defgroup HILBERT_GROUP Преобразование Гильберта
|
||||
В данной группе собраны функции реализующие алгоритмы преобразования Гильберта.
|
||||
|
||||
\defgroup FILTER_GROUP Цифровая фильтрация. Синтез и анализ цифровых фильтров.
|
||||
|
||||
\defgroup FILTER_CONV_GROUP Свертка и цифровая фильтрация
|
||||
Функции для расчета циклической и линейной сверток, а также цифровой КИХ и БИХ фильтрации.
|
||||
|
||||
\defgroup IIR_FILTER_DESIGN_GROUP Расчет БИХ-фильтров
|
||||
Функции расчета цифровых БИХ-фильтров.
|
||||
|
||||
\defgroup FIR_FILTER_DESIGN_GROUP Расчет КИХ-фильтров
|
||||
Функции расчета цифровых КИХ-фильтров.
|
||||
|
||||
\defgroup FILTER_ANALYSIS_GROUP Функции анализа аналоговых и цифровых фильтров
|
||||
Функции анализа аналоговых и цифровых фильтров
|
||||
|
||||
\defgroup RESAMPLING_GROUP Цифровая передискретизация сигналов
|
||||
|
||||
|
||||
|
||||
\defgroup SPECTRAL_GROUP Спектральный анализ
|
||||
\ingroup MAIN_GROUP
|
||||
В данной группе собраны функции реализующие алгоритмы дискретного
|
||||
преобразования Фурье (ДПФ), быстрого преобразования Фурье (БПФ), функции оконного взвешивания, расчета спектральной плотности мощности.
|
||||
\defgroup SPEC_MATH_COMMON_GROUP Базовые математические функции и работа с массивами данных
|
||||
|
||||
\defgroup DFT_GROUP Алгоритмы дискретного и быстрого преобразования Фурье
|
||||
\ingroup SPECTRAL_GROUP
|
||||
Алгоритмы дискретного и быстрого преобразования Фурье.
|
||||
\defgroup SPEC_MATH_TRIG_GROUP Тригонометрические и гиперболические функции вещественного комплексного аргумента
|
||||
|
||||
\defgroup SPEC_MATH_TRANSCEND Высшие трансцендентные функции
|
||||
|
||||
\defgroup SPEC_MATH_ELLIP_GROUP Эллиптические функции вещественного
|
||||
и комплексного аргумента
|
||||
|
||||
\defgroup SPEC_MATH_RAND_GEN_GROUP Генерация случайных чисел
|
||||
|
||||
\defgroup SPEC_MATH_STAT_GROUP Функции математической статистики
|
||||
|
||||
\defgroup SPEC_MATH_LINALG_GROUP Линейная алгебра и матричные операции
|
||||
|
||||
|
||||
\defgroup WIN_GROUP Функции оконного взвешивания
|
||||
\ingroup SPECTRAL_GROUP
|
||||
\defgroup IN_OUT_GROUP Функции ввода - вывода данных
|
||||
Функции ввода и вывода данных. Запись и считывание данных в бинарные и текстовые файлы
|
||||
|
||||
|
||||
\defgroup HILBERT_GROUP Преобразование Гильберта
|
||||
\ingroup MAIN_GROUP
|
||||
В данной группе собраны функции реализующие алгоритмы преобразования Гильберта.
|
||||
|
||||
|
||||
|
||||
\defgroup FILTER_GROUP Цифровая фильтрация. Синтез и анализ цифровых фильтров.
|
||||
\ingroup MAIN_GROUP
|
||||
|
||||
|
||||
\defgroup FILTER_CONV_GROUP Свертка и цифровая фильтрация
|
||||
\ingroup FILTER_GROUP
|
||||
Функции для расчета циклической и линейной сверток, а также цифровой КИХ и БИХ фильтрации.
|
||||
|
||||
|
||||
\defgroup IIR_FILTER_DESIGN_GROUP Расчет БИХ-фильтров
|
||||
\ingroup FILTER_GROUP
|
||||
Функции расчета цифровых БИХ-фильтров.
|
||||
|
||||
|
||||
\defgroup FIR_FILTER_DESIGN_GROUP Расчет КИХ-фильтров
|
||||
\ingroup FILTER_GROUP
|
||||
Функции расчета цифровых КИХ-фильтров.
|
||||
|
||||
\defgroup FILTER_ANALYSIS_GROUP Функции анализа аналоговых и цифровых фильтров
|
||||
\ingroup FILTER_GROUP
|
||||
Функции анализа аналоговых и цифровых фильтров
|
||||
|
||||
\defgroup RESAMPLING_GROUP Цифровая передискретизация сигналов
|
||||
\ingroup MAIN_GROUP
|
||||
|
||||
|
||||
\defgroup SPEC_MATH_GROUP Специальные математические функции
|
||||
\ingroup MAIN_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_COMMON_GROUP Базовые математические функции и работа с массивами данных
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
|
||||
\defgroup SPEC_MATH_TRIG_GROUP Тригонометрические и гиперболические функции вещественного и комплексного аргумента
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_TRANSCEND Высшие трансцендентные функции
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_ELLIP_GROUP Эллиптические функции вещественного
|
||||
и комплексного аргумента
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_RAND_GEN_GROUP Генерация случайных чисел
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_STAT_GROUP Функции математической статистики
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
\defgroup SPEC_MATH_LINALG_GROUP Линейная алгебра и матричные операции
|
||||
\ingroup SPEC_MATH_GROUP
|
||||
|
||||
|
||||
\defgroup IN_OUT_GROUP Функции ввода - вывода данных
|
||||
\ingroup MAIN_GROUP
|
||||
Функции ввода и вывода данных. Запись и считывание данных в бинарные и текстовые файлы
|
||||
|
||||
|
||||
\defgroup MACRO_DEFINE_GROUP Макросы и константы
|
||||
\ingroup MAIN_GROUP
|
||||
|
||||
\defgroup ERROR_CODE_GROUP Коды ошибок при вызове функций
|
||||
\ingroup MACRO_DEFINE_GROUP
|
||||
В данной группе приведены возможные коды ошибок, возвращаемые функциями библиотеки в процессе
|
||||
работы.
|
||||
\defgroup ERROR_CODE_GROUP Коды ошибок при вызове функций
|
||||
В данной группе приведены возможные коды ошибок, возвращаемые функциями библиотеки в процессе
|
||||
работы.
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -2,42 +2,57 @@
|
|||
/*!
|
||||
\mainpage DSPL-2.0 - библиотека алгоритмов цифровой обработки сигналов.
|
||||
|
||||
DSPL-2.0 - свободная библиотека алгоритмов цифровой обработки сигналов,
|
||||
с открытым исходным кодом, написанная на языке Си.<BR>
|
||||
|
||||
DSPL-2.0 - свободная библиотека алгоритмов цифровой обработки сигналов,
|
||||
включающая в себя следующие группы алгоритмов: <BR>
|
||||
Распространяется под лицензией
|
||||
<a href = "http://www.gnu.org/licenses/lgpl.html">LGPL v3.</a>
|
||||
Это позволяет использовать данную библиотеку в закрытых приложения при
|
||||
условии динамической линковки.
|
||||
|
||||
\ref DFT_GROUP <BR>
|
||||
\ref WIN_GROUP <BR>
|
||||
\ref FILTER_CONV_GROUP <BR>
|
||||
\ref IIR_FILTER_DESIGN_GROUP <BR>
|
||||
\ref FIR_FILTER_DESIGN_GROUP <BR>
|
||||
\ref FILTER_ANALYSIS_GROUP <BR>
|
||||
\ref RESAMPLING_GROUP <BR>
|
||||
\ref SPEC_MATH_GROUP <BR>
|
||||
\ref IN_OUT_GROUP <BR>
|
||||
|
||||
<BR>
|
||||
|
||||
Библиотека поддерживает работу с вещественными и
|
||||
комплексными типами входных данных. <BR>
|
||||
|
||||
Описание используемых типов:<BR>
|
||||
|
||||
\ref TYPES_GROUP <BR>
|
||||
|
||||
DSPL-2.0 библиотека с открытым исходным кодом, написанная на языке Си.<BR>
|
||||
|
||||
|
||||
Pаспространяется под лицензией
|
||||
<a href = "http://www.gnu.org/licenses/lgpl.html">LGPL v3</a>
|
||||
|
||||
Исходные коды библиотеки доступны на
|
||||
<a href = "https://github.com/Dsplib/libdspl-2.0">GitHub</a>.<BR>
|
||||
|
||||
Вы также можете внести свой вклад в развитие данной библиотеки. Присоединяйтесь!
|
||||
|
||||
Для начала работы с библиотекой необходимо ознакомиться с разделами:
|
||||
Для начала работы с библиотекой необходимо ознакомиться с разделом:
|
||||
|
||||
|
||||
|
||||
<H3>
|
||||
Содержание документации:
|
||||
</H3>
|
||||
|
||||
\ref getting_started_windows_gcc <BR>
|
||||
|
||||
\ref TYPES_GROUP <BR>
|
||||
|
||||
<B>Математические функции представлены следующими разделами:</B> <BR>
|
||||
\ref SPEC_MATH_COMMON_GROUP <BR>
|
||||
\ref SPEC_MATH_TRIG_GROUP <BR>
|
||||
\ref SPEC_MATH_TRANSCEND <BR>
|
||||
\ref SPEC_MATH_ELLIP_GROUP <BR>
|
||||
\ref SPEC_MATH_RAND_GEN_GROUP <BR>
|
||||
\ref SPEC_MATH_STAT_GROUP <BR>
|
||||
\ref SPEC_MATH_LINALG_GROUP <BR><BR>
|
||||
|
||||
<B>Алгоритмы спектрального анализа:</B><BR>
|
||||
\ref DFT_GROUP <BR>
|
||||
\ref WIN_GROUP <BR>
|
||||
\ref HILBERT_GROUP <BR>
|
||||
|
||||
<B>Расчет и анализ аналоговых и цифровых фильтров:</B><BR>
|
||||
\ref FILTER_CONV_GROUP <BR>
|
||||
\ref IIR_FILTER_DESIGN_GROUP <BR>
|
||||
\ref FIR_FILTER_DESIGN_GROUP <BR>
|
||||
\ref FILTER_ANALYSIS_GROUP <BR>
|
||||
|
||||
<B>Прочие алгоритмы:</B><BR>
|
||||
\ref RESAMPLING_GROUP <BR>
|
||||
\ref IN_OUT_GROUP <BR>
|
||||
|
||||
<BR>
|
||||
\ref ERROR_CODE_GROUP <BR>
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ cr[5] = 12.0
|
|||
Память должна быть выделена.<BR><BR>
|
||||
|
||||
\return
|
||||
`RES_OK` если свертка расчитана успешно.<BR>
|
||||
`RES_OK` если свертка рассчитана успешно.<BR>
|
||||
В противном случае \ref ERROR_CODE_GROUP "код ошибки".
|
||||
|
||||
|
||||
|
|
@ -127,6 +127,88 @@ cc[5] = 0.0+24.0j
|
|||
***************************************************************************** */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*! ****************************************************************************
|
||||
\ingroup FILTER_CONV_GROUP
|
||||
\fn int conv_fft_cmplx(complex_t* a, int na, complex_t* b, int nb,
|
||||
fft_t* pfft, complex_t* c)
|
||||
\brief Линейная свертка двух комплексных векторов с использованием алгоритмов
|
||||
быстрого преобразования Фурье
|
||||
|
||||
Функция рассчитывает линейную свертку двух векторов \f$ c = a * b\f$ используя
|
||||
секционную обработку с перекрытием в частотной области. Это позволяет сократить
|
||||
вычислительные операции при расчете длинных сверток.
|
||||
|
||||
|
||||
|
||||
\param[in] a Указатель на первый вектор \f$a\f$.<BR>
|
||||
Размер вектора `[na x 1]`.<BR><BR>
|
||||
|
||||
\param[in] na Размер первого вектора.<BR><BR>
|
||||
|
||||
\param[in] b Указатель на второй вектор \f$b\f$.<BR>
|
||||
Размер вектора `[nb x 1]`.<BR><BR>
|
||||
|
||||
\param[in] nb Размер второго вектора.<BR><BR>
|
||||
|
||||
\param[in] pfft Указатель на структуру `fft_t` алгоритма
|
||||
быстрого преобразования Фурье.<BR>
|
||||
Функция изменит состояние полей структуры `fft_t`,
|
||||
поэтому структура должна быть очищена перед выходом из
|
||||
программы для исключения утечек памяти.<BR>
|
||||
|
||||
\param[out] c Указатель на вектор свертки \f$ c = a * b\f$.<BR>
|
||||
Размер вектора `[na + nb - 1 x 1]`.<BR>
|
||||
Память должна быть выделена.<BR><BR>
|
||||
|
||||
\return
|
||||
`RES_OK` если свертка рассчитана успешно.<BR>
|
||||
В противном случае \ref ERROR_CODE_GROUP "код ошибки".
|
||||
|
||||
|
||||
\note Данная функция наиболее эффективна при вычислении длинных сверток.
|
||||
|
||||
Пример использования функции:
|
||||
|
||||
\include conv_fft_cmplx_test.c
|
||||
|
||||
Результат работы:
|
||||
\verbatim
|
||||
c[ 0] = -1.00 -0.00j d[ 0] = -1.00 +0.00j
|
||||
c[ 1] = -6.00 +4.00j d[ 1] = -6.00 +4.00j
|
||||
c[ 2] = -15.00 +20.00j d[ 2] = -15.00 +20.00j
|
||||
c[ 3] = -28.00 +56.00j d[ 3] = -28.00 +56.00j
|
||||
c[ 4] = -45.00 +120.00j d[ 4] = -45.00 +120.00j
|
||||
c[ 5] = -55.00 +210.00j d[ 5] = -55.00 +210.00j
|
||||
c[ 6] = -65.00 +300.00j d[ 6] = -65.00 +300.00j
|
||||
c[ 7] = -75.00 +390.00j d[ 7] = -75.00 +390.00j
|
||||
c[ 8] = -85.00 +480.00j d[ 8] = -85.00 +480.00j
|
||||
c[ 9] = -95.00 +570.00j d[ 9] = -95.00 +570.00j
|
||||
c[ 10] = -105.00 +660.00j d[ 10] = -105.00 +660.00j
|
||||
c[ 11] = -115.00 +750.00j d[ 11] = -115.00 +750.00j
|
||||
c[ 12] = -125.00 +840.00j d[ 12] = -125.00 +840.00j
|
||||
c[ 13] = -135.00 +930.00j d[ 13] = -135.00 +930.00j
|
||||
c[ 14] = -145.00 +1020.00j d[ 14] = -145.00 +1020.00j
|
||||
c[ 15] = -124.00 +1080.00j d[ 15] = -124.00 +1080.00j
|
||||
c[ 16] = -99.00 +1016.00j d[ 16] = -99.00 +1016.00j
|
||||
c[ 17] = -70.00 +820.00j d[ 17] = -70.00 +820.00j
|
||||
c[ 18] = -37.00 +484.00j d[ 18] = -37.00 +484.00j
|
||||
\endverbatim
|
||||
|
||||
\author Бахурин Сергей www.dsplib.org
|
||||
***************************************************************************** */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*! ****************************************************************************
|
||||
\ingroup FILTER_CONV_GROUP
|
||||
\fn int filter_iir(double* b, double* a, int ord, double* x, int n, double* y)
|
||||
|
|
|
|||
|
|
@ -20,12 +20,14 @@ int main()
|
|||
conv_fft_cmplx(a, N, b, M, &pfft, c);
|
||||
conv_cmplx(a, N, b, M, d);
|
||||
|
||||
// print result
|
||||
for(n = 0; n < N+M-1; n++)
|
||||
{
|
||||
printf("c[%3d] = %9.2f%+9.2fj ", n, RE(c[n]), IM(c[n]));
|
||||
printf("d[%3d] = %9.2f%+9.2fj \n", n, RE(d[n]), IM(d[n]));
|
||||
}
|
||||
fft_free(&pfft);
|
||||
|
||||
fft_free(&pfft); // free fft structure memory
|
||||
dspl_free(handle); // free dspl handle
|
||||
return 0;
|
||||
}
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue