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

rename doc macros

Browse Source
This commit is contained in:
Бычков Андрей
2021-08-04 16:31:32 +03:00
parent 0c7ce272e6
commit 25def958a1
140 changed files with 963 additions and 983 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*! \file pimathmatrix.h
* \brief PIMathMatrix
/*! @file pimathmatrix.h
* @brief PIMathMatrix
*
* This file declare math matrix class, which performs various matrix operations
*/
@@ -37,7 +37,7 @@
#pragma pack(push, 1)
//! \brief A class that works with square matrix operations, the input data of which are columns, rows and the data type of the matrix
//! @brief A class that works with square matrix operations, the input data of which are columns, rows and the data type of the matrix
//! @tparam Rows rows number of matrix
//! @tparam Сols columns number of matrix
//! @tparam Type is the data type of the matrix. There are can be basic C++ language data and different classes where the arithmetic operators(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
@@ -156,8 +156,8 @@ public:
* @brief Method which changes selected rows in a matrix.
* If you enter an index out of the border of the matrix there will be "undefined behavior"
*
* @param r0 is the number of the first selected row
* @param r1 is the number of the second selected row
* @param rf is the number of the first selected row
* @param rs is the number of the second selected row
* @return matrix type _CMatrix
*/
_CMatrix &swapRows(uint rf, uint rs) {
@@ -169,8 +169,8 @@ public:
* @brief Method which changes selected columns in a matrix.
* If you enter an index out of the border of the matrix there will be "undefined behavior"
*
* @param c0 is the number of the first selected column
* @param c1 is the number of the second selected column
* @param cf is the number of the first selected column
* @param cs is the number of the second selected column
* @return matrix type _CMatrix
*/
_CMatrix &swapCols(uint cf, uint cs) {
@@ -524,6 +524,11 @@ public:
return tm;
}
/**
* @brief Matrix rotation operation. Works only with 2x2 matrix
*
* @return rotated matrix
*/
_CMatrix rotate(Type angle) {
static_assert(Rows == 2 && Cols == 2, "Works only with 2x2 matrix");
Type c = std::cos(angle);
@@ -684,7 +689,7 @@ class PIMathMatrix;
#define PIMM_FOR_C for (uint i = 0; i < _V2D::cols_; ++i)
#define PIMM_FOR_R for (uint i = 0; i < _V2D::rows_; ++i)
//! \brief A class that works with matrix operations, the input data of which is the data type of the matrix
//! @brief A class that works with matrix operations, the input data of which is the data type of the matrix
//! @tparam There are can be basic C++ language data and different classes where the arithmetic operators(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
//! of the C++ language are implemented
template<typename Type>
@@ -1258,7 +1263,7 @@ inline PIMathVector<Type> operator*(const PIMathVector<Type> &sv,
* @brief Multiplying value of type Type and matrix
*
* @param x first multiplier of type Type
* @param fm second matrix multiplier
* @param v second matrix multiplier
* @return matrix that is the result of multiplication
*/
template<typename Type>