diff --git a/dox/doxyfile_ru b/dox/doxyfile_ru index ac72a39..1dfb9bf 100644 --- a/dox/doxyfile_ru +++ b/dox/doxyfile_ru @@ -1,4 +1,4 @@ -# Doxyfile 1.8.13 +# 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,26 +32,26 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = libdspl-2.0 +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 # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = # 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 = +PROJECT_LOGO = ../../www/pictures/dspl20.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 @@ -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. @@ -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. @@ -337,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. @@ -648,7 +670,7 @@ GENERATE_DEPRECATEDLIST= YES # sections, marked by \if ... \endif and \cond # ... \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 @@ -690,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 @@ -703,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 @@ -753,7 +775,8 @@ 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 @@ -778,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 @@ -801,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. @@ -819,7 +842,7 @@ INPUT_ENCODING = UTF-8 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -879,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 @@ -895,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 @@ -906,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 @@ -957,7 +980,7 @@ IMAGE_PATH = ../test/bin/img \ # 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 @@ -970,7 +993,7 @@ INPUT_FILTER = # 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 @@ -985,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 @@ -1021,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 @@ -1053,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 # @@ -1086,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 -# generated with the -Duse-libclang=ON option for CMake. +# generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO @@ -1097,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 @@ -1123,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 @@ -1202,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 @@ -1212,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. @@ -1253,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. @@ -1276,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. @@ -1321,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 @@ -1341,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, @@ -1349,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). @@ -1362,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 @@ -1393,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. @@ -1405,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. @@ -1414,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 @@ -1523,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. # @@ -1535,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 @@ -1562,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 @@ -1573,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 @@ -1581,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 @@ -1624,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. @@ -1637,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 @@ -1657,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 @@ -1667,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 @@ -1689,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. @@ -1731,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 @@ -1747,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 @@ -1758,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 @@ -1769,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 @@ -1777,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 @@ -1824,7 +1881,7 @@ 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. @@ -1838,6 +1895,14 @@ LATEX_BIB_STYLE = plain 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 #--------------------------------------------------------------------------- @@ -1877,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. @@ -1937,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 @@ -1975,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 #--------------------------------------------------------------------------- @@ -2007,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 @@ -2050,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 @@ -2091,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 @@ -2099,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. @@ -2149,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 @@ -2204,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. @@ -2224,7 +2296,7 @@ HIDE_UNDOC_RELATIONS = NO # 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: YES. +# The default value is: NO. HAVE_DOT = NO @@ -2260,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. @@ -2380,9 +2452,7 @@ DIRECTORY_GRAPH = YES # 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, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, -# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, -# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, +# 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. @@ -2406,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 @@ -2433,17 +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 = +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 diff --git a/dspl/dox/ru/complex.dox b/dspl/dox/ru/complex.dox index 1ed22c2..f89c762 100644 --- a/dspl/dox/ru/complex.dox +++ b/dspl/dox/ru/complex.dox @@ -36,10 +36,10 @@ \def ABSSQR(x) \brief Макрос возвращает квадрат модуля комплексного числа `x`. - Квадрата модуля комплексного числа \f$ x = a + j \cdot b \f$ равен: + Квадрата модуля комплексного числа \f$ x = a + j b \f$ равен: \f[ - |x|^2 = x \cdot x^* = a^2 + b^2. + |x|^2 = x x^* = a^2 + b^2. \f] Например: diff --git a/dspl/dox/ru/conv.dox b/dspl/dox/ru/conv.dox index c1a999b..55a156c 100644 --- a/dspl/dox/ru/conv.dox +++ b/dspl/dox/ru/conv.dox @@ -8,18 +8,18 @@ \param[in] a Указатель на первый вектор \f$a\f$.
- Размер вектора `[na x 1]`.

+ Размер вектора `[na x 1]`.

- \param[in] na Размер первого вектора.

+ \param[in] na Размер первого вектора.

\param[in] b Указатель на второй вектор \f$b\f$.
- Размер вектора `[nb x 1]`.

+ Размер вектора `[nb x 1]`.

- \param[in] nb Размер второго вектора.

+ \param[in] nb азмер второго вектора.

\param[out] c Указатель на вектор свертки \f$ c = a * b\f$.
- Размер вектора `[na + nb - 1 x 1]`.
- Память должна быть выделена.

+ Размер вектора `[na + nb - 1 x 1]`.
+ Память должна быть выделена.

\return `RES_OK` если свертка расчитана успешно.
@@ -46,19 +46,19 @@ Функция рассчитывает линейную свертку двух векторов \f$ c = a * b\f$. - \param[in] a Указатель на первый вектор \f$a\f$.
- Размер вектора `[na x 1]`.

+ \param[in] a Указатель на первый вектор \f$a\f$.
+ Размер вектора `[na x 1]`.

\param[in] na Размер первого вектора.

- \param[in] b Указатель на второй вектор \f$b\f$.
- Размер вектора `[nb x 1]`.

+ \param[in] b Указатель на второй вектор \f$b\f$.
+ Размер вектора `[nb x 1]`.

\param[in] nb Размер второго вектора.

- \param[out] c Указатель на вектор свертки \f$ c = a * b\f$.
- Размер вектора `[na + nb - 1 x 1]`.
- Память должна быть выделена.

+ \param[out] c Указатель на вектор свертки \f$ c = a * b\f$.
+ Размер вектора `[na + nb - 1 x 1]`.
+ Память должна быть выделена.

\return `RES_OK` если свертка расчитана успешно.
@@ -84,34 +84,34 @@ Функция рассчитывает выход фильтра заданного выражением \f[ - H(z) = \frac{\sum_{n = 0}^{N} b_n \cdot z^{-n}} - {1+{\frac{1}{a_0}}\sum_{m = 1}^{M} a_m \cdot z^{-n}}, + H(z) = \frac{\sum_{n = 0}^{N} b_n z^{-n}} + {1+{\frac{1}{a_0}}\sum_{m = 1}^{M} a_m z^{-n}}, \f] где \f$a_0\f$ не может быть 0, \f$N=M=\f$`ord`. - \param[in] b Указатель на вектор коэффициентов числителя - передаточной функции БИХ-фильтра.
- Размер вектора `[ord + 1 x 1]`.

+ \param[in] b Указатель на вектор коэффициентов числителя + передаточной функции БИХ-фильтра.
+ Размер вектора `[ord + 1 x 1]`.

- \param[in] a Указатель на вектор коэффициентов знаменателя - передаточной функции БИХ-фильтра.
- Размер вектора `[ord + 1 x 1]`.
- Этот указатель может быть `NULL`, - тогда фильтрация производится без использования - рекурсивной части.

+ \param[in] a Указатель на вектор коэффициентов знаменателя + передаточной функции БИХ-фильтра.
+ Размер вектора `[ord + 1 x 1]`.
+ Этот указатель может быть `NULL`, + тогда фильтрация производится без использования + рекурсивной части.

\param[in] ord Порядок фильтра. Количество коэффициентов числителя - и знаменателя передаточной функции - БИХ-фильтра равно `ord + 1`.

+ и знаменателя передаточной функции + БИХ-фильтра равно `ord + 1`.

- \param[in] x Указатель на вектор отсчетов входного сигнала.
- Размер вектора `[n x 1]`.

+ \param[in] x Указатель на вектор отсчетов входного сигнала.
+ Размер вектора `[n x 1]`.

- \param[in] n Длина входного сигнала.

+ \param[in] n Длина входного сигнала.

\param[out] y Указатель на вектор выходных отсчетов фильтра.
- Размер вектора `[n x 1]`.
- Память должна быть выделена заранее.

+ Размер вектора `[n x 1]`.
+ Память должна быть выделена заранее.

\return `RES_OK` Если фильтрация произведена успешно.
В противном случае \ref ERROR_CODE_GROUP "код ошибки":
diff --git a/dspl/dox/ru/dft.dox b/dspl/dox/ru/dft.dox index b00a071..1747452 100644 --- a/dspl/dox/ru/dft.dox +++ b/dspl/dox/ru/dft.dox @@ -7,19 +7,23 @@ Функция рассчитывает \f$ n \f$-точечное дискретное преобразование Фурье вещественного сигнала \f$ x(m) \f$, \f$ m = 0 \ldots n-1 \f$.
\f[ - Y(k) = \sum_{m = 0}^{n-1} x(m) \cdot \exp \left( -j \cdot \frac{2\pi}{n} \cdot m \cdot k \right), + Y(k) = \sum_{m = 0}^{n-1} x(m) \exp \left( -j \frac{2\pi}{n} m k \right), \f] где \f$ k = 0 \ldots n-1 \f$. - \param[in] x Указатель на вектор вещественного входного сигнала \f$x(m)\f$, - \f$ m = 0 \ldots n-1 \f$.
- Размер вектора `[n x 1]`.

+ \param[in] x Указатель на вектор вещественного + входного сигнала \f$x(m)\f$, + \f$ m = 0 \ldots n-1 \f$.
+ Размер вектора `[n x 1]`.

- \param[in] n Размер ДПФ \f$n\f$ (размер векторов входного сигнала и результата ДПФ).

+ \param[in] n Размер ДПФ \f$n\f$ (размер векторов + входного сигнала и результата ДПФ).

- \param[out] y Указатель на комплексный вектор результата ДПФ \f$Y(k)\f$, - \f$ k = 0 \ldots n-1 \f$. Размер вектора `[n x 1]`.
- Память должна быть выделена.

+ \param[out] y Указатель на комплексный вектор + результата ДПФ \f$Y(k)\f$, + \f$ k = 0 \ldots n-1 \f$. + Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return @@ -60,7 +64,6 @@ и требует \f$ n^2 \f$ комплексных умножений.
Для увеличения скорости расчета рекомендуется использовать алгоритмы быстрого преобразования Фурье. - **************************************************************************************************** */ @@ -73,19 +76,23 @@ Функция рассчитывает \f$ n \f$-точечное дискретное преобразование Фурье комплексного сигнала \f$ x(m) \f$, \f$ m = 0 \ldots n-1 \f$.
\f[ - Y(k) = \sum_{m = 0}^{n-1} x(m) \cdot \exp \left( -j \cdot \frac{2\pi}{n} \cdot m \cdot k \right), + Y(k) = \sum_{m = 0}^{n-1} x(m) \exp \left( -j \frac{2\pi}{n} m k \right), \f] где \f$ k = 0 \ldots n-1 \f$. - \param[in] x Указатель на вектор комплексного входного сигнала \f$x(m)\f$, - \f$ m = 0 \ldots n-1 \f$.
- Размер вектора `[n x 1]`.

+ \param[in] x Указатель на вектор комплексного + входного сигнала \f$x(m)\f$, + \f$ m = 0 \ldots n-1 \f$.
+ Размер вектора `[n x 1]`.

- \param[in] n Размер ДПФ \f$n\f$ (размер векторов входного сигнала и результата ДПФ).

+ \param[in] n Размер ДПФ \f$n\f$ (размер векторов входного + сигнала и результата ДПФ).

- \param[out] y Указатель на комплексный вектор результата ДПФ \f$Y(k)\f$, - \f$ k = 0 \ldots n-1 \f$. Размер вектора `[n x 1]`.
- Память должна быть выделена.

+ \param[out] y Указатель на комплексный вектор + результата ДПФ \f$Y(k)\f$, + \f$ k = 0 \ldots n-1 \f$. + Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return diff --git a/dspl/dox/ru/ellipj.dox b/dspl/dox/ru/ellipj.dox index 915fa9e..6e0072d 100644 --- a/dspl/dox/ru/ellipj.dox +++ b/dspl/dox/ru/ellipj.dox @@ -13,21 +13,21 @@ Ландена.
-\param[in] w Указатель на массив вектора переменной \f$ w \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] w Указатель на массив вектора переменной \f$ w \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `w`.

+\param[in] n Размер вектора `w`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] u Указатель на вектор значений обратной эллиптической - функции \f$ u = \textrm{cd}^{-1}(w, k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] u Указатель на вектор значений обратной эллиптической + функции \f$ u = \textrm{cd}^{-1}(w, k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return @@ -60,21 +60,21 @@ Ландена.
-\param[in] w Указатель на массив вектора переменной \f$ w \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] w Указатель на массив вектора переменной \f$ w \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `w`.

+\param[in] n Размер вектора `w`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] u Указатель на вектор значений обратной эллиптической - функции \f$ u = \textrm{cd}^{-1}(w, k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] u Указатель на вектор значений обратной эллиптической + функции \f$ u = \textrm{cd}^{-1}(w, k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return @@ -107,27 +107,27 @@ Ландена.
-\param[in] w Указатель на массив вектора переменной \f$ w \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] w Указатель на массив вектора переменной \f$ w \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `w`.

+\param[in] n Размер вектора `w`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] u Указатель на вектор значений обратной эллиптической - функции \f$ u = \textrm{sn}^{-1}(w, k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] u Указатель на вектор значений обратной эллиптической + функции \f$ u = \textrm{sn}^{-1}(w, k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей @@ -154,27 +154,27 @@ Ландена.
-\param[in] w Указатель на массив вектора переменной \f$ w \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] w Указатель на массив вектора переменной \f$ w \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `w`.

+\param[in] n Размер вектора `w`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] u Указатель на вектор значений обратной эллиптической - функции \f$ u = \textrm{sn}^{-1}(w, k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

- +\param[out] u Указатель на вектор значений обратной эллиптической + функции \f$ u = \textrm{sn}^{-1}(w, k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

+ \return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей @@ -192,7 +192,7 @@ \ingroup SPEC_MATH_ELLIP_GROUP \fn int ellip_cd(double* u, int n, double k, double* y) \brief Эллиптическая функция Якоби - \f$ y = \textrm{cd}(u K(k), k)\f$ вещественного аргумента +\f$ y = \textrm{cd}(u K(k), k)\f$ вещественного аргумента Функция рассчитывает занчения значения эллиптической функции \f$ y = \textrm{cd}(u K(k), k)\f$ для вещественного вектора `u` и @@ -202,27 +202,27 @@ Ландена.
-\param[in] u Указатель на массив вектора переменной \f$ u \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] u Указатель на массив вектора переменной \f$ u \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `u`.

+\param[in] n Размер вектора `u`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] y Указатель на вектор значений эллиптической - функции \f$ y = \textrm{cd}(u K(k), k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] y Указатель на вектор значений эллиптической + функции \f$ y = \textrm{cd}(u K(k), k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей @@ -250,27 +250,27 @@ Ландена.
-\param[in] u Указатель на массив вектора переменной \f$ u \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] u Указатель на массив вектора переменной \f$ u \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `u`.

+\param[in] n Размер вектора `u`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] y Указатель на вектор значений эллиптической - функции \f$ y = \textrm{cd}(u K(k), k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] y Указатель на вектор значений эллиптической + функции \f$ y = \textrm{cd}(u K(k), k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей @@ -288,7 +288,6 @@ \fn int ellip_landen(double k, int n, double* y) \brief Расчет коэффициентов \f$ k_i \f$ ряда полного эллиптического интеграла. - Полный эллиптический интеграл \f$ K(k) \f$ может быть представлен рядом: \f[ @@ -312,24 +311,24 @@ k_i = эллиптических функций. -\param[in] k Эллиптический модуль \f$ k \f$.
+\param[in] k Эллиптический модуль \f$ k \f$.
-\param[in] n Размер вектора `y` соответсвующих - коэффициентам \f$ k_i \f$.

+\param[in] n Размер вектора `y` соответсвующих + коэффициентам \f$ k_i \f$.

-\param[out] y Указатель на вектор значений - коэффициентов \f$ k_i \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] y Указатель на вектор значений + коэффициентов \f$ k_i \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
Пример использования функции `ellip_landen`: @@ -356,10 +355,10 @@ k_i = \endverbatim \note Ряд полного эллиптического интеграла сходится при значениях - эллиптического модуля \f$ k<1 \f$. При этом сходимость ряда достаточно - быстрая и для практический приложений достаточно от 10 до 20 значений - \f$ k_i \f$ для обеспечения погрешности при расчете полного - эллиптического интеграла в пределах машинной точности. +эллиптического модуля \f$ k<1 \f$. При этом сходимость ряда достаточно +быстрая и для практический приложений достаточно от 10 до 20 значений +\f$ k_i \f$ для обеспечения погрешности при расчете полного +эллиптического интеграла в пределах машинной точности. \author Бахурин Сергей @@ -376,7 +375,7 @@ k_i = \ingroup SPEC_MATH_ELLIP_GROUP \fn int ellip_sn(double* u, int n, double k, double* y) \brief Эллиптическая функция Якоби - \f$ y = \textrm{sn}(u K(k), k)\f$ вещественного аргумента +\f$ y = \textrm{sn}(u K(k), k)\f$ вещественного аргумента Функция рассчитывает занчения значения эллиптической функции \f$ y = \textrm{sn}(u K(k), k)\f$ для вещественного вектора `u` и @@ -386,27 +385,27 @@ k_i = Ландена.
-\param[in] u Указатель на массив вектора переменной \f$ u \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] u Указатель на массив вектора переменной \f$ u \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `u`.

+\param[in] n Размер вектора `u`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] y Указатель на вектор значений эллиптической - функции \f$ y = \textrm{sn}(u K(k), k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] y Указатель на вектор значений эллиптической + функции \f$ y = \textrm{sn}(u K(k), k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей @@ -424,7 +423,7 @@ k_i = \ingroup SPEC_MATH_ELLIP_GROUP \fn int ellip_sn_cmplx(complex_t* u, int n, double k, complex_t* y) \brief Эллиптическая функция Якоби - \f$ y = \textrm{sn}(u K(k), k)\f$ комплексного аргумента +\f$ y = \textrm{sn}(u K(k), k)\f$ комплексного аргумента Функция рассчитывает занчения значения эллиптической функции \f$ y = \textrm{sn}(u K(k), k)\f$ для комплексного вектора `u` и @@ -434,27 +433,27 @@ k_i = Ландена.
-\param[in] u Указатель на массив вектора переменной \f$ u \f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[in] u Указатель на массив вектора переменной \f$ u \f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

-\param[in] n Размер вектора `u`.

+\param[in] n Размер вектора `u`.

-\param[in] k Значение эллиптического модуля \f$ k \f$.
- Эллиптический модуль -- вещественный параметр, - принимающий значения от 0 до 1.

+\param[in] k Значение эллиптического модуля \f$ k \f$.
+ Эллиптический модуль -- вещественный параметр, + принимающий значения от 0 до 1.

-\param[out] y Указатель на вектор значений эллиптической - функции \f$ y = \textrm{sn}(u K(k), k)\f$.
- Размер вектора `[n x 1]`.
- Память должна быть выделена.

+\param[out] y Указатель на вектор значений эллиптической + функции \f$ y = \textrm{sn}(u K(k), k)\f$.
+ Размер вектора `[n x 1]`.
+ Память должна быть выделена.

\return - `RES_OK` Расчет произведен успешно.
- В противном случае - \ref ERROR_CODE_GROUP "код ошибки".
+ `RES_OK` Расчет произведен успешно.
+ В противном случае + \ref ERROR_CODE_GROUP "код ошибки".
\author Бахурин Сергей diff --git a/dspl/dox/ru/fft.dox b/dspl/dox/ru/fft.dox index e4d60c5..49c9c14 100644 --- a/dspl/dox/ru/fft.dox +++ b/dspl/dox/ru/fft.dox @@ -102,16 +102,28 @@ \param[in] n Размер БПФ \f$n\f$.
Размер БПФ может быть составным вида - \f$n = n_0 n_1 n_2 n_3 \times \ldots \times n_p m\f$, - где \f$n_i = 2,3,5,7\f$, а $m$ -- произвольный простой - множитель не превосходящий 46340. + \f$n = n_0 \times n_1 \times n_2 \times n_3 \times \ldots \times n_p \times m\f$, + где \f$n_i = 2,3,5,7\f$, а \f$m \f$ -- произвольный простой + множитель не превосходящий 46340.

+ Таким образом алгоритм БПФ поддерживает произвольный длины, равные целой степени чисел 2,3,5,7, + а таже различные их комбинации.

+ Так например, при \f$ n = 725760 \f$ структура будет успешно заполнена, + потому что \f$725760 = 2 \cdot 3 \cdot 4 \cdot 5 \cdot 6 \cdot 7 \cdot 9 \cdot 16 \f$, + т.е. получается как произведение множителей 2,3,5,7.

+ При \f$ n = 172804 = 43201 \cdot 4 \f$ структура также будет успешно заполнена, + потому что простой множитель входящий в \f$n\f$ не превосходит 46340.

+ Для размера \f$ n = 13 \cdot 17 \cdot 23 \cdot 13 = 66079 \f$ функция вернет ошибку, + поскольку 66079 больше 46340 и не является результатом произведения чисел 2,3,5,7.

+ + + + \return `RES_OK` если структура заполнена успешно.
В противном случае \ref ERROR_CODE_GROUP "код ошибки".

- \note - Некоторые компиляторы при создании структуры не обнуляют ее содержимое. + \note Некоторые компиляторы при создании структуры не обнуляют ее содержимое. Поэтому рекомендуется произвести обнуление структуры после ее объявления: \code fft_t pfft; // объявляем объект fft_t @@ -132,7 +144,9 @@ //очистить память объекта БПФ fft_free(&pfft); \endcode - Перед выходом из программы выделенную в структуре память необходимо очистить функцией \ref fft_free . + Перед выходом из программы выделенную в структуре память необходимо очистить функцией \ref fft_free .

+ + \note Магия числа 46340 заключается в том, что \f$\sqrt{2^{31}} = 46340.95\f$.

diff --git a/dspl/dox/ru/filter_an.dox b/dspl/dox/ru/filter_an.dox index a6905e0..bf2f565 100644 --- a/dspl/dox/ru/filter_an.dox +++ b/dspl/dox/ru/filter_an.dox @@ -11,8 +11,8 @@ передаточной функции \f$ H(s) \f$: \f[ - H(s) = \frac {\sum_{k = 0}^{N} b_k \cdot s^k} - {\sum_{m = 0}^{N} a_m \cdot s^m}, + H(s) = \frac {\sum_{k = 0}^{N} b_k s^k} + {\sum_{m = 0}^{N} a_m s^m}, \f] где \f$ N \f$ - порядок фильтра (параметр `ord`). @@ -182,8 +182,8 @@ butter_ap_test_tau.txt ГВЗ фильтра коэффициентами передаточной функции \f$H(z)\f$: \f[ -H(z) = \frac {\sum_{k = 0}^{N} b_k \cdot z^{-k}} - {\sum_{m = 0}^{N} a_m \cdot z^{-m}}, +H(z) = \frac {\sum_{k = 0}^{N} b_k z^{-k}} + {\sum_{m = 0}^{N} a_m z^{-m}}, \f] где \f$N\f$ - порядок фильтра (параметр `ord`).
diff --git a/dspl/dox/ru/filter_ft.dox b/dspl/dox/ru/filter_ft.dox index b280ed9..36b2bb8 100644 --- a/dspl/dox/ru/filter_ft.dox +++ b/dspl/dox/ru/filter_ft.dox @@ -136,12 +136,9 @@ Функция рассчитывает композицию вида \f$Y(s) = (H \circ F)(s) = H(F(s))\f$, где \f[ -H(s) = \frac{\sum\limits_{m = 0}^{n} b_m s^m} -{\sum\limits_{k = 0}^{n} a_k s^k}, \ \ \ \ -F(s) = \frac{\sum\limits_{m = 0}^{p} d_m s^m} -{\sum\limits_{k = 0}^{p} с_k s^k}, \ \ \ \ -Y(s) = \frac{\sum\limits_{m = 0}^{n \cdot p} \beta_m s^m} -{\sum\limits_{k = 0}^{n \cdot p} \alpha_k s^k} +H(s) = \frac{\sum\limits_{m = 0}^{n} b_m s^m}{\sum\limits_{k = 0}^{n} a_k s^k}, \quad +F(s) = \frac{\sum\limits_{m = 0}^{p} d_m s^m}{\sum\limits_{k = 0}^{p} c_k s^k}, \quad +Y(s) = \frac{\sum\limits_{m = 0}^{n p} \beta_m s^m}{\sum\limits_{k = 0}^{n p} \alpha_k s^k} \f] Функция рациональной композиции необходима для произведения частотных diff --git a/dspl/src/dspl_internal.h b/dspl/src/dspl_internal.h index 2a87bb8..c143d70 100644 --- a/dspl/src/dspl_internal.h +++ b/dspl/src/dspl_internal.h @@ -70,5 +70,21 @@ void transpose4x4(complex_t *x, complex_t* y); +int win_bartlett (double *w, int n, int win_type); +int win_bartlett_hann (double *w, int n, int win_type); +int win_blackman (double *w, int n, int win_type); +int win_blackman_harris (double *w, int n, int win_type); +int win_blackman_nuttall(double *w, int n, int win_type); +int win_cos (double *w, int n, int win_type); +int win_flat_top (double *w, int n, int win_type); +int win_gaussian (double *w, int n, int win_type, double sigma); +int win_hamming (double *w, int n, int win_type); +int win_hann (double *w, int n, int win_type); +int win_lanczos (double *w, int n, int win_type); +int win_nuttall (double *w, int n, int win_type); +int win_rect (double *w, int n); + + + #endif diff --git a/dspl/src/win.c b/dspl/src/win.c new file mode 100644 index 0000000..66fb5ab --- /dev/null +++ b/dspl/src/win.c @@ -0,0 +1,518 @@ +/* +* Copyright (c) 2015-2019 Sergey Bakhurin +* Digital Signal Processing Library [http://dsplib.org] +* +* This file is part of libdspl-2.0. +* +* is free software: you can redistribute it and/or modify +* it under the terms of the GNU Lesser General Public License as published by +* the Free Software Foundation, either version 3 of the License, or +* (at your option) any later version. +* +* DSPL is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU Lesser General Public License +* along with Foobar. If not, see . +*/ + + + +#include +#include +#include "dspl.h" +#include "dspl_internal.h" + + + +/******************************************************************************* +Window function +*******************************************************************************/ +int window(double* w, int n, int win_type, double param) +{ + + switch(win_type & DSPL_WIN_MASK) + { + case DSPL_WIN_BARTLETT: + return win_bartlett(w, n, win_type); + case DSPL_WIN_BARTLETT_HANN: + return win_bartlett_hann(w, n, win_type); + case DSPL_WIN_BLACKMAN: + return win_blackman(w, n, win_type); + case DSPL_WIN_BLACKMAN_HARRIS: + return win_blackman_harris(w, n, win_type); + case DSPL_WIN_BLACKMAN_NUTTALL: + return win_blackman_nuttall(w, n, win_type); + case DSPL_WIN_FLAT_TOP: + return win_flat_top(w, n, win_type); + case DSPL_WIN_GAUSSIAN: + return win_gaussian(w, n, win_type, param); + case DSPL_WIN_HAMMING: + return win_hamming(w, n, win_type); + case DSPL_WIN_HANN: + return win_hann(w, n, win_type); + case DSPL_WIN_LANCZOS: + return win_lanczos(w, n, win_type); + case DSPL_WIN_NUTTALL: + return win_nuttall(w, n, win_type); + case DSPL_WIN_RECT: + return win_rect(w, n); + case DSPL_WIN_COS: + return win_cos(w, n, win_type); + default: + return ERROR_WIN_TYPE; + } + return RES_OK; +} + + + +/****************************************************************************** +Barlett window function +*******************************************************************************/ +int win_bartlett(double *w, int n, int win_type) +{ + double x = 0.0; + int i; + + if(!w) + return ERROR_PTR; + if(n<2) + return ERROR_SIZE; + + switch(win_type & DSPL_WIN_SYM_MASK) + { + case DSPL_WIN_SYMMETRIC: x = (double)(n-1); break; + case DSPL_WIN_PERIODIC : x = (double)n; break; + default: return ERROR_WIN_SYM; + } + + for(i = 0; i < n; i++) + { + w[i] = 2.0 / x * (x * 0.5-fabs((double)i - x * 0.5)); + } + return RES_OK; +} + + + + + +/****************************************************************************** +Barlett - Hann window function +******************************************************************************/ +int win_bartlett_hann(double *w, int n, int win_type) +{ + double y; + double x = 0.0; + int i; + + if(!w) + return ERROR_PTR; + if(n<2) + return ERROR_SIZE; + + switch(win_type & DSPL_WIN_SYM_MASK) + { + case DSPL_WIN_SYMMETRIC: x = 1.0/(double)(n-1); break; + case DSPL_WIN_PERIODIC : x = 1.0/(double)n; break; + default: return ERROR_WIN_SYM; + } + + y = 0.0; + for(i = 0; i