SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

doc groups

Browse Source
This commit is contained in:
Пелипенко Иван
2022-04-06 20:11:47 +03:00
parent c90d06871e
commit d5c27b1181
93 changed files with 1080 additions and 324 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
libs/main/math/picrc.h
View File

@@ -1,6 +1,9 @@
/*! \file picrc.h
* \brief CRC checksum calculator
*/
* \ingroup Math
* \~\brief
* \~english CRC checksum calculation
* \~russian Вычисление CRC контрольной суммы
*/
/*
PIP - Platform Independent Primitives
CRC checksum calculator

7
libs/main/math/pievaluator.h
View File

@@ -1,6 +1,9 @@
/*! \file pievaluator.h
* \brief Mathematic expressions calculator
*/
* \ingroup Math
* \~\brief
* \~english Mathematic expressions calculator
* \~russian Вычислитель математических выражений
*/
/*
PIP - Platform Independent Primitives
Evaluator designed for stream calculations

39
libs/main/math/pifft.h
View File

@@ -1,6 +1,10 @@
/*! \file pifft.h
* \brief Class for FFT, IFFT and Hilbert transformations
*/
* \ingroup Math
* \ingroup FFTW
* \~\brief
* \~english FFT, IFFT and Hilbert transformations
* \~russian БПФ, ОБПФ и преобразования Гильберта
*/
/*
PIP - Platform Independent Primitives
Class for FFT, IFFT and Hilbert transformations
@@ -19,6 +23,37 @@
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
//! \defgroup FFTW
//! \~\brief
//! \~english Optimized FFT support via libfftw3
//! \~russian Оптимизированный БПФ с помощью libfftw3
//!
//! \~\details
//! \~english \section cmake_module Building with CMake
//! \~russian \section cmake_module Сборка с использованием CMake
//!
//! \code
//! find_package(PIP REQUIRED)
//! target_link_libraries([target] PIP::FFTW)
//! \endcode
//!
//! \~english \par Common
//! \~russian \par Общее
//!
//! \~english
//! These files provides FFT using [libfftw3](https://fftw.org/)
//!
//! \~russian
//! Эти файлы обеспечивают БПФ с использованием [libfftw3](https://fftw.org/)
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!
#ifndef PIFFT_H
#define PIFFT_H

7
libs/main/math/piline.h
View File

@@ -3,13 +3,6 @@
* \brief
* \~english Two-dimensional line class
* \~russian Класс отрезка двумерной линии
* * \~\authors
* \~english
* Ivan Pelipenko peri4ko@yandex.ru;
* Andrey Bychkov work.a.b@yandex.ru;
* \~russian
* Иван Пелипенко peri4ko@yandex.ru;
* Андрей Бычков work.a.b@yandex.ru;
*/
/*
PIP - Platform Independent Primitives

11
libs/main/math/pimathbase.h
View File

@@ -1,15 +1,8 @@
/*! \file pimathbase.h
* \defgroup Math
* \brief
* \ingroup Math
* \~\brief
* \~english Basic mathematical functions and defines
* \~russian Базовые математические функции и дефайны
* \~\authors
* \~english
* Ivan Pelipenko peri4ko@yandex.ru;
* Andrey Bychkov work.a.b@yandex.ru;
* \~russian
* Иван Пелипенко peri4ko@yandex.ru;
* Андрей Бычков work.a.b@yandex.ru;
*/
/*
PIP - Platform Independent Primitives

7
libs/main/math/pimathcomplex.h
View File

@@ -1,6 +1,9 @@
/*! \file pimathcomplex.h
* \brief PIP math complex
*/
* \ingroup Math
* \~\brief
* \~english Complex numbers
* \~russian Комплексные числа
*/
/*
PIP - Platform Independent Primitives
PIP math complex

9
libs/main/math/pimathmatrix.h
View File

@@ -1,8 +1,9 @@
/*! \file pimathmatrix.h
* \brief PIMathMatrix
*
* This file declare math matrix class, which performs various matrix operations
*/
* \ingroup Math
* \~\brief
* \~english Math matrix
* \~russian Математическая матрица
*/
/*
PIP - Platform Independent Primitives
PIMathMatrix

31
libs/main/math/pimathmodule.h
View File

@@ -16,6 +16,37 @@
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
//! \defgroup Math
//! \~\brief
//! \~english Basic mathematical functions and defines
//! \~russian Базовые математические функции и дефайны
//!
//! \~\details
//! \~english \section cmake_module Building with CMake
//! \~russian \section cmake_module Сборка с использованием CMake
//!
//! \code
//! find_package(PIP REQUIRED)
//! target_link_libraries([target] PIP)
//! \endcode
//!
//! \~english \par Common
//! \~russian \par Общее
//!
//! \~english
//! These files provides vectors, matrices, complex numbers, quaternions, FFT and geometry classes
//!
//! \~russian
//! Эти файлы обеспечивают вектора, матрицы, комплексные числа, кватернионы, БПФ и классы геометрических фигур
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!
#ifndef PIMATHMODULE_H
#define PIMATHMODULE_H

7
libs/main/math/pimathvector.h
View File

@@ -1,6 +1,9 @@
/*! \file pimathvector.h
* \brief PIMathVector
*/
* \ingroup Math
* \~\brief
* \~english Math vector
* \~russian Математический вектор
*/
/*
PIP - Platform Independent Primitives
PIMathVector

7
libs/main/math/pipoint.h
View File

@@ -3,13 +3,6 @@
//! \brief
//! \~english Two-dimensional point class
//! \~russian Класс двумерной точки
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
/*
PIP - Platform Independent Primitives
Two-dimensional point class

7
libs/main/math/piquaternion.h
View File

@@ -1,6 +1,9 @@
/*! \file piquaternion.h
* \brief Class for quaternions
*/
* \ingroup Math
* \~\brief
* \~english Quaternion
* \~russian Кватернион
*/
/*
PIP - Platform Independent Primitives
Class for quaternions

7
libs/main/math/pirect.h
View File

@@ -3,13 +3,6 @@
//! \brief
//! \~english Rect class
//! \~russian Класс прямоугольника
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
/*
PIP - Platform Independent Primitives
Rect class

7
libs/main/math/pistatistic.h
View File

@@ -1,6 +1,9 @@
/*! \file pistatistic.h
* \brief Class for calculating math statistic in values array
*/
* \ingroup Math
* \~\brief
* \~english Calculating math statistic of values array
* \~russian Вычисление математической статистики у массива чисел
*/
/*
PIP - Platform Independent Primitives
Class for calculacing math statistic in values array