From 81c13ef8721864cc880c2496c1878e60e31eef71 Mon Sep 17 00:00:00 2001
From: Sergey Bakhurin <Bahurin@mail.ru>
Date: Wed, 3 Jun 2020 23:15:12 +0300
Subject: [PATCH] added documentation for polyroots and ones

---
 dspl/doc/html/formula.repository |   4 ++
 dspl/dox/ru/dspl_load.dox        |   2 +-
 dspl/dox/ru/groups_define.dox    |   5 ++
 dspl/dox/ru/matrix.dox           | 100 +++++++++++++++++++++++++++++++
 4 files changed, 110 insertions(+), 1 deletion(-)

diff --git a/dspl/doc/html/formula.repository b/dspl/doc/html/formula.repository
index 45b2fc1..a5eabc4 100644
--- a/dspl/doc/html/formula.repository
+++ b/dspl/doc/html/formula.repository
@@ -143,3 +143,7 @@
 \form#142:$\sigma^2$
 \form#143:$\mu = 0$
 \form#144:$\sigma=1$
+\form#145:\[ P_N(x) = a_0 + a_1 x + a_2 x^2 + \ldots a_N x^N \]
+\form#146:$a_N$
+\form#147:\[ P_N(x) = a_0 + a_1 x + a_2 x^2 + a_3 x^3 + ... a_N x^N. \]
+\form#148:\[ P(x) = 2 + 2x + x^2 \]
diff --git a/dspl/dox/ru/dspl_load.dox b/dspl/dox/ru/dspl_load.dox
index 1e844de..5a547b0 100644
--- a/dspl/dox/ru/dspl_load.dox
+++ b/dspl/dox/ru/dspl_load.dox
@@ -76,7 +76,7 @@ www.dsplib.org
 После очистки библиотеки все функции станут недоступны.
 
 \param[in] handle
-Хэндл приленкованной ранее библиотеки DSPL-2.0. \n
+Хэндл прилинкованной ранее библиотеки DSPL-2.0. \n
 Данный указатель может быть `NULL`, в этом случае никакие действия не 
 производятся.
 
diff --git a/dspl/dox/ru/groups_define.dox b/dspl/dox/ru/groups_define.dox
index 9cc254c..a514cfd 100644
--- a/dspl/dox/ru/groups_define.dox
+++ b/dspl/dox/ru/groups_define.dox
@@ -52,6 +52,11 @@
 \defgroup SPEC_MATH_STAT_GROUP Функции математической статистики
 
 \defgroup SPEC_MATH_LINALG_GROUP Линейная алгебра и матричные операции
+В данном разделе описаны функции работы с матрицами и алгоритмы линейной
+алгебры. Вычислительными ядрами являются пакеты BLAS и LAPACK, функции которых
+вызываются через интерфейс DSPL-2.0. \n \n
+Матрицы - двумерные объекты, которые хранятся в линейной памяти по столбцам и
+передаются в функции в виде указателя на линейную область памяти. 
 
 
 \defgroup IN_OUT_GROUP Функции ввода--вывода данных
diff --git a/dspl/dox/ru/matrix.dox b/dspl/dox/ru/matrix.dox
index e69de29..d50fdca 100644
--- a/dspl/dox/ru/matrix.dox
+++ b/dspl/dox/ru/matrix.dox
@@ -0,0 +1,100 @@
+/*! ****************************************************************************
+\ingroup SPEC_MATH_LINALG_GROUP
+\fn int matrix_eig_cmplx(complex_t* a, int n, complex_t* v, int* info)
+
+\brief 
+Расчет собственных значений квадратной комплексной матрицы.
+
+Данная функция производит расчет `n` собственных значений квадратной матрицы 
+размером `n x n`. 
+ 
+
+\param[in]  a
+Указатель на комплексную матрицу размерности `n x n`. \n
+Матрица должна быть расположена в памяти по столбцам. \n
+\n
+
+\param[in]  n
+Размерность квадратной матрицы.\n
+
+\param[out]  v
+Указатель на вектор собственных значений матрицы. \n 
+Размер вектора `n x 1`. \n 
+Память должна быть выделена. \n
+\n
+
+\param[out]  info
+Указатель на код возврата функции `zgees` пакета LAPACK. \n
+В случае возникновения ошибки при расчете вектора собственных значений,
+пакет LAPACK возвращает код ошибки, который может быть прочитан по данному
+указателю.
+\n
+
+
+\return
+`RES_OK` --- функция выполнена успешно. \n
+В противном случае \ref ERROR_CODE_GROUP "код ошибки". \n
+При возникновении ошибки `ERROR_LAPACK` по адресу  
+`info` будет записан код ошибки пакета LAPACK. \n
+
+
+\include matrix_eig.c
+
+Данная программа рассчитывает собственные значения матрицы размерности `3 x 3`
+и выводит собственные значения на печать. \n
+
+Результат работы программы:
+\verbatim
+A = [ % size [3 x 3] type: complex
+1.00   +0.00i,     2.00   +0.00i,     3.00   +0.00i;
+1.00   +0.00i,     0.00   +0.00i,     0.00   +0.00i;
+0.00   +0.00i,     1.00   +0.00i,     0.00   +0.00i;];
+
+v = [ % size [3 x 1] type: complex
+ 2.374424 -0.000000i;    
+-0.687212 +0.889497i;
+-0.687212 -0.889497i;];
+\endverbatim
+
+\author
+Бахурин Сергей
+www.dsplib.org
+**************************************************************************** */
+
+
+
+
+
+/*! ****************************************************************************
+\ingroup SPEC_MATH_LINALG_GROUP
+\fn int matrix_eye(double* a, int n, int m)
+
+\brief 
+Генерирование единичной вещественой матрицы размерности `n x m`.
+
+Данная функция заполняет матрицу нулями 
+и записывает единицы на главной диагонали
+ 
+
+\param[in]  a
+Указатель на вещественную матрицу размерности `n x m`. \n
+Матрица должна быть расположена в памяти по столбцам. \n
+\n
+
+\param[in]  n
+Количество строк матрицы. \n
+\n
+
+\param[in]  m
+Количество столбцов матрицы. \n
+\n
+
+
+\return
+`RES_OK` --- функция выполнена успешно. \n
+В противном случае \ref ERROR_CODE_GROUP "код ошибки". \n
+
+\author
+Бахурин Сергей
+www.dsplib.org
+**************************************************************************** */