added documentation for error codes

pull/6/merge
Sergey Bakhurin 2020-05-15 23:28:08 +03:00
rodzic 2bdad6b6a8
commit 299c6215d6
2 zmienionych plików z 106 dodań i 0 usunięć

Wyświetl plik

@ -139,3 +139,7 @@
\form#138:$\sigma^2$
\form#139:$\mu = 0$
\form#140:$\sigma=1$
\form#141:$\frac{P}{Q}$
\form#142:$P$
\form#143:$Q$
\form#144:$1/F_{\textrm{s}}$

Wyświetl plik

@ -235,6 +235,26 @@
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_NEGATIVE
\brief Отрицательный параметр.
Функция возвращает данный код ошибки, когда принимает отрицательный параметр
в переменную, которая не может быть отрицательной.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_POLY_ORD
\brief Неверно задан порядок полинома.
Порядок полинома должен быть положительным целым числом.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_PTR
@ -247,6 +267,47 @@
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_RAND_SIGMA
\brief Неверно задано среднеквадратическое отклонение
нормального распределения случайной величины.
Среднеквадратическое отклонение должно быть
неотрицательным вещественным числом.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_RAND_TYPE
\brief Неизвестный датчик псевдослучайных чисел.
В библиотеке используются следующие датчики:
\li MRG32K3A -- 32 битный датчик MRG32K3A разработан Пьером Лекуэром.
\li MT19937-64 -- 64-битный датчик Вихрь Мерсенна.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_RESAMPLE_RATIO
\brief Коэффициент передискретизации задан неверно.
Коэффициент передискретизации задается отношением \f$\frac{P}{Q}\f$, где
\f$P\f$ и \f$Q\f$ вещественные положительные числа.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_RESAMPLE_FRAC_DELAY
\brief Неверное значение дробной задержки.
Дробная задержка может принимать значения от -1 до 1, где 1 соответствует
одному интервалу дискретизации \f$1/F_{\textrm{s}}\f$.
*/
/*!
\ingroup ERROR_CODE_GROUP
@ -258,3 +319,44 @@
При возникновении данной ошибки,
функция завершает работу и возвращает данный код ошибки.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_SYM_TYPE
\brief Ошибка параметра типа заполнения массивов в линейном или логарифмическом
масштабе. Допустимые типы заполнения: симметричный и периодический.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_UNWRAP
\brief Ошибка параметров функции раскрытия периодичности.
Параметр периода и отступа должны быть положительными числами.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_WIN_PARAM
\brief Ошибка значения параметра оконной функции.
Для каждой параметрической оконной функции существуют допустимые значения
параметра.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_WIN_SYM
\brief Симметричность или периодичность заданного окна не поддерживается.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_WIN_TYPE
\brief Неизвестный тип оконной функции.
*/