added and fixed documentation for PIMath #101

Merged
peri4 merged 3 commits from math-doc into master 2022-08-03 08:49:08 +03:00
Owner
  • added documentation for PIPoint, PILine;
  • fixed documentation for PIMathMatrix.
- added documentation for PIPoint, PILine; - fixed documentation for PIMathMatrix.
andrey added 1 commit 2022-08-01 09:24:09 +03:00
- added documentation for PIPoint, PILine;
- fixed documentation for PIMathMatrix.
andrey reviewed 2022-08-01 10:08:09 +03:00
andrey left a comment
Author
Owner

Нудно ещё немного поправить, а так в целом суупер

Нудно ещё немного поправить, а так в целом суупер
@@ -156,3 +178,3 @@
};
//! \~russian Перегруженный оператор для вывода координат.
Author
Owner

в \a PICout

в \a PICout
@@ -45,1 +44,4 @@
//! \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(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
//! of the C++ language are implemented
//! \~english
Author
Owner

~russian

\~russian
@@ -73,0 +79,4 @@
//! \~english
//! \brief Contructs \a PIMathMatrixT from C++11 initializer list.
//! \~russian
//! \brief Создает \a PIMathMatrixT и заполняет её списка инициализации C++11.
Author
Owner

добавить ссылку на C++11 initializer list как в PIVector

добавить ссылку на C++11 initializer list как в PIVector
@@ -138,0 +149,4 @@
//! \brief Set the selected column in matrix.
//! \details If you enter an index out of the border of the matrix there will be "undefined behavior".
//! \param index is the number of the selected column.
//! \param v is a vector of the type _CMCol that needs to fill the column.
Author
Owner

Поменяй типы на PIMathVectorT<Rows, Type> и PIMathVectorT<Cols, Type> вместо _CMCol и _CMRow

Поменяй типы на PIMathVectorT<Rows, Type> и PIMathVectorT<Cols, Type> вместо _CMCol и _CMRow
@@ -360,0 +428,4 @@
//! \param v is value factor.
//! \return the result of matrix multiplication.
//! \~russian
//! \brief Матричное произведение.
Author
Owner

Тут должно быть не матричое произведение, а умножение на константу

Тут должно быть не матричое произведение, а умножение на константу
@@ -372,0 +442,4 @@
//! \param v is value divider.
//! \return the result of matrix division.
//! \~russian
//! \brief Матричное деление.
Author
Owner

Тут должно быть не матричое деление, а деление на константу

Тут должно быть не матричое деление, а деление на константу
@@ -383,2 +455,2 @@
* @return matrix determinant
*/
//! \~english
//! \brief Calculate Determinant of the matrix.
Author
Owner

тут какой-то левый символ

тут какой-то левый символ
@@ -417,0 +500,4 @@
//! \brief Преобразование матрицы в верхнетреугольную.
//! \details Работает только с квадратными, ненулевыми и обратимыми матрицами.
//! \param ok это параметр, с помощью которого мы можем узнать, правильно ли сработал метод.
//! \return копия преобразованной верхнетреугольной матрицы.
Author
Owner

тут неправильно было, это не копия, а сама эта матрица меняется

тут неправильно было, это не копия, а сама эта матрица меняется
@@ -533,0 +630,4 @@
//! \~russian
//! \brief Операция поворота матрицы.
//! \details Работает только с матрицами 2x2.
//! \return повернутая матрица.
Author
Owner

эта функция должна возвращать _CMatrix &
И хорошо бы сделать функцию rotated которая вернет копию

эта функция должна возвращать _CMatrix & И хорошо бы сделать функцию rotated которая вернет копию
@@ -575,0 +675,4 @@
//! \brief Inline-оператор для вывода матрицы в консоль.
//! \param s типа \a PICout.
//! \param m типа \a PIMathMatrixT.
//! \return непечатанная в консоль \a PIMathMatrix.
Author
Owner

в \a PICout

в \a PICout
@@ -596,0 +698,4 @@
//! \return matrix that is the result of multiplication.
//! \~russian
//! \brief Умножение матриц друг на друга.
//! \details Если вы введете индекс вне границ матрицы, то поведение не определено ("undefined behavior").
Author
Owner

тут невозможно выйти за границы, это предложение тут лишнее

тут невозможно выйти за границы, это предложение тут лишнее
@@ -619,0 +726,4 @@
//! \return vector that is the result of multiplication
//! \~russian
//! \brief Умножения матрицы на вектор.
//! \details Если вы введете индекс вне границ матрицы, то поведение не определено ("undefined behavior").
Author
Owner

тут невозможно выйти за границы, это предложение тут лишнее

тут невозможно выйти за границы, это предложение тут лишнее
@@ -640,0 +752,4 @@
//! \return vector that is the result of multiplication
//! \~russian
//! \brief Умножения вектора на матрицу.
//! \details Если вы введете индекс вне границ матрицы, то поведение не определено ("undefined behavior").
Author
Owner

тут невозможно выйти за границы, это предложение тут лишнее

тут невозможно выйти за границы, это предложение тут лишнее
@@ -1154,0 +1360,4 @@
//! \brief Inline-оператор для вывода матрицы в консоль.
//! \param s типа \a PICout.
//! \param m типа \a PIMathMatrixT.
//! \return непечатанная в консоль \a PIMathMatrix.
Author
Owner

в \a PICout

в \a PICout
@@ -1175,0 +1384,4 @@
//! \brief Inline-оператор для сериализации матрицы в \a PIByteArray.
//! \param s типа \a PIByteArray.
//! \param v типа \a PIMathMatrix.
//! \return сериализованная в \a PIBiteArray матрица \a PIMathMatrix.
Author
Owner

Тут теперь будет PIBinaryStream вместо PIBiteArray

Тут теперь будет PIBinaryStream вместо PIBiteArray
@@ -1188,0 +1400,4 @@
//! \brief Inline-оператор для сериализации матрицы в \a PIByteArray.
//! \param s типа \a PIByteArray.
//! \param v типа \a PIMathMatrix.
//! \return десериализованная из \a PIBiteArray матрица \a PIMathMatrix.
Author
Owner

Тут теперь будет PIBinaryStream вместо PIBiteArray

Тут теперь будет PIBinaryStream вместо PIBiteArray
@@ -115,3 +124,3 @@
static PIPoint<Type> fromPolar(const PIPoint<Type> & p) {return PIPoint<Type>(p.y * cos(p.x), p.y * sin(p.x));}
//!
//! \~russian Прибавить координаты второй точки и сохранить.
Author
Owner

тут лучше написать что копия метода translate

тут лучше написать что копия метода translate
@@ -140,3 +149,3 @@
};
//! \~russian Перегруженный оператор для вывода координат.
Author
Owner

в \a PICout

в \a PICout
tambaru added 1 commit 2022-08-01 12:30:27 +03:00
peri4 added 1 commit 2022-08-03 08:47:28 +03:00
peri4 merged commit e6aa3c34d4 into master 2022-08-03 08:49:08 +03:00
Sign in to join this conversation.