From 3fd8cca73c8dd103a4042697a48e534258c955f3 Mon Sep 17 00:00:00 2001 From: Dsplib Date: Wed, 13 Dec 2023 20:18:47 +0300 Subject: [PATCH] Changes to be committed: modified: dspl/dox/doxyfile_ru modified: dspl/src/array/sum.c modified: dspl/src/filter_design/bilinear.c modified: dspl/src/filter_design/butter_ap.c modified: dspl/src/filter_design/butter_ap_zp.c modified: dspl/src/filter_design/cheby1_ap.c modified: dspl/src/filter_design/cheby1_ap_zp.c modified: dspl/src/filter_design/cheby2_ap.c modified: dspl/src/filter_design/cheby2_ap_wp1.c modified: dspl/src/filter_design/cheby2_ap_zp.c modified: dspl/src/filter_design/ellip_ap.c modified: dspl/src/filter_design/ellip_ap_zp.c modified: dspl/src/filter_design/filter_freq_resp.c modified: dspl/src/filter_design/filter_ws1.c modified: dspl/src/filter_design/filter_zp2ab.c modified: dspl/src/filter_design/fir_linphase.c modified: dspl/src/filter_design/freqs.c modified: dspl/src/filter_design/freqs2time.c modified: dspl/src/filter_design/freqs_cmplx.c modified: dspl/src/filter_design/freqz.c modified: dspl/src/filter_design/group_delay.c modified: dspl/src/filter_design/iir.c modified: dspl/src/filter_design/low2bp.c modified: dspl/src/filter_design/low2bs.c modified: dspl/src/filter_design/low2high.c modified: dspl/src/filter_design/low2low.c modified: dspl/src/filter_design/phase_delay.c modified: dspl/src/filter_design/ratcompos.c modified: dspl/src/filter_design/win.c modified: dspl/src/gnuplot/gnuplot_close.c modified: dspl/src/gnuplot/gnuplot_cmd.c modified: dspl/src/gnuplot/gnuplot_create.c modified: dspl/src/gnuplot/gnuplot_open.c modified: dspl/src/inout/dspl_info.c modified: dspl/src/inout/readbin.c modified: dspl/src/inout/verif_data_gen.c modified: dspl/src/inout/verif_str.c modified: dspl/src/inout/verif_str_cmplx.c modified: dspl/src/inout/writebin.c modified: dspl/src/inout/writetxt.c modified: dspl/src/inout/writetxt_3d.c modified: dspl/src/inout/writetxt_3dline.c modified: dspl/src/inout/writetxt_cmplx.c modified: dspl/src/inout/writetxt_cmplx_im.c modified: dspl/src/inout/writetxt_cmplx_re.c modified: dspl/src/inout/writetxt_int.c modified: dspl/src/math_ellipj/ellip_acd.c modified: dspl/src/math_ellipj/ellip_acd_cmplx.c modified: dspl/src/math_ellipj/ellip_asn.c modified: dspl/src/math_ellipj/ellip_asn_cmplx.c modified: dspl/src/math_ellipj/ellip_cd.c modified: dspl/src/math_ellipj/ellip_cd_cmplx.c modified: dspl/src/math_ellipj/ellip_landen.c modified: dspl/src/math_ellipj/ellip_modulareq.c modified: dspl/src/math_ellipj/ellip_rat.c modified: dspl/src/math_ellipj/ellip_sn.c modified: dspl/src/math_ellipj/ellip_sn_cmplx.c modified: dspl/src/math_matrix/matrix_eig_cmplx.c modified: dspl/src/math_matrix/matrix_eye.c modified: dspl/src/math_matrix/matrix_eye_cmplx.c modified: dspl/src/math_matrix/matrix_mul.c modified: dspl/src/math_matrix/matrix_pinv.c modified: dspl/src/math_matrix/matrix_print.c modified: dspl/src/math_matrix/matrix_print_cmplx.c modified: dspl/src/math_matrix/matrix_svd.c modified: dspl/src/math_matrix/matrix_transpose.c modified: dspl/src/math_matrix/matrix_transpose_cmplx.c modified: dspl/src/math_matrix/matrix_transpose_hermite.c modified: dspl/src/math_matrix/vector_dot.c modified: dspl/src/math_poly/cheby_poly1.c modified: dspl/src/math_poly/cheby_poly2.c modified: dspl/src/math_poly/polyroots.c modified: dspl/src/math_poly/polyval.c modified: dspl/src/math_poly/polyval_cmplx.c modified: dspl/src/math_stat/find_max_abs.c modified: dspl/src/math_stat/histogram.c modified: dspl/src/math_stat/histogram_norm.c modified: dspl/src/math_stat/mean.c modified: dspl/src/math_stat/mean_cmplx.c modified: dspl/src/math_stat/minmax.c modified: dspl/src/math_stat/stat_std.c modified: dspl/src/math_stat/stat_std_cmplx.c modified: dspl/src/math_stat/xcorr.c modified: dspl/src/math_std/acos_cmplx.c modified: dspl/src/math_std/asin_cmplx.c modified: dspl/src/math_std/bessel_i0.c modified: dspl/src/math_std/cos_cmplx.c modified: dspl/src/math_std/dmod.c modified: dspl/src/math_std/log_cmplx.c modified: dspl/src/math_std/sin_cmplx.c modified: dspl/src/math_std/sinc.c modified: dspl/src/math_std/sine_int.c modified: dspl/src/math_std/sqrt_cmplx.c modified: dspl/src/math_std/trapint.c modified: dspl/src/math_std/trapint_cmplx.c modified: dspl/src/math_std/unwrap.c modified: dspl/src/psd/psd_bartlett.c modified: dspl/src/psd/psd_bartlett_cmplx.c modified: dspl/src/psd/psd_periodogram.c modified: dspl/src/psd/psd_periodogram_cmplx.c modified: dspl/src/psd/psd_welch.c modified: dspl/src/psd/psd_welch_cmplx.c --- dspl/dox/doxyfile_ru | 452 ++++++++++++------ dspl/src/array/sum.c | 2 +- dspl/src/filter_design/bilinear.c | 2 - dspl/src/filter_design/butter_ap.c | 10 +- dspl/src/filter_design/butter_ap_zp.c | 4 - dspl/src/filter_design/cheby1_ap.c | 8 +- dspl/src/filter_design/cheby1_ap_zp.c | 7 +- dspl/src/filter_design/cheby2_ap.c | 8 +- dspl/src/filter_design/cheby2_ap_wp1.c | 2 +- dspl/src/filter_design/cheby2_ap_zp.c | 6 +- dspl/src/filter_design/ellip_ap.c | 3 +- dspl/src/filter_design/ellip_ap_zp.c | 6 +- dspl/src/filter_design/filter_freq_resp.c | 6 +- dspl/src/filter_design/filter_ws1.c | 2 +- dspl/src/filter_design/filter_zp2ab.c | 8 +- dspl/src/filter_design/fir_linphase.c | 8 +- dspl/src/filter_design/freqs.c | 4 +- dspl/src/filter_design/freqs2time.c | 2 +- dspl/src/filter_design/freqs_cmplx.c | 2 +- dspl/src/filter_design/freqz.c | 4 +- dspl/src/filter_design/group_delay.c | 15 +- dspl/src/filter_design/iir.c | 11 +- dspl/src/filter_design/low2bp.c | 2 +- dspl/src/filter_design/low2bs.c | 2 +- dspl/src/filter_design/low2high.c | 8 +- dspl/src/filter_design/low2low.c | 8 +- dspl/src/filter_design/phase_delay.c | 7 +- dspl/src/filter_design/ratcompos.c | 10 +- dspl/src/filter_design/win.c | 6 +- dspl/src/gnuplot/gnuplot_close.c | 6 +- dspl/src/gnuplot/gnuplot_cmd.c | 6 +- dspl/src/gnuplot/gnuplot_create.c | 6 +- dspl/src/gnuplot/gnuplot_open.c | 6 +- dspl/src/inout/dspl_info.c | 2 +- dspl/src/inout/readbin.c | 6 +- dspl/src/inout/verif_data_gen.c | 2 +- dspl/src/inout/verif_str.c | 2 +- dspl/src/inout/verif_str_cmplx.c | 2 +- dspl/src/inout/writebin.c | 6 +- dspl/src/inout/writetxt.c | 6 +- dspl/src/inout/writetxt_3d.c | 5 +- dspl/src/inout/writetxt_3dline.c | 2 +- dspl/src/inout/writetxt_cmplx.c | 2 +- dspl/src/inout/writetxt_cmplx_im.c | 2 +- dspl/src/inout/writetxt_cmplx_re.c | 2 +- dspl/src/inout/writetxt_int.c | 4 +- dspl/src/math_ellipj/ellip_acd.c | 6 +- dspl/src/math_ellipj/ellip_acd_cmplx.c | 6 +- dspl/src/math_ellipj/ellip_asn.c | 6 +- dspl/src/math_ellipj/ellip_asn_cmplx.c | 6 +- dspl/src/math_ellipj/ellip_cd.c | 6 +- dspl/src/math_ellipj/ellip_cd_cmplx.c | 6 +- dspl/src/math_ellipj/ellip_landen.c | 6 +- dspl/src/math_ellipj/ellip_modulareq.c | 2 +- dspl/src/math_ellipj/ellip_rat.c | 2 +- dspl/src/math_ellipj/ellip_sn.c | 6 +- dspl/src/math_ellipj/ellip_sn_cmplx.c | 6 +- dspl/src/math_matrix/matrix_eig_cmplx.c | 4 +- dspl/src/math_matrix/matrix_eye.c | 6 +- dspl/src/math_matrix/matrix_eye_cmplx.c | 6 +- dspl/src/math_matrix/matrix_mul.c | 8 +- dspl/src/math_matrix/matrix_pinv.c | 2 +- dspl/src/math_matrix/matrix_print.c | 2 +- dspl/src/math_matrix/matrix_print_cmplx.c | 2 +- dspl/src/math_matrix/matrix_svd.c | 2 +- dspl/src/math_matrix/matrix_transpose.c | 2 +- dspl/src/math_matrix/matrix_transpose_cmplx.c | 2 +- .../math_matrix/matrix_transpose_hermite.c | 2 +- dspl/src/math_matrix/vector_dot.c | 2 +- dspl/src/math_poly/cheby_poly1.c | 6 +- dspl/src/math_poly/cheby_poly2.c | 6 +- dspl/src/math_poly/polyroots.c | 6 +- dspl/src/math_poly/polyval.c | 4 +- dspl/src/math_poly/polyval_cmplx.c | 4 +- dspl/src/math_stat/find_max_abs.c | 6 +- dspl/src/math_stat/histogram.c | 2 +- dspl/src/math_stat/histogram_norm.c | 2 +- dspl/src/math_stat/mean.c | 6 +- dspl/src/math_stat/mean_cmplx.c | 6 +- dspl/src/math_stat/minmax.c | 2 +- dspl/src/math_stat/stat_std.c | 6 +- dspl/src/math_stat/stat_std_cmplx.c | 9 +- dspl/src/math_stat/xcorr.c | 20 +- dspl/src/math_std/acos_cmplx.c | 6 +- dspl/src/math_std/asin_cmplx.c | 6 +- dspl/src/math_std/bessel_i0.c | 6 +- dspl/src/math_std/cos_cmplx.c | 6 +- dspl/src/math_std/dmod.c | 2 +- dspl/src/math_std/log_cmplx.c | 6 +- dspl/src/math_std/sin_cmplx.c | 6 +- dspl/src/math_std/sinc.c | 6 +- dspl/src/math_std/sine_int.c | 6 +- dspl/src/math_std/sqrt_cmplx.c | 6 +- dspl/src/math_std/trapint.c | 2 +- dspl/src/math_std/trapint_cmplx.c | 2 +- dspl/src/math_std/unwrap.c | 2 +- dspl/src/psd/psd_bartlett.c | 5 +- dspl/src/psd/psd_bartlett_cmplx.c | 7 +- dspl/src/psd/psd_periodogram.c | 6 +- dspl/src/psd/psd_periodogram_cmplx.c | 6 +- dspl/src/psd/psd_welch.c | 2 +- dspl/src/psd/psd_welch_cmplx.c | 7 +- 102 files changed, 526 insertions(+), 434 deletions(-) diff --git a/dspl/dox/doxyfile_ru b/dspl/dox/doxyfile_ru index 7aebcc2..e377f68 100644 --- a/dspl/dox/doxyfile_ru +++ b/dspl/dox/doxyfile_ru @@ -1,4 +1,4 @@ -# Doxyfile 1.9.2 +# Doxyfile 1.9.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,6 +12,16 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -60,16 +70,28 @@ PROJECT_LOGO = ru/img/dspl_small.png OUTPUT_DIRECTORY = ../doc/ru -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode @@ -81,14 +103,14 @@ ALLOW_UNICODE_NAMES = YES # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = Russian @@ -341,6 +363,17 @@ MARKDOWN_SUPPORT = YES TOC_INCLUDE_HEADINGS = 0 +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + # 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 @@ -452,7 +485,7 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing @@ -465,6 +498,14 @@ LOOKUP_CACHE_SIZE = 0 NUM_PROC_THREADS = 1 +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -546,7 +587,8 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO @@ -577,14 +619,15 @@ INTERNAL_DOCS = NO # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with +# are not case sensitive the option should be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On # Windows (including Cygwin) and MacOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. -# The default value is: system dependent. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = NO @@ -836,11 +879,26 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but # at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. WARN_AS_ERROR = NO @@ -851,13 +909,27 @@ WARN_AS_ERROR = NO # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard -# error (stderr). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). WARN_LOGFILE = @@ -883,10 +955,21 @@ INPUT = ru \ # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. @@ -898,12 +981,12 @@ INPUT_ENCODING = UTF-8 # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # -# 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++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.h \ @@ -944,10 +1027,7 @@ EXCLUDE_PATTERNS = # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* +# ANamespace::AClass, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -996,6 +1076,11 @@ IMAGE_PATH = ru/img \ # 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 doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # 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. @@ -1037,6 +1122,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -1174,10 +1268,11 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1256,7 +1351,12 @@ HTML_STYLESHEET = doxy_stylesheet.css # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1271,6 +1371,19 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # 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 color-wheel, see @@ -1301,15 +1414,6 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = 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 @@ -1319,7 +1423,7 @@ HTML_TIMESTAMP = YES # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_MENUS = NO # 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 @@ -1329,6 +1433,13 @@ HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to @@ -1365,6 +1476,13 @@ GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. @@ -1452,6 +1570,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help @@ -1569,7 +1697,7 @@ GENERATE_TREEVIEW = NO # area (value NO) or if it should extend to the full height of the window (value # YES). Setting this to YES gives a layout similar to # https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATOR_TREEVIEW or +# project logo, title, and description. If either GENERATE_TREEVIEW or # DISABLE_INDEX is set to NO, this option has no effect. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1600,6 +1728,13 @@ TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for @@ -1620,17 +1755,6 @@ HTML_FORMULA_FORMAT = svg FORMULA_FONTSIZE = 12 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -1657,7 +1781,7 @@ USE_MATHJAX = YES # The default value is: MathJax_2. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_VERSION = MathJax_2 +MATHJAX_VERSION = MathJax_3 # When MathJax is enabled you can set the default output format to be used for # the MathJax output. For more details about the output format see MathJax @@ -1688,7 +1812,7 @@ MATHJAX_FORMAT = HTML-CSS # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest +MATHJAX_RELPATH = # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example @@ -1944,9 +2068,16 @@ PDF_HYPERLINKS = YES USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1967,14 +2098,6 @@ LATEX_HIDE_INDICES = NO 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 @@ -2140,7 +2263,7 @@ DOCBOOK_OUTPUT = docbook #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# AutoGen Definitions (see https://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. @@ -2151,6 +2274,28 @@ GENERATE_AUTOGEN_DEF = NO # Configuration options related to Sqlite3 output #--------------------------------------------------------------------------- +# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 +# database with symbols found by doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be +# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put +# in front of it. +# The default directory is: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each doxygen run. If set to NO, doxygen +# will warn if an a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- @@ -2225,7 +2370,8 @@ SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2296,15 +2442,15 @@ TAGFILES = GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will be +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. @@ -2318,25 +2464,9 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = NO - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. @@ -2345,7 +2475,7 @@ HIDE_UNDOC_RELATIONS = NO # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: NO. @@ -2362,49 +2492,73 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. -CLASS_GRAPH = YES +CLASS_GRAPH = TEXT # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a # graph for each documented class showing the direct and indirect implementation # dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2464,7 +2618,9 @@ TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to # YES then doxygen will generate a graph for each documented file showing the # direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2473,7 +2629,10 @@ INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are # set to YES then doxygen will generate a graph for each documented file showing # the direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2513,16 +2672,26 @@ GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the # dependencies a directory has on other directories in a graphical way. The # dependency relations are determined by the #include relations between the -# files in the directories. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). +# https://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). @@ -2559,11 +2728,12 @@ DOT_PATH = 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). +# 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. -MSCFILE_DIRS = +DIA_PATH = # 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 @@ -2572,10 +2742,10 @@ MSCFILE_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 -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = @@ -2613,18 +2783,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support @@ -2637,6 +2795,8 @@ DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2650,3 +2810,19 @@ GENERATE_LEGEND = YES # The default value is: YES. DOT_CLEANUP = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# 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 = diff --git a/dspl/src/array/sum.c b/dspl/src/array/sum.c index 67f7822..9daec13 100644 --- a/dspl/src/array/sum.c +++ b/dspl/src/array/sum.c @@ -47,7 +47,7 @@ Размер вектора `x`. \n \n -\param[in] n +\param[out] s Указатель на переменную суммы элементов массива. \n По данному указателю будет записан результат работы функции. \n diff --git a/dspl/src/filter_design/bilinear.c b/dspl/src/filter_design/bilinear.c index c23f618..43d7911 100644 --- a/dspl/src/filter_design/bilinear.c +++ b/dspl/src/filter_design/bilinear.c @@ -29,7 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP - \fn int bilinear(double* bs, double* as, int ord, double* bz, double* az) \brief Transform a s-plane analog filter transfer function \f$ H(s) \f$ to the @@ -118,7 +117,6 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP - \fn int bilinear(double* bs, double* as, int ord, double* bz, double* az) \brief Билинейное преобразование передаточной характеристики аналогового diff --git a/dspl/src/filter_design/butter_ap.c b/dspl/src/filter_design/butter_ap.c index 320f958..0d8ee90 100644 --- a/dspl/src/filter_design/butter_ap.c +++ b/dspl/src/filter_design/butter_ap.c @@ -27,7 +27,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP - \fn int butter_ap(double Rp, int ord, double* b, double* a) \brief Function calculates the transfer function \f$ H(s) \f$ coefficients of @@ -98,10 +97,7 @@ #endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** - - \ingroup IIR_FILTER_DESIGN_GROUP - - \fn int butter_ap(double Rp, int ord, double* b, double* a) + \ingroup IIR_FILTER_DESIGN_GROUP \brief Расчет передаточной характеристики \f$ H(s) \f$ аналогового @@ -111,7 +107,7 @@ аналогового нормированного ФНЧ Баттерворта порядка `ord` с частотой среза 1 рад/с по уровню \f$ -R_p \f$ дБ. - \param [in] Rp + \param [in] rp Неравномерность АЧХ в полосе пропускания (дБ). \n Параметр задает уровень искажений в полосе от 0 до 1 рад/с. \n Значение должно быть положительным. \n @@ -123,7 +119,7 @@ передаточной функции \f$ H(s) \f$ равно `ord+1`. \n \n - \param [out] b + \param [out] b Указатель на вектор коэффициентов числителя передаточной функции \f$ H(s) \f$. \n Размер вектора `[ord+1 x 1]`. \n diff --git a/dspl/src/filter_design/butter_ap_zp.c b/dspl/src/filter_design/butter_ap_zp.c index 421e918..f3237d9 100644 --- a/dspl/src/filter_design/butter_ap_zp.c +++ b/dspl/src/filter_design/butter_ap_zp.c @@ -28,8 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int butter_ap_zp(int ord, double rp, complex_t* z, int* nz, - complex_t* p, int* np) \brief Function calculates arrays of zeros and poles for analog normlized lowpass @@ -115,8 +113,6 @@ from data stored in `dat/butter_ap_zp.txt` file: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int butter_ap_zp(int ord, double rp, complex_t* z, int* nz, - complex_t* p, int* np) \brief Расчет массивов нулей и полюсов передаточной функции diff --git a/dspl/src/filter_design/cheby1_ap.c b/dspl/src/filter_design/cheby1_ap.c index 278a35f..49f84f1 100644 --- a/dspl/src/filter_design/cheby1_ap.c +++ b/dspl/src/filter_design/cheby1_ap.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -28,7 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby1_ap(double Rp, int ord, double* b, double* a) \brief Function calculates the transfer function \f$ H(s) \f$ coefficients of @@ -37,7 +36,7 @@ analog normalized lowpass Chebyshev type 1 filter. Analog normalized lowpass filter magnitude ripple equals \f$ -R_p \f$ dB for angular frequency \f$ \omega \f$ from 0 to 1 rad/s. -\param[in] Rp +\param[in] rp Magnitude ripple in passband (dB). \n This parameter sets maximum filter distortion from 0 to 1 rad/s frequency. \n Parameter must be positive. \n @@ -101,7 +100,6 @@ In addition, GNUPLOT will build the following graphs from data stored in files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby1_ap(double Rp, int ord, double* b, double* a) \brief Расчет передаточной характеристики \f$ H(s) \f$ аналогового @@ -114,7 +112,7 @@ In addition, GNUPLOT will build the following graphs from data stored in files: Особенностью фильтра Чебышёва первого рода являются равноволновые пульсации АЧХ в полосе пропускания. -\param[in] Rp +\param[in] rp Неравномерность АЧХ в полосе пропускания (дБ). \n Параметр задает уровень искажений в полосе от 0 до 1 рад/с. \n Значение должно быть положительным. \n diff --git a/dspl/src/filter_design/cheby1_ap_zp.c b/dspl/src/filter_design/cheby1_ap_zp.c index 0afd5ab..59c2b9f 100644 --- a/dspl/src/filter_design/cheby1_ap_zp.c +++ b/dspl/src/filter_design/cheby1_ap_zp.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -28,8 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby1_ap_zp( int ord, double rp, complex_t* z, int* nz, - complex_t* p, int* np) + \brief Function calculates arrays of zeros and poles for analog normlized lowpass Chebyshev type 1 filter transfer function \f$ H(s) \f$ order `ord` . @@ -115,7 +114,7 @@ from data stored in `dat/cheby1_ap_zp.txt` file: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby1_ap_zp(int ord, double rp, complex_t* z, int* nz, complex_t* p, int* np) + \brief Расчет массивов нулей и полюсов передаточной функции \f$ H(s) \f$ аналогового нормированного ФНЧ Чебышёва первого рода. diff --git a/dspl/src/filter_design/cheby2_ap.c b/dspl/src/filter_design/cheby2_ap.c index e9716aa..6e2b187 100644 --- a/dspl/src/filter_design/cheby2_ap.c +++ b/dspl/src/filter_design/cheby2_ap.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -28,7 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby2_ap(double Rs, int ord, double *b, double *a) \brief Function calculates the transfer function \f$ H(s) \f$ coefficients of @@ -39,7 +38,7 @@ suppression in stopband. Also analog normalized Chebyshev type 2 filter magnitude equals \f$-Rs\f$ dB for angular frequency \f$\omega = 1\f$ rad/s. -\param[in] Rs +\param[in] rs Suppression level in stopband (dB). \n This parameter sets filter supression for \f$\omega \geq 1\f$ rad/s frequency. \n Parameter must be positive. \n @@ -103,7 +102,6 @@ In addition, GNUPLOT will build the following graphs from data stored in files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby2_ap(double Rs, int ord, double *b, double *a) \brief Расчет передаточной характеристики \f$ H(s) \f$ аналогового @@ -117,7 +115,7 @@ In addition, GNUPLOT will build the following graphs from data stored in files: 1) равноволновые пульсации АЧХ в полосе заграждения. \n 2) уровень АЧХ \f$H(j\cdot 1) = -R_s\f$ дБ. \n -\param[in] Rs +\param[in] rs Уровень подавления в полосе пропускания (дБ). \n Значение должно быть положительным. \n \n diff --git a/dspl/src/filter_design/cheby2_ap_wp1.c b/dspl/src/filter_design/cheby2_ap_wp1.c index d3f578e..211607c 100644 --- a/dspl/src/filter_design/cheby2_ap_wp1.c +++ b/dspl/src/filter_design/cheby2_ap_wp1.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/cheby2_ap_zp.c b/dspl/src/filter_design/cheby2_ap_zp.c index 29990c9..7d6a0e3 100644 --- a/dspl/src/filter_design/cheby2_ap_zp.c +++ b/dspl/src/filter_design/cheby2_ap_zp.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,8 +30,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby2_ap_zp(int ord, double rs, complex_t* z, int* nz, - complex_t* p, int* np) \brief Function calculates arrays of zeros and poles for analog normlized lowpass @@ -123,8 +121,6 @@ from data stored in the files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int cheby2_ap_zp(int ord, double rs, complex_t* z, int* nz, - complex_t* p, int* np) \brief Расчет массивов нулей и полюсов передаточной функции \f$ H(s) \f$ diff --git a/dspl/src/filter_design/ellip_ap.c b/dspl/src/filter_design/ellip_ap.c index 56f57a3..b83afb6 100644 --- a/dspl/src/filter_design/ellip_ap.c +++ b/dspl/src/filter_design/ellip_ap.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,7 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int ellip_ap(double rp, double rs, int ord, double* b, double* a) \brief Function calculates the transfer function \f$ H(s) \f$ coefficients of diff --git a/dspl/src/filter_design/ellip_ap_zp.c b/dspl/src/filter_design/ellip_ap_zp.c index d3a2543..7f385e0 100644 --- a/dspl/src/filter_design/ellip_ap_zp.c +++ b/dspl/src/filter_design/ellip_ap_zp.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -28,8 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** @ingroup IIR_FILTER_DESIGN_GROUP -@fn int ellip_ap_zp(int ord, double rp, double rs, complex_t* z, int* nz, - complex_t* p, int* np) @brief Function calculates arrays of zeros and poles for analog normlized lowpass @@ -120,8 +118,6 @@ from data stored in the files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** @ingroup IIR_FILTER_DESIGN_GROUP -@fn int ellip_ap_zp(int ord, double rp, double rs, complex_t* z, int* nz, - complex_t* p, int* np) @brief Расчет массивов нулей и полюсов передаточной функции @f$ H(s) @f$ diff --git a/dspl/src/filter_design/filter_freq_resp.c b/dspl/src/filter_design/filter_freq_resp.c index 171a53f..55319b3 100644 --- a/dspl/src/filter_design/filter_freq_resp.c +++ b/dspl/src/filter_design/filter_freq_resp.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,8 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int filter_freq_resp(double* b, double* a, int ord, double* w, int n, - int flag, double* mag, double* phi, double* tau) \brief Magnitude, phase response and group delay vectors calculation @@ -129,8 +127,6 @@ In addition, GNUPLOT will build the following graphs from data stored in files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int filter_freq_resp(double* b, double* a, int ord, double* w, int n, - int flag, double* mag, double* phi, double* tau) \brief Расчет амплитудно-частотной (АЧХ), фазочастотной характеристик (ФЧХ), а также diff --git a/dspl/src/filter_design/filter_ws1.c b/dspl/src/filter_design/filter_ws1.c index 03b8054..11e099a 100644 --- a/dspl/src/filter_design/filter_ws1.c +++ b/dspl/src/filter_design/filter_ws1.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/filter_zp2ab.c b/dspl/src/filter_design/filter_zp2ab.c index c9e5201..037c067 100644 --- a/dspl/src/filter_design/filter_zp2ab.c +++ b/dspl/src/filter_design/filter_zp2ab.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,8 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int filter_zp2ab(complex_t *z, int nz, complex_t *p, int np, int ord, - double* b, double* a) + \brief Function recalculates complex zeros and poles of transfer function \f$ H(s) \f$ to the coefficients of \f$ H(s) \f$ numerator and denominator polynomials. @@ -99,8 +98,7 @@ and poles are not fulfilled. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int filter_zp2ab(complex_t *z, int nz, complex_t *p, int np, int ord, - double* b, double* a) + \brief Функция пересчета нулей и полюсов аналогового фильтра в коэффициенты передаточной характеристики \f$ H(s) \f$ diff --git a/dspl/src/filter_design/fir_linphase.c b/dspl/src/filter_design/fir_linphase.c index e7286a4..508bb3a 100644 --- a/dspl/src/filter_design/fir_linphase.c +++ b/dspl/src/filter_design/fir_linphase.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -70,8 +70,7 @@ error_proc: #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FIR_FILTER_DESIGN_GROUP -\fn int DSPL_API fir_linphase(int ord, double w0, double w1, int filter_type, -int win_type, double win_param, double* h) + \brief Function calculates linear-phase FIR filter coefficients by window method @@ -193,8 +192,7 @@ This function calculates coeffictiens of lowpass, highpass, bandpass #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FIR_FILTER_DESIGN_GROUP -\fn int DSPL_API fir_linphase(int ord, double w0, double w1, int filter_type, - int win_type, double win_param, double* h) + \brief Расчет коэффициентов линейно-фазового КИХ-фильтра методом оконного взвешивания. diff --git a/dspl/src/filter_design/freqs.c b/dspl/src/filter_design/freqs.c index cb86f08..26a8cd3 100644 --- a/dspl/src/filter_design/freqs.c +++ b/dspl/src/filter_design/freqs.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int freqs(double* b, double* a, int ord, double* w, int n, complex_t *h) + \brief Analog filter frequency response \f$ H(j \omega) \f$ calculation Function calculates analog filter frequency response \f$ H(j \omega)\f$ diff --git a/dspl/src/filter_design/freqs2time.c b/dspl/src/filter_design/freqs2time.c index 40c7730..ae65591 100644 --- a/dspl/src/filter_design/freqs2time.c +++ b/dspl/src/filter_design/freqs2time.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/freqs_cmplx.c b/dspl/src/filter_design/freqs_cmplx.c index fd40108..c1e800e 100644 --- a/dspl/src/filter_design/freqs_cmplx.c +++ b/dspl/src/filter_design/freqs_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/freqz.c b/dspl/src/filter_design/freqz.c index 26118c7..03623c5 100644 --- a/dspl/src/filter_design/freqz.c +++ b/dspl/src/filter_design/freqz.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,7 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int freqz(double* b, double* a, int ord, double* w, int n, complex_t *h) \brief Function calculates the digital filter frequency response \f$ H \left(e^{j \omega} \right)\f$ corresponds to transfer function \f$H(z)\f$. @@ -86,7 +85,6 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int freqz(double* b, double* a, int ord, double* w, int n, complex_t *h) \brief Расчет комплексного коэффициента передачи \f$ H \left(e^{j \omega} \right)\f$ цифрового фильтра. diff --git a/dspl/src/filter_design/group_delay.c b/dspl/src/filter_design/group_delay.c index 6c9ce4c..24c2205 100644 --- a/dspl/src/filter_design/group_delay.c +++ b/dspl/src/filter_design/group_delay.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,8 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int DSPL_API group_delay(double* b, double* a, int ord, int flag, - double* w, int n, double* tau) \brief Group delay calculation for digital or analog filter corresponds to @@ -43,12 +41,12 @@ Group delay is describes as: here \f$\Phi(\omega)\f$ -- filter phase response, \f$\omega\f$ is angular frequency for analog filter, or normalized frequency for digital filter. -\param[in] b +\param[in] pb Pointer to the \f$ H(s) \f$ or \f$H(z)\f$ transfer function numerator coefficients vector. \n Vector size is `[ord+1 x 1]`. \n \n -\param[in] a +\param[in] pa Pointer to the \f$ H(s) \f$ or \f$H(z)\f$ transfer function denominator coefficients vector. \n Vector size is `[ord+1 x 1]`. \n \n @@ -96,8 +94,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int DSPL_API group_delay(double* b, double* a, int ord, int flag, - double* w, int n, double* tau) + \brief Расчет группового времени запаздывания цифрового или аналогового фильтра. @@ -108,12 +105,12 @@ Else \ref ERROR_CODE_GROUP "code error". где \f$\Phi(\omega)\f$ -- ФЧХ фильтра, \f$\omega\f$ циктическая частот в случае аналогового фильтра, или нормированная частота цифрового фильтра. -\param[in] b +\param[in] pb Указатель на вектор коэффициентов числителя передаточной функции аналогового фильтра \f$ H(s) \f$ или цифрового фильтра \f$ H(z) \f$. \n Размер вектора `[ord+1 x 1]`. \n \n -\param[in] a +\param[in] pa Указатель на вектор коэффициентов числителя передаточной функции аналогового фильтра \f$ H(s) \f$ или цифрового фильтра \f$ H(z) \f$. \n Размер вектора `[ord+1 x 1]`. \n diff --git a/dspl/src/filter_design/iir.c b/dspl/src/filter_design/iir.c index f73a04b..d44b7a1 100644 --- a/dspl/src/filter_design/iir.c +++ b/dspl/src/filter_design/iir.c @@ -1,7 +1,7 @@ /* * \file iir.c * \author Sergey Bakhurin -* \copyright Copyright (c) 2015-2022 Sergey Bakhurin +* \copyright Copyright (c) 2015-2024 Sergey Bakhurin * * \section DESCRIPTION * Digital Signal Processing Library [http://dsplib.org] @@ -62,10 +62,7 @@ int iir_ap(double rp, double rs, int ord, int type, double* b, double* a) #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP - - \fn int iir(double rp, double rs, int ord, double w0, double w1, - int type, double* b, double* a) - + \brief Digital IIR filter design. @@ -153,9 +150,7 @@ int iir_ap(double rp, double rs, int ord, int type, double* b, double* a) #endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** - \ingroup IIR_FILTER_DESIGN_GROUP - \fn int iir(double rp, double rs, int ord, double w0, double w1, - int type, double* b, double* a) + \ingroup IIR_FILTER_DESIGN_GROUP \brief Функция расчета коэффициентов передаточной характеристики \f$ H(z) \f$ diff --git a/dspl/src/filter_design/low2bp.c b/dspl/src/filter_design/low2bp.c index 30dc2d0..88a1c02 100644 --- a/dspl/src/filter_design/low2bp.c +++ b/dspl/src/filter_design/low2bp.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/low2bs.c b/dspl/src/filter_design/low2bs.c index ec2cad9..613e932 100644 --- a/dspl/src/filter_design/low2bs.c +++ b/dspl/src/filter_design/low2bs.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/filter_design/low2high.c b/dspl/src/filter_design/low2high.c index 03f4089..e217cab 100644 --- a/dspl/src/filter_design/low2high.c +++ b/dspl/src/filter_design/low2high.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,8 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int low2high (double* b, double* a, int ord, double w0, double w1, - double* beta, double* alpha) + \brief Lowpass to highpass filter frequency transform Function transforms lowpass filter transfer function \f$ H(s) \f$ @@ -87,8 +86,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int low2high (double* b, double* a, int ord, double w0, double w1, - double* beta, double* alpha) + \brief Частотное преобразование ФНЧ-ФВЧ Функция производит перобразование передаточной функции \f$ H(s) \f$ diff --git a/dspl/src/filter_design/low2low.c b/dspl/src/filter_design/low2low.c index 9485570..6879f30 100644 --- a/dspl/src/filter_design/low2low.c +++ b/dspl/src/filter_design/low2low.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,9 +29,8 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int low2low(double* b, double* a, int ord, double w0, double w1, - double* beta, double* alpha) +\brief Lowpass to lowpass filter frequency transform Function transforms lowpass filter transfer function \f$ H(s) \f$ @@ -89,8 +88,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int low2low(double* b, double* a, int ord, double w0, double w1, - double* beta, double* alpha) + \brief Частотное преобразование ФНЧ-ФНЧ Функция производит преобразование передаточной функции \f$ H(s) \f$ diff --git a/dspl/src/filter_design/phase_delay.c b/dspl/src/filter_design/phase_delay.c index 1390c06..ef3c89c 100644 --- a/dspl/src/filter_design/phase_delay.c +++ b/dspl/src/filter_design/phase_delay.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,8 +30,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int DSPL_API phase_delay(double* b, double* a, int ord, int flag, - double* w, int n, double* tau) \brief Phase delay calculation for digital or analog filter corresponds to @@ -97,8 +95,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_ANALYSIS_GROUP -\fn int DSPL_API phase_delay(double* b, double* a, int ord, int flag, - double* w, int n, double* tau) + \brief Расчет фазовой задержки цифрового или аналогового фильтра. diff --git a/dspl/src/filter_design/ratcompos.c b/dspl/src/filter_design/ratcompos.c index 74b8a2a..39a9cd4 100644 --- a/dspl/src/filter_design/ratcompos.c +++ b/dspl/src/filter_design/ratcompos.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,9 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int ratcompos( double* b, double* a, int n, - double* c, double* d, int p, - double* beta, double* alpha) + \brief Rational composition Function calcultes composition \f$Y(s) = (H \circ F)(s) = H(F(s))\f$, here @@ -105,9 +103,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IIR_FILTER_DESIGN_GROUP -\fn int ratcompos( double* b, double* a, int n, - double* c, double* d, int p, - double* beta, double* alpha) + \brief Рациональная композиця Функция рассчитывает композицию вида \f$Y(s) = (H \circ F)(s) = H(F(s))\f$, где diff --git a/dspl/src/filter_design/win.c b/dspl/src/filter_design/win.c index d3711c0..1bf0e9b 100644 --- a/dspl/src/filter_design/win.c +++ b/dspl/src/filter_design/win.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -51,7 +51,7 @@ int win_rect (double *w, int n); #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup WIN_GROUP -\fn int window(double* w, int n, int win_type, double param) + \brief Window function calculation The function calculates a periodic or symmetric window function @@ -188,7 +188,7 @@ Parametric Kaiser windows #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup WIN_GROUP -\fn int window(double* w, int n, int win_type, double param) + \brief Расчет функции оконного взвешивания Функция рассчитывает периодическую или симметричную оконную функцию diff --git a/dspl/src/gnuplot/gnuplot_close.c b/dspl/src/gnuplot/gnuplot_close.c index 4a8caf5..ef885d9 100644 --- a/dspl/src/gnuplot/gnuplot_close.c +++ b/dspl/src/gnuplot/gnuplot_close.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup PLOT_GROUP -\fn void gnuplot_close(void* h) + \brief Close GNUPLOT handle. This function closes the previously opened GNUPLOT handle after transferring all @@ -54,7 +54,7 @@ GNUPLOT handle which will be closed. \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PLOT_GROUP -\fn void gnuplot_close(void* h) + \brief Закрыть хэндл GNUPLOT. Данная функция закрывает открытый ранее хэндл GNUPLOT после передачи всех diff --git a/dspl/src/gnuplot/gnuplot_cmd.c b/dspl/src/gnuplot/gnuplot_cmd.c index 8722718..1b10424 100644 --- a/dspl/src/gnuplot/gnuplot_cmd.c +++ b/dspl/src/gnuplot/gnuplot_cmd.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -26,7 +26,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup PLOT_GROUP -\fn void gnuplot_cmd(void* h, char* cmd) + \brief Function sends `cmd` command to GNUPLOT corresponds to `h` handle. \note From a system point of view, `h` is a pointer to an open file, @@ -52,7 +52,7 @@ GNUPLOT command string. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PLOT_GROUP -\fn void gnuplot_cmd(void* h, char* cmd) + \brief Функция посылает команду `cmd` пакету GNUPLOT, для построения или оформления графика, соответсвующего хэндлу `h`. diff --git a/dspl/src/gnuplot/gnuplot_create.c b/dspl/src/gnuplot/gnuplot_create.c index 6cc24c3..6af7e4f 100644 --- a/dspl/src/gnuplot/gnuplot_create.c +++ b/dspl/src/gnuplot/gnuplot_create.c @@ -32,8 +32,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup PLOT_GROUP -\fn int gnuplot_create(int argc, char* argv[], int w, int h, char* fn_png, - void** hplot) + \brief Create GNUPLOT chart. This function opens the GNUPLOT package depending on the `argv` parameters @@ -116,8 +115,7 @@ The saved data is displayed on three graphs #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PLOT_GROUP -\fn int gnuplot_create(int argc, char* argv[], int w, int h, char* fn_png, - void** hplot) + \brief Создать график GNUPLOT. Данная функция открывает пакет GNUPLOT в зависимости от передаваемых в программу diff --git a/dspl/src/gnuplot/gnuplot_open.c b/dspl/src/gnuplot/gnuplot_open.c index e06e2ae..e2054ac 100644 --- a/dspl/src/gnuplot/gnuplot_open.c +++ b/dspl/src/gnuplot/gnuplot_open.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -27,7 +27,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup PLOT_GROUP -\fn int gnuplot_open(void** hplot) + \brief Open GNUPLOT program. This function opens the GNUPLOT package. @@ -66,7 +66,7 @@ but does not create terminals. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PLOT_GROUP -\fn int gnuplot_open(void** hplot) + \brief Открыть пакет GNUPLOT. Данная функция открывает пакет GNUPLOT. diff --git a/dspl/src/inout/dspl_info.c b/dspl/src/inout/dspl_info.c index 5115d26..f9dcb13 100644 --- a/dspl/src/inout/dspl_info.c +++ b/dspl/src/inout/dspl_info.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/readbin.c b/dspl/src/inout/readbin.c index 42a3ef7..a281295 100644 --- a/dspl/src/inout/readbin.c +++ b/dspl/src/inout/readbin.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IN_OUT_GROUP - \fn int readbin(char* fn, void** x, int* pn, int* pm, int* dtype) + \brief Read array from the bin-file Function reads real or complex 1D/2D array size `n x m` from @@ -169,7 +169,7 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IN_OUT_GROUP - \fn int readbin(char* fn, void** x, int* pn, int* pm, int* dtype) + \brief Считать данные из бинарного файла Функция считывает реальные или комплексные данные из бинарного файла diff --git a/dspl/src/inout/verif_data_gen.c b/dspl/src/inout/verif_data_gen.c index 51f9987..12e1bfd 100644 --- a/dspl/src/inout/verif_data_gen.c +++ b/dspl/src/inout/verif_data_gen.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/verif_str.c b/dspl/src/inout/verif_str.c index 0a15298..7533c4e 100644 --- a/dspl/src/inout/verif_str.c +++ b/dspl/src/inout/verif_str.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/verif_str_cmplx.c b/dspl/src/inout/verif_str_cmplx.c index 6ad1e4b..bb111f4 100644 --- a/dspl/src/inout/verif_str_cmplx.c +++ b/dspl/src/inout/verif_str_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/writebin.c b/dspl/src/inout/writebin.c index 726a5d5..4d618b2 100644 --- a/dspl/src/inout/writebin.c +++ b/dspl/src/inout/writebin.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -33,7 +33,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IN_OUT_GROUP - \fn int writebin(void* x, int n, int m, int dtype, char* fn) + \brief Save 1D vector or 2D matrix to the binary file Function saves real or complex 1D/2D data size `n x m` to the @@ -127,7 +127,7 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IN_OUT_GROUP - \fn int writebin(void* x, int n, int m, int dtype, char* fn) + \brief Сохранить данные в бинарный файл Функция сохраняет реальный или комплексный массив данных diff --git a/dspl/src/inout/writetxt.c b/dspl/src/inout/writetxt.c index 0b3e503..3d975a8 100644 --- a/dspl/src/inout/writetxt.c +++ b/dspl/src/inout/writetxt.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt(double* x, double* y, int n, char* fn) + \brief Save real data \f$y(x)\f$ to the text file `fn`. \n File format is: @@ -76,7 +76,7 @@ So, it is not recommended to use it to verify algorithms. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt(double* x, double* y, int n, char* fn) + \brief Сохранить вещественные данные в текстовый файл Функция сохраняет вещественные данные в текстовый файл `fn`. \n diff --git a/dspl/src/inout/writetxt_3d.c b/dspl/src/inout/writetxt_3d.c index c73c003..6ba7049 100644 --- a/dspl/src/inout/writetxt_3d.c +++ b/dspl/src/inout/writetxt_3d.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,8 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt_3d(double* x, int nx, double* y, int ny, - double* z, char* fn) \brief Save data \f$ z(x,y)\f$ to the text file `fn` for 3D surface plotting. @@ -122,7 +120,6 @@ In addition, GNUPLOT built a 3D surface by data #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt_3d(double* x, int nx, double* y, int ny, double* z, char* fn) \brief Сохранить данные для построения 3D графика diff --git a/dspl/src/inout/writetxt_3dline.c b/dspl/src/inout/writetxt_3dline.c index b8ac4cd..eca99e2 100644 --- a/dspl/src/inout/writetxt_3dline.c +++ b/dspl/src/inout/writetxt_3dline.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/writetxt_cmplx.c b/dspl/src/inout/writetxt_cmplx.c index 4e56807..c3eaaee 100644 --- a/dspl/src/inout/writetxt_cmplx.c +++ b/dspl/src/inout/writetxt_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/writetxt_cmplx_im.c b/dspl/src/inout/writetxt_cmplx_im.c index 36f60a2..75fe202 100644 --- a/dspl/src/inout/writetxt_cmplx_im.c +++ b/dspl/src/inout/writetxt_cmplx_im.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/writetxt_cmplx_re.c b/dspl/src/inout/writetxt_cmplx_re.c index f6938b7..38a7869 100644 --- a/dspl/src/inout/writetxt_cmplx_re.c +++ b/dspl/src/inout/writetxt_cmplx_re.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/inout/writetxt_int.c b/dspl/src/inout/writetxt_int.c index 7a64655..57f147f 100644 --- a/dspl/src/inout/writetxt_int.c +++ b/dspl/src/inout/writetxt_int.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt_int(int* x, int* y, int n, char* fn) \brief Save interger data \f$y(x)\f$ to the text file `fn`. \n @@ -71,7 +70,6 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup IN_OUT_GROUP -\fn int writetxt_int(int* x, int* y, int n, char* fn) \brief Сохранить целочисленные данные в текстовый файл diff --git a/dspl/src/math_ellipj/ellip_acd.c b/dspl/src/math_ellipj/ellip_acd.c index 705cde3..3fd4847 100644 --- a/dspl/src/math_ellipj/ellip_acd.c +++ b/dspl/src/math_ellipj/ellip_acd.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_acd(double* w, int n, double k, double* u) + \brief Inverse Jacobi elliptic function \f$ u = \textrm{cd}^{-1}(w, k)\f$ of the real vector argument @@ -64,7 +64,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_acd(double* w, int n, double k, double* u) + \brief Обратная эллиптическая функция Якоби \f$ u = \textrm{cd}^{-1}(w, k)\f$ вещественного аргумента diff --git a/dspl/src/math_ellipj/ellip_acd_cmplx.c b/dspl/src/math_ellipj/ellip_acd_cmplx.c index ed77685..8428615 100644 --- a/dspl/src/math_ellipj/ellip_acd_cmplx.c +++ b/dspl/src/math_ellipj/ellip_acd_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_acd_cmplx(complex_t* w, int n, double k, complex_t* u) + \brief Inverse Jacobi elliptic function \f$ u = \textrm{cd}^{-1}(w, k)\f$ of complex vector argument @@ -65,7 +65,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_acd_cmplx(complex_t* w, int n, double k, complex_t* u) + \brief Обратная эллиптическая функция Якоби \f$ u = \textrm{cd}^{-1}(w, k)\f$ комплексного аргумента diff --git a/dspl/src/math_ellipj/ellip_asn.c b/dspl/src/math_ellipj/ellip_asn.c index dd97024..1dcd55e 100644 --- a/dspl/src/math_ellipj/ellip_asn.c +++ b/dspl/src/math_ellipj/ellip_asn.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_asn(double* w, int n, double k, double* u) + \brief Inverse Jacobi elliptic function \f$ u = \textrm{sn}^{-1}(w, k)\f$ of real vector argument @@ -65,7 +65,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_asn(double* w, int n, double k, double* u) + \brief Обратная эллиптическая функция Якоби \f$ u = \textrm{sn}^{-1}(w, k)\f$ вещественного аргумента diff --git a/dspl/src/math_ellipj/ellip_asn_cmplx.c b/dspl/src/math_ellipj/ellip_asn_cmplx.c index 501c852..8917b06 100644 --- a/dspl/src/math_ellipj/ellip_asn_cmplx.c +++ b/dspl/src/math_ellipj/ellip_asn_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_asn_cmplx(complex_t* w, int n, double k, complex_t* u) + \brief Inverse Jacobi elliptic function \f$ u = \textrm{sn}^{-1}(w, k)\f$ of complex vector argument @@ -65,7 +65,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_asn_cmplx(complex_t* w, int n, double k, complex_t* u) + \brief Обратная эллиптическая функция Якоби \f$ u = \textrm{sn}^{-1}(w, k)\f$ комплексного аргумента diff --git a/dspl/src/math_ellipj/ellip_cd.c b/dspl/src/math_ellipj/ellip_cd.c index dbcfb8f..7add99c 100644 --- a/dspl/src/math_ellipj/ellip_cd.c +++ b/dspl/src/math_ellipj/ellip_cd.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_cd(double* u, int n, double k, double* y) + \brief Jacobi elliptic function \f$ y = \textrm{cd}(u K(k), k)\f$ of real vector argument @@ -75,7 +75,7 @@ Also program draws the plot of calculated elliptic functions. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \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$ вещественного аргумента diff --git a/dspl/src/math_ellipj/ellip_cd_cmplx.c b/dspl/src/math_ellipj/ellip_cd_cmplx.c index ec81aad..1370a68 100644 --- a/dspl/src/math_ellipj/ellip_cd_cmplx.c +++ b/dspl/src/math_ellipj/ellip_cd_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_cd_cmplx(complex_t* u, int n, double k, complex_t* y) + \brief Jacobi elliptic function \f$ y = \textrm{cd}(u K(k), k)\f$ of complex vector argument @@ -65,7 +65,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_cd_cmplx(complex_t* u, int n, double k, complex_t* y) + \brief Эллиптическая функция Якоби \f$ y = \textrm{cd}(u K(k), k)\f$ комплексного аргумента diff --git a/dspl/src/math_ellipj/ellip_landen.c b/dspl/src/math_ellipj/ellip_landen.c index 6f7c3a2..55b146d 100644 --- a/dspl/src/math_ellipj/ellip_landen.c +++ b/dspl/src/math_ellipj/ellip_landen.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_landen(double k, int n, double* y) + \brief Function calculates complete elliptical integral coefficients \f$ k_i \f$ @@ -101,7 +101,7 @@ Result: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_landen(double k, int n, double* y) + \brief Расчет коэффициентов \f$ k_i \f$ ряда полного эллиптического интеграла. Полный эллиптический интеграл \f$ K(k) \f$ может быть представлен рядом: diff --git a/dspl/src/math_ellipj/ellip_modulareq.c b/dspl/src/math_ellipj/ellip_modulareq.c index 6421b60..e66f8e0 100644 --- a/dspl/src/math_ellipj/ellip_modulareq.c +++ b/dspl/src/math_ellipj/ellip_modulareq.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_ellipj/ellip_rat.c b/dspl/src/math_ellipj/ellip_rat.c index d3ad18a..b21beae 100644 --- a/dspl/src/math_ellipj/ellip_rat.c +++ b/dspl/src/math_ellipj/ellip_rat.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_ellipj/ellip_sn.c b/dspl/src/math_ellipj/ellip_sn.c index ce6515c..b358968 100644 --- a/dspl/src/math_ellipj/ellip_sn.c +++ b/dspl/src/math_ellipj/ellip_sn.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -31,7 +31,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_sn(double* u, int n, double k, double* y) + \brief Jacobi elliptic function \f$ y = \textrm{sn}(u K(k), k)\f$ of real vector argument @@ -76,7 +76,7 @@ Also program draws the plot of calculated elliptic functions. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \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$ вещественного аргумента diff --git a/dspl/src/math_ellipj/ellip_sn_cmplx.c b/dspl/src/math_ellipj/ellip_sn_cmplx.c index ad0e472..1c437dd 100644 --- a/dspl/src/math_ellipj/ellip_sn_cmplx.c +++ b/dspl/src/math_ellipj/ellip_sn_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_ELLIP_GROUP -\fn int ellip_sn_cmplx(complex_t* u, int n, double k, complex_t* y) + \brief Jacobi elliptic function \f$ y = \textrm{sn}(u K(k), k)\f$ of complex vector argument @@ -65,7 +65,7 @@ Memory must be allocated. \n \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \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$ комплексного аргумента diff --git a/dspl/src/math_matrix/matrix_eig_cmplx.c b/dspl/src/math_matrix/matrix_eig_cmplx.c index 8433b58..8c3650d 100644 --- a/dspl/src/math_matrix/matrix_eig_cmplx.c +++ b/dspl/src/math_matrix/matrix_eig_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,7 +30,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eig_cmplx(complex_t* a, int n, complex_t* v, int* info) \brief Eigenvalues calculation of the complex square matrix `a`. @@ -86,7 +85,6 @@ v = [ % size [3 x 1] type: complex #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eig_cmplx(complex_t* a, int n, complex_t* v, int* info) \brief Расчет собственных значений квадратной комплексной матрицы. diff --git a/dspl/src/math_matrix/matrix_eye.c b/dspl/src/math_matrix/matrix_eye.c index f106922..9c0b880 100644 --- a/dspl/src/math_matrix/matrix_eye.c +++ b/dspl/src/math_matrix/matrix_eye.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eye(double* a, int n, int m) + \brief The real identity matrix size `n x m` generation. Function fills matrix `a` by zeros and sets main diagonal as ones. @@ -54,7 +54,7 @@ Else \ref ERROR_CODE_GROUP "code error". \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eye(double* a, int n, int m) + \brief Генерирование единичной вещественной матрицы размерности `n x m`. Данная функция заполняет матрицу нулями diff --git a/dspl/src/math_matrix/matrix_eye_cmplx.c b/dspl/src/math_matrix/matrix_eye_cmplx.c index efea70a..8211791 100644 --- a/dspl/src/math_matrix/matrix_eye_cmplx.c +++ b/dspl/src/math_matrix/matrix_eye_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eye_cmplx(complex_t* a, int n, int m) + \brief The complex identity matrix size `n x m` generation. Function fills matrix `a` by zeros and sets main diagonal as ones. @@ -55,7 +55,7 @@ Else \ref ERROR_CODE_GROUP "code error". \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_eye_cmplx(complex_t* a, int n, int m) + \brief Генерирование единичной комплексной матрицы размерности `n x m`. Данная функция заполняет матрицу нулями diff --git a/dspl/src/math_matrix/matrix_mul.c b/dspl/src/math_matrix/matrix_mul.c index ea3acb5..9964313 100644 --- a/dspl/src/math_matrix/matrix_mul.c +++ b/dspl/src/math_matrix/matrix_mul.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,8 +30,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_mul(double* a, int na, int ma, double* b, int nb, int mb, - double* c) + \brief Matrix multiplication. The function calculates the product of matrices \f$\mathbf{C} = \mathbf{AB}\f$, @@ -110,8 +109,7 @@ C = [ % size [4 x 3] type: real #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_LINALG_GROUP -\fn int matrix_mul(double* a, int na, int ma, double* b, int nb, int mb, - double* c) + \brief Произведение вещественных матриц. Функция рассчитывает произведение матриц \f$\mathbf{C} = \mathbf{AB}\f$, diff --git a/dspl/src/math_matrix/matrix_pinv.c b/dspl/src/math_matrix/matrix_pinv.c index 47d6bb6..2c4f774 100644 --- a/dspl/src/math_matrix/matrix_pinv.c +++ b/dspl/src/math_matrix/matrix_pinv.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_print.c b/dspl/src/math_matrix/matrix_print.c index faaa6f6..ac9c5f8 100644 --- a/dspl/src/math_matrix/matrix_print.c +++ b/dspl/src/math_matrix/matrix_print.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_print_cmplx.c b/dspl/src/math_matrix/matrix_print_cmplx.c index b2f72df..c1eddcb 100644 --- a/dspl/src/math_matrix/matrix_print_cmplx.c +++ b/dspl/src/math_matrix/matrix_print_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_svd.c b/dspl/src/math_matrix/matrix_svd.c index 6b30591..413e48d 100644 --- a/dspl/src/math_matrix/matrix_svd.c +++ b/dspl/src/math_matrix/matrix_svd.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_transpose.c b/dspl/src/math_matrix/matrix_transpose.c index 8f38ce6..0f2ca85 100644 --- a/dspl/src/math_matrix/matrix_transpose.c +++ b/dspl/src/math_matrix/matrix_transpose.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_transpose_cmplx.c b/dspl/src/math_matrix/matrix_transpose_cmplx.c index b696974..7fda3b5 100644 --- a/dspl/src/math_matrix/matrix_transpose_cmplx.c +++ b/dspl/src/math_matrix/matrix_transpose_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/matrix_transpose_hermite.c b/dspl/src/math_matrix/matrix_transpose_hermite.c index 235c020..094a947 100644 --- a/dspl/src/math_matrix/matrix_transpose_hermite.c +++ b/dspl/src/math_matrix/matrix_transpose_hermite.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_matrix/vector_dot.c b/dspl/src/math_matrix/vector_dot.c index 10b43dc..e7e36bc 100644 --- a/dspl/src/math_matrix/vector_dot.c +++ b/dspl/src/math_matrix/vector_dot.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/math_poly/cheby_poly1.c b/dspl/src/math_poly/cheby_poly1.c index d0cc818..3a58ddc 100644 --- a/dspl/src/math_poly/cheby_poly1.c +++ b/dspl/src/math_poly/cheby_poly1.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int cheby_poly1(double* x, int n, int ord, double* y) + \brief Chebyshev polynomial of the first kind order `ord` Function calculates Chebyshev polynomial \f$ C_{ord}(x)\f$ of the first kind @@ -81,7 +81,7 @@ GNUPLOT package will create Chebyshev polynomials plot from saved text-files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int cheby_poly1(double* x, int n, int ord, double* y) + \brief Многочлен Чебышева первого рода порядка `ord` Функция производит расчет многочлена Чебышева первого рода \f$ C_{ord}(x)\f$ для diff --git a/dspl/src/math_poly/cheby_poly2.c b/dspl/src/math_poly/cheby_poly2.c index 1f6e2dd..1e3fcd5 100644 --- a/dspl/src/math_poly/cheby_poly2.c +++ b/dspl/src/math_poly/cheby_poly2.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -27,7 +27,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int cheby_poly2(double* x, int n, int ord, double* y) + \brief Chebyshev polynomial of the second kind order `ord` Function calculates Chebyshev polynomial \f$ U_ord(x)\f$ of the first kind @@ -78,7 +78,7 @@ GNUPLOT package will create Chebyshev polynomials plot from saved text-files: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int cheby_poly2(double* x, int n, int ord, double* y) + \brief Многочлен Чебышева второго рода порядка `ord` Функция производит расчет многочлена Чебышева второго рода \f$ U_{ord}(x)\f$ diff --git a/dspl/src/math_poly/polyroots.c b/dspl/src/math_poly/polyroots.c index 31a49cb..04256aa 100644 --- a/dspl/src/math_poly/polyroots.c +++ b/dspl/src/math_poly/polyroots.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int polyroots(double* a, int ord, complex_t* r, int* info) + \brief Function calculates real polynomial roots. Function calculates roots of the real polynomial \f$P_N(x)\f$ order \f$N\f$ @@ -91,7 +91,7 @@ r[1] = -1.00000-1.00000 j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int polyroots(double* a, int ord, complex_t* r, int* info) + \brief Расчет корней вещественного полинома Функция рассчитывает корни полинома \f$P_N(x)\f$ \f$N-\f$ого diff --git a/dspl/src/math_poly/polyval.c b/dspl/src/math_poly/polyval.c index 620e78b..8314d98 100644 --- a/dspl/src/math_poly/polyval.c +++ b/dspl/src/math_poly/polyval.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -30,7 +30,7 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int polyval(double* a, int ord, double* x, int n, double* y) + \brief Расчет вещественного полинома Функция рассчитывает полином \f$P_N(x)\f$ \f$N-\f$ого порядка для вещественного diff --git a/dspl/src/math_poly/polyval_cmplx.c b/dspl/src/math_poly/polyval_cmplx.c index 68f276e..bea1609 100644 --- a/dspl/src/math_poly/polyval_cmplx.c +++ b/dspl/src/math_poly/polyval_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -33,7 +33,7 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_POLY_GROUP -\fn int polyval_cmplx(complex_t* a, int ord, complex_t* x, int n, complex_t* y) + \brief Расчет комплексного полинома Функция рассчитывает полином \f$P_N(x)\f$ \f$N\f$-го порядка diff --git a/dspl/src/math_stat/find_max_abs.c b/dspl/src/math_stat/find_max_abs.c index 99112c1..54d4fc0 100644 --- a/dspl/src/math_stat/find_max_abs.c +++ b/dspl/src/math_stat/find_max_abs.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int find_max_abs(double* a, int n, double* m, int* ind) + \brief Find maximum absolute value from the real vector `a` Function searches maximum absolute value in the real vector `a`. @@ -76,7 +76,7 @@ and variable `ind` will keep `2`. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int find_max_abs(double* a, int n, double* m, int* ind) + \brief Поиск максимального по модулю элемента вещественного вектора `a` Функция производит поиск максимального по модулю значения вектора `a`. \n diff --git a/dspl/src/math_stat/histogram.c b/dspl/src/math_stat/histogram.c index b39139a..228bd9b 100644 --- a/dspl/src/math_stat/histogram.c +++ b/dspl/src/math_stat/histogram.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_stat/histogram_norm.c b/dspl/src/math_stat/histogram_norm.c index 2cb3e3d..7177514 100644 --- a/dspl/src/math_stat/histogram_norm.c +++ b/dspl/src/math_stat/histogram_norm.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_stat/mean.c b/dspl/src/math_stat/mean.c index 4a77ffe..5cb3b05 100644 --- a/dspl/src/math_stat/mean.c +++ b/dspl/src/math_stat/mean.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int mean(double* x, int n, double* m) + \brief Calculates the mean of the input vector `x` Function calculates the mean value @@ -66,7 +66,7 @@ As result the variable `m` will keep value `2`. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int mean(double* x, int n, double* m) + \brief Выборочная оценка математического ожидания вещественного вектора `x` Функция рассчитывает оценку математического ожидания diff --git a/dspl/src/math_stat/mean_cmplx.c b/dspl/src/math_stat/mean_cmplx.c index bc47024..84a00d2 100644 --- a/dspl/src/math_stat/mean_cmplx.c +++ b/dspl/src/math_stat/mean_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -32,7 +32,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int mean_cmplx(complex_t* x, int n, complex_t* m) + \brief Calculates the mean of the complex input vector `x` Function calculates the mean value @@ -69,7 +69,7 @@ As result the variable `m` will keep value `1 + 3j`. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int mean_cmplx(complex_t* x, int n, complex_t* m) + \brief Выборочная оценка математического ожидания комплексного вектора `x` Функция рассчитывает оценку математического ожидания diff --git a/dspl/src/math_stat/minmax.c b/dspl/src/math_stat/minmax.c index 46d3590..c09b9c6 100644 --- a/dspl/src/math_stat/minmax.c +++ b/dspl/src/math_stat/minmax.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_stat/stat_std.c b/dspl/src/math_stat/stat_std.c index 07c8db0..9c927be 100644 --- a/dspl/src/math_stat/stat_std.c +++ b/dspl/src/math_stat/stat_std.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -32,7 +32,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int stat_std(double* x, int n, double* s) + \brief Calculates the standard deviation of the input vector `x` Function calculates the the standard deviation value @@ -73,7 +73,7 @@ As result the variable `s` will keep value `1.5811`. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int stat_std(double* x, int n, double* s) + \brief Выборочная оценка стандартного отклонения вещественного вектора `x` Функция рассчитывает оценку стандартного отклонения diff --git a/dspl/src/math_stat/stat_std_cmplx.c b/dspl/src/math_stat/stat_std_cmplx.c index c6be69c..4449e0a 100644 --- a/dspl/src/math_stat/stat_std_cmplx.c +++ b/dspl/src/math_stat/stat_std_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int stat_std_cmplx(complex_t* x, int n, double* s) + \brief Calculates the standard deviation of the complex input vector `x` Function calculates the the standard deviation value @@ -64,11 +64,12 @@ Example: As result the variable `s` will keep value `3.3665`. \author Sergey Bakhurin www.dsplib.org -***************************************************************************** */#endif +***************************************************************************** */ +#endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int stat_std_cmplx(complex_t* x, int n, double* s) + \brief Выборочная оценка стандартного отклонения комплексного вектора `x` Функция рассчитывает оценку стандартного отклонения diff --git a/dspl/src/math_stat/xcorr.c b/dspl/src/math_stat/xcorr.c index bf3a679..7cf52a3 100644 --- a/dspl/src/math_stat/xcorr.c +++ b/dspl/src/math_stat/xcorr.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -38,8 +38,7 @@ int xcorr_scale_cmplx(complex_t* x, int nd, int flag); #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int xcorr(double* x, int nx, double* y, int ny, - int flag, int nr, double* r, double* t) + \brief Estimates the cross-correlation vector for real discrete-time sequences `x` and `y`. @@ -126,8 +125,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -\fn int xcorr(double* x, int nx, double* y, int ny, - int flag, int nr, double* r, double* t) + \brief Оценка вектора взаимной корреляции для дискретных вещественных последовательностей `x` и `y`. @@ -199,7 +197,7 @@ Else \ref ERROR_CODE_GROUP "code error". \param[out] t Указатель на значения аргумента вектора взаимной корреляции -\f$ k= -n_r,\,\, -n_r +1, \ldors n_r\f$.\n +\f$ k= -n_r,\,\, -n_r +1, \ldots n_r\f$.\n Размер вектора `[(2*nr+1) x 1]`. \n Указатель может быть `NULL`. В этом случае значения аргумента не возвращаются.\n \n @@ -273,8 +271,7 @@ exit_label: #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -int xcorr_cmplx(complex_t* x, int nx, complex_t* y, int ny, - int flag, int nr, complex_t* r, double* t) + \brief Estimates the cross-correlation vector for complex discrete-time sequences `x` and `y`. @@ -346,7 +343,7 @@ Memory must be allocated. \n \param[out] r Pointer to the cross-correlation argument vector -\f$ k= -n_r,\,\, -n_r +1, \ldors n_r\f$.\n +\f$ k= -n_r,\,\, -n_r +1, \ldots n_r\f$.\n Vector size is `[(2*nr+1) x 1]`. \n Pointer can be `NULL`. \n \n @@ -361,8 +358,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_STAT_GROUP -int xcorr_cmplx(complex_t* x, int nx, complex_t* y, int ny, - int flag, int nr, complex_t* r, double* t) + \brief Оценка вектора взаимной корреляции для дискретных комплексных последовательностей `x` и `y`. @@ -434,7 +430,7 @@ int xcorr_cmplx(complex_t* x, int nx, complex_t* y, int ny, \param[out] t Указатель на значения аргумента вектора взаимной корреляции -\f$ k= -n_r,\,\, -n_r +1, \ldors n_r\f$.\n +\f$ k= -n_r,\,\, -n_r +1, \ldots n_r\f$.\n Размер вектора `[(2*nr+1) x 1]`. \n Указатель может быть `NULL`. В этом случае значения аргумента не возвращаются.\n \n diff --git a/dspl/src/math_std/acos_cmplx.c b/dspl/src/math_std/acos_cmplx.c index 187e072..a245b06 100644 --- a/dspl/src/math_std/acos_cmplx.c +++ b/dspl/src/math_std/acos_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #if DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int acos_cmplx(complex_t* x, int n, complex_t *y) + \brief The inverse of the cosine function the complex vector argument `x`. Function calculates the inverse of the cosine function as: \n @@ -81,7 +81,7 @@ acos_cmplx(5.0+6.0j) = 0.880-2.749j #if DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int acos_cmplx(complex_t* x, int n, complex_t *y) + \brief Арккосинус комплексного аргумента `x`. Функция рассчитывает значения арккосинуса комплексного аргумента, diff --git a/dspl/src/math_std/asin_cmplx.c b/dspl/src/math_std/asin_cmplx.c index 8aa72ed..25ef19c 100644 --- a/dspl/src/math_std/asin_cmplx.c +++ b/dspl/src/math_std/asin_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int asin_cmplx(complex_t* x, int n, complex_t *y) + \brief The inverse of the sine function the complex vector argument `x`. Function calculates the inverse of the sine function as: \n @@ -81,7 +81,7 @@ asin_cmplx(5.0+6.0j) = 0.691+2.749j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int asin_cmplx(complex_t* x, int n, complex_t *y) + \brief Арксинус комплексного аргумента `x`. Функция рассчитывает значения арксинуса комплексного аргумента, diff --git a/dspl/src/math_std/bessel_i0.c b/dspl/src/math_std/bessel_i0.c index 6c938b1..25445ec 100644 --- a/dspl/src/math_std/bessel_i0.c +++ b/dspl/src/math_std/bessel_i0.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRANSCEND -\fn int bessel_i0(double* x, int n, double* y) + \brief Modified Bessel Function of the First Kind – \f$ I_0(x)\f$ [1]. \param[in] x @@ -69,7 +69,7 @@ Data saved if `dat/dat0.txt` file and shows on the plot #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRANSCEND -\fn int bessel_i0(double* x, int n, double* y) + \brief Модифицированная функция Бесселя первого рода \f$ I_0(x)\f$. diff --git a/dspl/src/math_std/cos_cmplx.c b/dspl/src/math_std/cos_cmplx.c index dcf33c4..6f0c6e3 100644 --- a/dspl/src/math_std/cos_cmplx.c +++ b/dspl/src/math_std/cos_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int cos_cmplx(complex_t* x, int n, complex_t *y) + \brief The cosine function the complex vector argument `x`. Function calculates the cosine function as: \n @@ -81,7 +81,7 @@ cos_cmplx(5.0+6.0j) = 57.219 +193.428j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int cos_cmplx(complex_t* x, int n, complex_t *y) + \brief Косинус комплексного аргумента `x`. Функция рассчитывает значения косинуса комплексного аргумента, diff --git a/dspl/src/math_std/dmod.c b/dspl/src/math_std/dmod.c index e30795a..ef7df65 100644 --- a/dspl/src/math_std/dmod.c +++ b/dspl/src/math_std/dmod.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_std/log_cmplx.c b/dspl/src/math_std/log_cmplx.c index 1b916f0..83b49d0 100644 --- a/dspl/src/math_std/log_cmplx.c +++ b/dspl/src/math_std/log_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -29,7 +29,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int log_cmplx(complex_t* x, int n, complex_t *y) + \brief The logarithm function the complex vector argument `x`. Function calculates the logarithm function as: \n @@ -83,7 +83,7 @@ Sergey Bakhurin www.dsplib.org #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int log_cmplx(complex_t* x, int n, complex_t *y) + \brief Натуральный логарифм комплексного аргумента `x`. Функция рассчитывает значения натурального логарифма комплексного аргумента, diff --git a/dspl/src/math_std/sin_cmplx.c b/dspl/src/math_std/sin_cmplx.c index 52cb880..1cf90cf 100644 --- a/dspl/src/math_std/sin_cmplx.c +++ b/dspl/src/math_std/sin_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -27,7 +27,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int sin_cmplx(complex_t* x, int n, complex_t *y) + \brief The sine function the complex vector argument `x`. Function calculates the sine function as: \n @@ -81,7 +81,7 @@ sin_cmplx(5.0+6.0j) = -193.430 +57.218j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRIG_GROUP -\fn int sin_cmplx(complex_t* x, int n, complex_t *y) + \brief Синус комплексного аргумента `x`. Функция рассчитывает значения синуса комплексного аргумента, diff --git a/dspl/src/math_std/sinc.c b/dspl/src/math_std/sinc.c index 8c69ac2..fff99e8 100644 --- a/dspl/src/math_std/sinc.c +++ b/dspl/src/math_std/sinc.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -26,7 +26,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int sinc(double* x, int n, double a, double* y) + \brief Function \f$ \textrm{sinc}(x,a) = \frac{\sin(ax)}{ax}\f$ for the real vector `x`. @@ -55,7 +55,7 @@ Else \ref ERROR_CODE_GROUP "code error". \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int sinc(double* x, int n, double a, double* y) + \brief Функция \f$ \textrm{sinc}(x,a) = \frac{\sin(ax)}{ax}\f$. Функция рассчитывает значения функции для вещественного вектора `x`. diff --git a/dspl/src/math_std/sine_int.c b/dspl/src/math_std/sine_int.c index 24e7131..ab0a8b5 100644 --- a/dspl/src/math_std/sine_int.c +++ b/dspl/src/math_std/sine_int.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -26,7 +26,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_TRANSCEND -\fn int sine_int(double* x, int n, double* si) + \brief Sine integral function \f$\textrm{Si}(x)\f$ for the real vector `x`. \f[ \textrm{Si}(x) = \int_{0}^{x} \frac{\sin(x)}{x} \, dx\f] @@ -71,7 +71,7 @@ Functions values saved to th #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_TRANSCEND -\fn int sine_int(double* x, int n, double* si) + \brief Функция интегрального синуса \f[ \textrm{Si}(x) = \int_{0}^{x} \frac{\sin(x)}{x} \, dx\f] Функция рассчитывает значения функции для интегрального синуса diff --git a/dspl/src/math_std/sqrt_cmplx.c b/dspl/src/math_std/sqrt_cmplx.c index 80b182a..98f5715 100644 --- a/dspl/src/math_std/sqrt_cmplx.c +++ b/dspl/src/math_std/sqrt_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2023 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. @@ -28,7 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int sqrt_cmplx(complex_t* x, int n, complex_t *y) + \brief Square root of the complex vector argguument `x`. Function calculates square root value of vector `x` length `n`: \n @@ -81,7 +81,7 @@ sqrt_cmplx(5.0+6.0j) = 2.531+1.185j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup SPEC_MATH_COMMON_GROUP -\fn int sqrt_cmplx(complex_t* x, int n, complex_t *y) + \brief Квадратный корень из комплексного вектора `x` (поэлементный). Функция рассчитывает значения квадратного корня комплексного аргумента, diff --git a/dspl/src/math_std/trapint.c b/dspl/src/math_std/trapint.c index 9225ba4..1ca43a0 100644 --- a/dspl/src/math_std/trapint.c +++ b/dspl/src/math_std/trapint.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_std/trapint_cmplx.c b/dspl/src/math_std/trapint_cmplx.c index 6d57932..971589e 100644 --- a/dspl/src/math_std/trapint_cmplx.c +++ b/dspl/src/math_std/trapint_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of DSPL. diff --git a/dspl/src/math_std/unwrap.c b/dspl/src/math_std/unwrap.c index 3b884b6..14e2928 100644 --- a/dspl/src/math_std/unwrap.c +++ b/dspl/src/math_std/unwrap.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/psd/psd_bartlett.c b/dspl/src/psd/psd_bartlett.c index 44aa20d..9e24701 100644 --- a/dspl/src/psd/psd_bartlett.c +++ b/dspl/src/psd/psd_bartlett.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -32,9 +32,6 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PSD_GROUP -\fn int psd_bartlett(double* x, int n, int nfft, - fft_t* pfft, double fs, - int flag, double* ppsd, double* pfrq) \brief Непараметрическая оценка спектральной плотности мощности (СПМ) вещественного сигнала методом Бартлетта. diff --git a/dspl/src/psd/psd_bartlett_cmplx.c b/dspl/src/psd/psd_bartlett_cmplx.c index 6a0ae05..4fa99e7 100644 --- a/dspl/src/psd/psd_bartlett_cmplx.c +++ b/dspl/src/psd/psd_bartlett_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -31,9 +31,6 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PSD_GROUP -\fn int psd_bartlett_cmplx(complex_t* x, int n, int nfft, - fft_t* pfft, double fs, - int flag, double* ppsd, double* pfrq) \brief Непараметрическая оценка спектральной плотности мощности (СПМ) комплексного сигнала методом Бартлетта. @@ -114,7 +111,7 @@ DSPL_FLAG_PSD_TWOSIDED - двусторонняя СПМ (от -Fs/2 до Fs/2) Пример оценок СПМ методом Бартлетта: -\include psd_bartlett_test_cmplx.c +\include psd_bartlett_cmplx_test.c Программа производит расчет СПМ сигнала, состоящего из двух комплексных экспонент на фоне белого гауссова шума. diff --git a/dspl/src/psd/psd_periodogram.c b/dspl/src/psd/psd_periodogram.c index 9bcce33..27ef810 100644 --- a/dspl/src/psd/psd_periodogram.c +++ b/dspl/src/psd/psd_periodogram.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -32,10 +32,6 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PSD_GROUP -\fn int psd_periodogram(double* x, int n, - int win_type, double win_param, - fft_t* pfft, double fs, - int flag, double* ppsd, double* pfrq) \brief Непараметрическая оценка спектральной плотности мощности (СПМ) вещественного сигнала методом модифицированной периодограммы. diff --git a/dspl/src/psd/psd_periodogram_cmplx.c b/dspl/src/psd/psd_periodogram_cmplx.c index 75778cd..8c7ccd7 100644 --- a/dspl/src/psd/psd_periodogram_cmplx.c +++ b/dspl/src/psd/psd_periodogram_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -32,10 +32,6 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PSD_GROUP -\fn int psd_periodogram_cmplx(complex_t* x, int n, - int win_type, double win_param, - fft_t* pfft, double fs, - int flag, double* ppsd, double* pfrq) \brief Непараметрическая оценка спектральной плотности мощности (СПМ) комплексного сигнала методом модифицированной периодограммы. diff --git a/dspl/src/psd/psd_welch.c b/dspl/src/psd/psd_welch.c index 6ea1ad4..662f05c 100644 --- a/dspl/src/psd/psd_welch.c +++ b/dspl/src/psd/psd_welch.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. diff --git a/dspl/src/psd/psd_welch_cmplx.c b/dspl/src/psd/psd_welch_cmplx.c index d5fa39e..dfc71f5 100644 --- a/dspl/src/psd/psd_welch_cmplx.c +++ b/dspl/src/psd/psd_welch_cmplx.c @@ -1,5 +1,5 @@ /* -* Copyright (c) 2015-2022 Sergey Bakhurin +* Copyright (c) 2015-2024 Sergey Bakhurin * Digital Signal Processing Library [http://dsplib.org] * * This file is part of libdspl-2.0. @@ -31,10 +31,7 @@ #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup PSD_GROUP -int psd_welch_cmplx(complex_t* x, int n, - int win_type, double win_param, - int nfft, int noverlap, fft_t* pfft, double fs, - int flag, double* ppsd, double* pfrq) + \brief Непараметрическая оценка спектральной плотности мощности (СПМ) комплексного сигнала методом Уэлча.