diff --git a/dspl/src/array/array_scale_lin.c b/dspl/src/array/array_scale_lin.c index 8091942..d9ae3ed 100644 --- a/dspl/src/array/array_scale_lin.c +++ b/dspl/src/array/array_scale_lin.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,10 +27,8 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int array_scale_lin(double* x, int n, - double xmin, double xmax, double dx, - double h, double* y) +\ingroup ARRAY_GROUP + \brief Vector `x` linear transformation Function transforms values \f$x(i)\f$, \f$i = 0,1,\ldots n\f$ @@ -100,9 +98,7 @@ Else \ref ERROR_CODE_GROUP "code error". #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int array_scale_lin(double* x, int n, - double xmin, double xmax, double dx, - double h, double* y) + \brief Линейное растяжение вектора данных `x` Функция производит преобразование значений \f$x(i)\f$, \f$i = 0,1,\ldots n\f$ в значения \f$y(i)\f$, в соответствии с формулой: diff --git a/dspl/src/array/concat.c b/dspl/src/array/concat.c index d229f98..1a2d355 100644 --- a/dspl/src/array/concat.c +++ b/dspl/src/array/concat.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 ARRAY_GROUP -\fn int concat(void* a, size_t na, void* b, size_t nb, void* c) + \brief Concatenate arrays `a` and `b` @@ -89,7 +89,7 @@ c = [1.0, 2.0, 3.0, 4.0, 5.0] #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int concat(void* a, size_t na, void* b, size_t nb, void* c) + \brief Конкатенация двух массивов данных Функция производит конкатенацию двух массивов. Пусть массивы `a` и `b` diff --git a/dspl/src/array/decimate.c b/dspl/src/array/decimate.c index 774c0b4..518bc40 100644 --- a/dspl/src/array/decimate.c +++ b/dspl/src/array/decimate.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 ARRAY_GROUP -\fn int decimate(double* x, int n, int d, double* y, int* cnt) + \brief Real vector decimation @@ -83,7 +83,7 @@ c = [0.0, 2.0, 4.0, 6.0, 8.0] #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int decimate(double* x, int n, int d, double* y, int* cnt) + \brief Децимация вещественного вектора данных Функция производит децимацию вещественного вектора `x` в `d` раз. \n diff --git a/dspl/src/array/decimate_cmplx.c b/dspl/src/array/decimate_cmplx.c index 08fdf7d..d8f20df 100644 --- a/dspl/src/array/decimate_cmplx.c +++ b/dspl/src/array/decimate_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. @@ -27,8 +27,8 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int decimate_cmplx(complex_t* x, int n, int d, complex_t* y, int* cnt) +\ingroup ARRAY_GROUP + \brief Complex vector decimation @@ -88,7 +88,7 @@ c = [0.0+0.0j, 2.0+2.0j, 4.0+4.0j, 6.0+6.0j, 8.0+8.0j] #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int decimate_cmplx(complex_t* x, int n, int d, complex_t* y, int* cnt) + \brief Децимация комплексного вектора данных Функция производит децимацию комплексного вектора `x` в `d` раз. \n diff --git a/dspl/src/array/find_nearest.c b/dspl/src/array/find_nearest.c index 488f1fa..ba65269 100644 --- a/dspl/src/array/find_nearest.c +++ b/dspl/src/array/find_nearest.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/array/flipip.c b/dspl/src/array/flipip.c index 568440b..030ba06 100644 --- a/dspl/src/array/flipip.c +++ b/dspl/src/array/flipip.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 ARRAY_GROUP -\fn int flipip(double* x, int n) + \brief Flip real vector `x` in place @@ -81,7 +81,7 @@ Program result: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int flipip(double* x, int n) + \brief Функция отражения вещественного вектора `x` Функция производит отражение вещественного вектора длины `n` diff --git a/dspl/src/array/flipip_cmplx.c b/dspl/src/array/flipip_cmplx.c index f0f8597..1660ff5 100644 --- a/dspl/src/array/flipip_cmplx.c +++ b/dspl/src/array/flipip_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 ARRAY_GROUP -\fn int flipip_cmplx(complex_t* x, int n) + \brief Flip complex vector `x` in place Function flips complex vector `x` length `n` in the memory @@ -79,7 +79,7 @@ Program result: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int flipip_cmplx(complex_t* x, int n) + \brief Функция отражения комплексного вектора `x` Функция производит отражение комплексного вектора длины `n` diff --git a/dspl/src/array/linspace.c b/dspl/src/array/linspace.c index 4bdcf9a..ff793c0 100644 --- a/dspl/src/array/linspace.c +++ b/dspl/src/array/linspace.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 ARRAY_GROUP -\fn int linspace(double x0, double x1, int n, int type, double* x) + \brief Function fills a vector with `n` linearly spaced elements between `x0` and `x1`. @@ -96,7 +96,7 @@ Values in the vector `x` are: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int linspace(double x0, double x1, int n, int type, double* x) + \brief Функция заполняет массив линейно-нарастающими, равноотстоящими значениями от `x0` до `x1` diff --git a/dspl/src/array/logspace.c b/dspl/src/array/logspace.c index d6e8f09..13c4a3d 100644 --- a/dspl/src/array/logspace.c +++ b/dspl/src/array/logspace.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 ARRAY_GROUP -\fn int logspace(double x0, double x1, int n, int type, double* x) + \brief Function fills a vector with `n` logarithmically spaced elements between \f$10^{x_0}\f$ and \f$10^{x_1}\f$. @@ -105,7 +105,7 @@ Values in the vector `x` are: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int logspace(double x0, double x1, int n, int type, double* x) + \brief Функция заполняет массив значениями логарифмической шкале Заполняет массив `x` длиной `n` значениями в диапазоне diff --git a/dspl/src/array/ones.c b/dspl/src/array/ones.c index e82d602..e16279a 100644 --- a/dspl/src/array/ones.c +++ b/dspl/src/array/ones.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,8 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int ones(double* x, int n) +\ingroup ARRAY_GROUP + \brief Function fills all real vector `x` by ones values. \param[in, out] x @@ -66,7 +66,6 @@ Vector `y` values are: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int ones(double* x, int n) \brief Функция заполнения вещественного массива единицами \param[in, out] x diff --git a/dspl/src/array/sum.c b/dspl/src/array/sum.c index fb4ab53..67f7822 100644 --- a/dspl/src/array/sum.c +++ b/dspl/src/array/sum.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,15 +28,48 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int sum(double* x, int n, double* s) +\ingroup ARRAY_GROUP + \author Sergey Bakhurin www.dsplib.org ***************************************************************************** */ #endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int sum(double* x, int n, double* s) +\brief Расчет суммы элеметов массива + +\param[in] x +Указатель на вещественный вектор `x`. \n +Размер вектора `[n x 1]`. \n +\n + +\param[in] n +Размер вектора `x`. \n +\n + +\param[in] n +Указатель на переменную суммы элементов массива. \n +По данному указателю будет записан результат работы функции. +\n + + +\return +`RES_OK` если функция выполнена успешно. \n +В противном случае \ref ERROR_CODE_GROUP "код ошибки". + +Пример: +\code{.cpp} +double y[5] = {0.0, 1.0, 2.0, 3.0, 4.0}; +double s; +sum(y, 5, &s); +printf("s = %6.1f% \n", s); +\endcode + \n +Результат выполнения: +\verbatim + s = 10 +\endverbatim + \author Бахурин Сергей www.dsplib.org ***************************************************************************** */ #endif diff --git a/dspl/src/array/sum_sqr.c b/dspl/src/array/sum_sqr.c index a5899b6..dd8238e 100644 --- a/dspl/src/array/sum_sqr.c +++ b/dspl/src/array/sum_sqr.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,15 +27,15 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int sum(double* x, int n, double* s) +\ingroup ARRAY_GROUP + \author Sergey Bakhurin www.dsplib.org ***************************************************************************** */ #endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int sum(double* x, int n, double* s) + \author Бахурин Сергей www.dsplib.org ***************************************************************************** */ #endif diff --git a/dspl/src/array/verif.c b/dspl/src/array/verif.c index af58644..e5357bd 100644 --- a/dspl/src/array/verif.c +++ b/dspl/src/array/verif.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,8 +27,8 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup ARRAY_GROUP -\fn int verif(double* x, double* y, size_t n, double eps, double* err) +\ingroup ARRAY_GROUP + \brief Real arrays verification Function calculates a maximum relative error between two real arrays `x` @@ -78,7 +78,7 @@ Otherwise `DSPL_VERIF_FAILED`. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int verif(double* x, double* y, size_t n, double eps, double* err) + \brief Верификация вещественных массивов Функция производит расчет максимальной относительной ошибки между вещественными diff --git a/dspl/src/array/verif_cmplx.c b/dspl/src/array/verif_cmplx.c index 10ec8f7..21becb8 100644 --- a/dspl/src/array/verif_cmplx.c +++ b/dspl/src/array/verif_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. @@ -31,8 +31,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int verif_cmplx(complex_t* x, complex_t* y, size_t n, - double eps, double* err) + \brief Complex arrays verification @@ -87,8 +86,7 @@ www.dsplib.org #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup ARRAY_GROUP -\fn int verif_cmplx(complex_t* x, complex_t* y, size_t n, - double eps, double* err) + \brief Верификация комплексных массивов Функция производит расчет максимальной относительной ошибки между комплексными diff --git a/dspl/src/convolution/conv.c b/dspl/src/convolution/conv.c index 9a65360..62570e7 100644 --- a/dspl/src/convolution/conv.c +++ b/dspl/src/convolution/conv.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 FILTER_CONV_GROUP -\fn int conv(double* a, int na, double* b, int nb, double* c) \brief Real vectors linear convolution. Function convolves two real vectors \f$ c = a * b\f$ length `na` and `nb`. @@ -93,7 +92,6 @@ cr[5] = 12.0 #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv(double* a, int na, double* b, int nb, double* c) \brief Линейная свертка двух вещественных векторов Функция рассчитывает линейную свертку двух векторов \f$ c = a * b\f$. diff --git a/dspl/src/convolution/conv_cmplx.c b/dspl/src/convolution/conv_cmplx.c index af96337..a16f8b5 100644 --- a/dspl/src/convolution/conv_cmplx.c +++ b/dspl/src/convolution/conv_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,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_cmplx(complex_t* a, int na, complex_t* b, int nb, complex_t* c) \brief Complex vectors linear convolution. Function convolves two complex vectors \f$ c = a * b\f$ length `na` and `nb`. @@ -94,7 +93,6 @@ cc[5] = 0.0+24.0j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_cmplx(complex_t* a, int na, complex_t* b, int nb, complex_t* c) \brief Линейная свертка двух комплексных векторов Функция рассчитывает линейную свертку двух векторов \f$ c = a * b\f$. diff --git a/dspl/src/convolution/conv_fft.c b/dspl/src/convolution/conv_fft.c index 39bbad5..c3246ba 100644 --- a/dspl/src/convolution/conv_fft.c +++ b/dspl/src/convolution/conv_fft.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,8 +31,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_fft(double* a, int na, double* b, int nb, - fft_t* pfft, int nfft, double* c) \brief Real vectors fast linear convolution by using fast Fourier transform algorithms @@ -111,8 +109,6 @@ c[ 18] = 72.00 d[ 18] = 72.00 #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_fft(double* a, int na, double* b, int nb, - fft_t* pfft, double* c) \brief Линейная свертка двух вещественных векторов с использованием алгоритмов быстрого преобразования Фурье diff --git a/dspl/src/convolution/conv_fft_cmplx.c b/dspl/src/convolution/conv_fft_cmplx.c index 6975141..f47d977 100644 --- a/dspl/src/convolution/conv_fft_cmplx.c +++ b/dspl/src/convolution/conv_fft_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. @@ -26,8 +26,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_fft_cmplx(complex_t* a, int na, complex_t* b, int nb, - fft_t* pfft, int nfft, complex_t* c) \brief Complex vectors fast linear convolution by using fast Fourier transform algorithms @@ -104,8 +102,6 @@ c[ 18] = -37.00 +484.00j d[ 18] = -37.00 +484.00j #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int conv_fft_cmplx(complex_t* a, int na, complex_t* b, int nb, - fft_t* pfft, complex_t* c) \brief Линейная свертка двух комплексных векторов с использованием алгоритмов быстрого преобразования Фурье diff --git a/dspl/src/convolution/filter_iir.c b/dspl/src/convolution/filter_iir.c index 1b152b8..d65509a 100644 --- a/dspl/src/convolution/filter_iir.c +++ b/dspl/src/convolution/filter_iir.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. @@ -26,7 +26,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int filter_iir(double* b, double* a, int ord, double* x, int n, double* y) \brief Real IIR filtration Function calculates real IIR filter output for real signal. The real filter @@ -99,7 +98,6 @@ GNUPLOT script for make plots is: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup FILTER_CONV_GROUP -\fn int filter_iir(double* b, double* a, int ord, double* x, int n, double* y) \brief Фильтрация вещественного сигнала вещественным БИХ-фильтром Функция рассчитывает выход фильтра заданного выражением diff --git a/dspl/src/dft/dft.c b/dspl/src/dft/dft.c index e793a6d..711bd97 100644 --- a/dspl/src/dft/dft.c +++ b/dspl/src/dft/dft.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 DFT_GROUP -\fn int dft(double* x, int n, complex_t* y) \brief Discrete Fourier transform of a real signal. The function calculates the \f$ n \f$ -point discrete Fourier transform @@ -96,7 +95,6 @@ fast Fourier transform algorithms. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int dft(double* x, int n, complex_t* y) \brief Дискретное преобразование Фурье вещественного сигнала. Функция рассчитывает \f$ n \f$-точечное дискретное преобразование Фурье diff --git a/dspl/src/dft/dft_cmplx.c b/dspl/src/dft/dft_cmplx.c index b062410..36874e3 100644 --- a/dspl/src/dft/dft_cmplx.c +++ b/dspl/src/dft/dft_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. @@ -28,7 +28,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int dft_cmplx(complex_t* x, int n, complex_t* y) \brief Discrete Fourier transform of a complex signal. The function calculates the \f$ n \f$ -point discrete Fourier transform @@ -96,7 +95,6 @@ use fast Fourier transform algorithms. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int dft_cmplx(complex_t* x, int n, complex_t* y) \brief Дискретное преобразование Фурье комплексного сигнала. Функция рассчитывает \f$ n \f$-точечное дискретное преобразование Фурье diff --git a/dspl/src/dft/fft.c b/dspl/src/dft/fft.c index b581400..4081826 100644 --- a/dspl/src/dft/fft.c +++ b/dspl/src/dft/fft.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 DFT_GROUP -\fn int fft(double* x, int n, fft_t* pfft, complex_t* y) \brief Fast Fourier transform for the real vector. Function calculated \f$ n \f$-points FFT for the real vector @@ -101,7 +100,6 @@ y[13] = -7.000 -30.669 #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fft(double* x, int n, fft_t* pfft, complex_t* y) \brief Быстрое преобразование Фурье вещественного сигнала Функция рассчитывает \f$ n \f$-точечное быстрое преобразование Фурье diff --git a/dspl/src/dft/fft_abs.c b/dspl/src/dft/fft_abs.c index c44d49f..110744a 100644 --- a/dspl/src/dft/fft_abs.c +++ b/dspl/src/dft/fft_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 libdspl-2.0. diff --git a/dspl/src/dft/fft_abs_cmplx.c b/dspl/src/dft/fft_abs_cmplx.c index 0705f10..cdf12af 100644 --- a/dspl/src/dft/fft_abs_cmplx.c +++ b/dspl/src/dft/fft_abs_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/dft/fft_cmplx.c b/dspl/src/dft/fft_cmplx.c index 6220233..0456003 100644 --- a/dspl/src/dft/fft_cmplx.c +++ b/dspl/src/dft/fft_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. @@ -29,7 +29,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fft_cmplx(complex_t* x, int n, fft_t* pfft, complex_t* y) \brief Fast Fourier transform for the complex vector. Function calculated \f$ n \f$-points FFT for the complex vector @@ -102,7 +101,6 @@ y[17] = -0.300 0.588 #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fft_cmplx(complex_t* x, int n, fft_t* pfft, complex_t* y) \brief Быстрое преобразование Фурье комплексного сигнала Функция рассчитывает \f$ n \f$-точечное быстрое преобразование Фурье diff --git a/dspl/src/dft/fft_create.c b/dspl/src/dft/fft_create.c index 40bb522..844279d 100644 --- a/dspl/src/dft/fft_create.c +++ b/dspl/src/dft/fft_create.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,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fft_create(fft_t* pfft, int n) \brief Function creates and fill `fft_t` structure. The function allocates memory and calculates twiddle factors @@ -97,7 +96,6 @@ The "magic number" 46340 because \f$\sqrt{2^{31}} = 46340.95\f$. \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fft_create(fft_t* pfft, int n) \brief Заполнение структуры `fft_t` для алгоритма БПФ Функция производит выделение памяти и рассчет векторов diff --git a/dspl/src/dft/fft_free.c b/dspl/src/dft/fft_free.c index 0ab9e22..4a3d354 100644 --- a/dspl/src/dft/fft_free.c +++ b/dspl/src/dft/fft_free.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,8 +32,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup DFT_GROUP -\fn void fft_free(fft_t *pfft) +\ingroup DFT_GROUP \brief Free `fft_t` structure. The function clears the intermediate data memory @@ -48,7 +47,6 @@ Pointer to the `fft_t` object. \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn void fft_free(fft_t *pfft) \brief Очистить структуру `fft_t` алгоритма БПФ Функция производит очищение памяти промежуточных данных diff --git a/dspl/src/dft/fft_krn.c b/dspl/src/dft/fft_krn.c index 9f5fd76..c0e91dd 100644 --- a/dspl/src/dft/fft_krn.c +++ b/dspl/src/dft/fft_krn.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/dft/fft_mag.c b/dspl/src/dft/fft_mag.c index 9648ee3..90d72f9 100644 --- a/dspl/src/dft/fft_mag.c +++ b/dspl/src/dft/fft_mag.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/dft/fft_mag_cmplx.c b/dspl/src/dft/fft_mag_cmplx.c index 25a9577..c9b26a1 100644 --- a/dspl/src/dft/fft_mag_cmplx.c +++ b/dspl/src/dft/fft_mag_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/dft/fft_shift.c b/dspl/src/dft/fft_shift.c index c853f2f..a58084e 100644 --- a/dspl/src/dft/fft_shift.c +++ b/dspl/src/dft/fft_shift.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,8 +31,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup DFT_GROUP -\fn int fft_shift(double* x, int n, double* y) +\ingroup DFT_GROUP \brief Perform a shift of the vector `x`, for use with the `fft` and `ifft` functions, in order @@ -61,8 +60,7 @@ Else \ref ERROR_CODE_GROUP "code error". #endif #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** -\ingroup DFT_GROUP -\fn int fft_shift(double* x, int n, double* y) +\ingroup DFT_GROUP \brief Перестановка спектральных отсчетов дискретного преобразования Фурье Функция производит diff --git a/dspl/src/dft/fft_shift_cmplx.c b/dspl/src/dft/fft_shift_cmplx.c index c5e9d03..6ed5c10 100644 --- a/dspl/src/dft/fft_shift_cmplx.c +++ b/dspl/src/dft/fft_shift_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/dft/fft_subkernel.c b/dspl/src/dft/fft_subkernel.c index b0a0888..6ffd9a4 100644 --- a/dspl/src/dft/fft_subkernel.c +++ b/dspl/src/dft/fft_subkernel.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/dft/fourier_integral_cmplx.c b/dspl/src/dft/fourier_integral_cmplx.c index 3143d97..1e1fcba 100644 --- a/dspl/src/dft/fourier_integral_cmplx.c +++ b/dspl/src/dft/fourier_integral_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/dft/fourier_series_dec.c b/dspl/src/dft/fourier_series_dec.c index 2f21246..ed1694e 100644 --- a/dspl/src/dft/fourier_series_dec.c +++ b/dspl/src/dft/fourier_series_dec.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,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fourier_series_dec(double* t, double* s, int nt, double period, - int nw, double* w, complex_t* y) - \brief Fourier series coefficient calculation for periodic signal @@ -87,9 +84,6 @@ it is more expedient to use fast Fourier transform algorithms. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fourier_series_dec(double* t, double* s, int nt, double period, - int nw, double* w, complex_t* y) - \brief Расчет коэффициентов разложения в ряд Фурье diff --git a/dspl/src/dft/fourier_series_dec_cmplx.c b/dspl/src/dft/fourier_series_dec_cmplx.c index bc69aa6..62d40d7 100644 --- a/dspl/src/dft/fourier_series_dec_cmplx.c +++ b/dspl/src/dft/fourier_series_dec_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/dft/fourier_series_rec.c b/dspl/src/dft/fourier_series_rec.c index 8a75c4f..23cb5bd 100644 --- a/dspl/src/dft/fourier_series_rec.c +++ b/dspl/src/dft/fourier_series_rec.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. @@ -36,9 +36,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup DFT_GROUP -\fn int fourier_series_rec(double* w, complex_t* s, int nw, - double* t, int nt, complex_t* y) +\ingroup DFT_GROUP \brief Time signal reconstruction from Fourier series coefficients. Function reconstructs the time signal: @@ -96,8 +94,6 @@ can be ignored. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int fourier_series_rec(double* w, complex_t* s, int nw, - double* t, int nt, complex_t* y) \brief Восстановление сигнала при усечении ряда Фурье Функция рассчитывает восстановленный сигнал при усечении ряда Фурье: diff --git a/dspl/src/dft/goertzel.c b/dspl/src/dft/goertzel.c index 37daf52..f5e6085 100644 --- a/dspl/src/dft/goertzel.c +++ b/dspl/src/dft/goertzel.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. @@ -26,7 +26,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int goertzel(double *x, int n, int *ind, int k, complex_t *y) \brief Goertzel algorithm individual DFT samples calculation for the real input vector `x`. @@ -75,7 +74,6 @@ with indices modulo `n`. \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int goertzel(double *x, int n, int *ind, int k, complex_t *y) \brief Алгоритм Гёрцеля для расчета отдельных спектральных отсчетов дискретного преобразования Фурье вещественного сигнала `x`. diff --git a/dspl/src/dft/goertzel_cmplx.c b/dspl/src/dft/goertzel_cmplx.c index 8de5563..25eff09 100644 --- a/dspl/src/dft/goertzel_cmplx.c +++ b/dspl/src/dft/goertzel_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. @@ -27,7 +27,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int goertzel_cmplx(complex_t *x, int n, int *ind, int k, complex_t *y) \brief Goertzel algorithm individual DFT samples calculation for the complex input vector `x`. @@ -77,7 +76,6 @@ with indices modulo `n`. \n #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int goertzel_cmplx(complex_t *x, int n, int *ind, int k, complex_t *y) \brief Алгоритм Гёрцеля для расчета отдельных спектральных отсчетов дискретного преобразования Фурье комплексного сигнала `x`. diff --git a/dspl/src/dft/idft_cmplx.c b/dspl/src/dft/idft_cmplx.c index 12d3a6d..0cdcfff 100644 --- a/dspl/src/dft/idft_cmplx.c +++ b/dspl/src/dft/idft_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. @@ -27,7 +27,6 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** \ingroup DFT_GROUP -\fn int idft_cmplx(complex_t* x, int n, complex_t* y) \brief Inverse discrete Fourier transform of the complex spectrum. The function calculates the \f$ n \f$ -point inverse discrete transform @@ -96,7 +95,6 @@ use fast Fourier transform algorithms. #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int idft_cmplx(complex_t* x, int n, complex_t* y) \brief Обратное дискретное преобразование Фурье комплексного спектра. Функция рассчитывает \f$ n \f$-точечное обратное дискретное преобразование diff --git a/dspl/src/dft/ifft_cmplx.c b/dspl/src/dft/ifft_cmplx.c index c197462..3b5d5ed 100644 --- a/dspl/src/dft/ifft_cmplx.c +++ b/dspl/src/dft/ifft_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. @@ -28,8 +28,7 @@ #ifdef DOXYGEN_ENGLISH /*! **************************************************************************** -\ingroup DFT_GROUP -\fn int ifft_cmplx(complex_t* x, int n, fft_t* pfft, complex_t* y) +\ingroup DFT_GROUP \brief Inverse fast Fourier transform Function calculates \f$ n \f$-point IFFT of complex data @@ -104,7 +103,6 @@ Result: #ifdef DOXYGEN_RUSSIAN /*! **************************************************************************** \ingroup DFT_GROUP -\fn int ifft_cmplx(complex_t* x, int n, fft_t* pfft, complex_t* y) \brief Обратное быстрое преобразование Фурье Функция рассчитывает \f$ n \f$-точечное обратное быстрое преобразование Фурье