doc clean

This commit is contained in:
2022-08-03 08:47:25 +03:00
parent d6758a8562
commit bb40f69298

View File

@@ -476,11 +476,11 @@ public:
//! \~english
//! \brief Calculate the trace of a matrix.
//! \details Works only with square matrix, nonzero matrices and invertible matrix.
//! \details Works only with square matrix.
//! \return matrix trace.
//! \~russian
//! \brief Вычислить след матрицы.
//! \details Работает только с квадратными, ненулевыми и обратимыми матрицами.
//! \details Работает только с квадратными матрицами.
//! \return след матрицы.
Type trace() const {
static_assert(Rows == Cols, "Works only with square matrix");
@@ -611,11 +611,11 @@ public:
//! \~english
//! \brief Matrix transposition operation.
//! \details Works only with square matrix, nonzero matrices and invertible matrix.
//! \details Works only with square matrix.
//! \return copy of transposed matrix
//! \~russian
//! \brief Транспонирование матрицы.
//! \details Работает только с квадратными, ненулевыми и обратимыми матрицами.
//! \details Работает только с квадратными матрицами.
//! \return копия транспонированной матрицы.
PIMathMatrixT<Cols, Rows, Type> transposed() const {
PIMathMatrixT<Cols, Rows, Type> tm;
@@ -1208,11 +1208,11 @@ public:
//! \~english
//! \brief Calculate the trace of a matrix.
//! \details Works only with square matrix, nonzero matrices and invertible matrix.
//! \details Works only with square matrix matrix.
//! \return matrix trace.
//! \~russian
//! \brief Вычислить след матрицы.
//! \details Работает только с квадратными, ненулевыми и обратимыми матрицами.
//! \details Работает только с квадратными матрицами.
//! \return след матрицы.
Type trace() const {
assert(isSquare());
@@ -1346,12 +1346,12 @@ public:
}
//! \~english
//! \brief Matrix transposition operation.
//! \details Works only with square matrix, nonzero matrices and invertible matrix.
//! \brief Matrix transposition operation.
//! \details Works only with square matrix matrix.
//! \return copy of transposed matrix
//! \~russian
//! \brief Транспонирование матрицы.
//! \details Работает только с квадратными, ненулевыми и обратимыми матрицами.
//! \details Работает только с квадратными матрицами.
//! \return копия транспонированной матрицы.
PIMathMatrix<Type> transposed() const {
PIMathMatrix<Type> tm(_V2D::rows_, _V2D::cols_);
@@ -1394,12 +1394,10 @@ inline PICout operator<<(PICout s, const PIMathMatrix<Type> &m) {
//! \brief Inline operator for serializing a matrix into a \a PIBinaryStream.
//! \param s \a PIBinaryStream type.
//! \param v \a PIMathMatrix type.
//! \return \a PIBinaryStream serialized \a PIMathMatrix.
//! \~russian
//! \brief Inline-оператор для сериализации матрицы в \a PIBinaryStream.
//! \param s типа \a PIBinaryStream.
//! \param v типа \a PIMathMatrix.
//! \return сериализованная в \a PIBinaryStream матрица \a PIMathMatrix.
template <typename P, typename T>
inline PIBinaryStream<P> & operator <<(PIBinaryStream<P> & s, const PIMathMatrix<T> & v) {
s << (const PIVector2D<T> &) v;
@@ -1410,12 +1408,10 @@ inline PIBinaryStream<P> & operator <<(PIBinaryStream<P> & s, const PIMathMatrix
//! \brief Inline operator to deserialize matrix from \a PIByteArray.
//! \param s \a PIBinaryStream type.
//! \param v \a PIMathMatrix type.
//! \return \a PIMathMatrix deserialized from \a PIBinaryStream .
//! \~russian
//! \brief Inline-оператор для сериализации матрицы в \a PIByteArray.
//! \param s типа \a PIBinaryStream.
//! \param v типа \a PIMathMatrix.
//! \return десериализованная из \a PIBinaryStream матрица \a PIMathMatrix.
template <typename P, typename T>
inline PIBinaryStream<P> & operator >>(PIBinaryStream<P> & s, PIMathMatrix<T> & v) {
s >> (PIVector2D<T> &) v;
@@ -1532,7 +1528,6 @@ typedef PIMathMatrix<double> PIMathMatrixd;
//! \brief Поиск эрмитовой матрицы.
//! \param m сопряженная транспонированная матрица.
//! \return результат преобразования.
template<typename T>
PIMathMatrix<complex<T> > hermitian(const PIMathMatrix<complex<T> > &m) {
PIMathMatrix<complex<T> > ret(m);