doxygen @ tags replaced to \
This commit is contained in:
@@ -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(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
|
||||
@@ -53,12 +53,12 @@ class PIP_EXPORT PIMathMatrixT {
|
||||
static_assert(Cols > 0, "Column count must be > 0");
|
||||
public:
|
||||
/**
|
||||
* @brief Constructs PIMathMatrixT that is filled by \a new_value
|
||||
* \brief Constructs PIMathMatrixT that is filled by \a new_value
|
||||
*/
|
||||
PIMathMatrixT(const Type &new_value = Type()) {PIMM_FOR m[r][c] = new_value;}
|
||||
|
||||
/**
|
||||
* @brief Contructs PIMathMatrixT from PIVector
|
||||
* \brief Contructs PIMathMatrixT from PIVector
|
||||
*/
|
||||
PIMathMatrixT(const PIVector<Type> &val) {
|
||||
assert(Rows*Cols == val.size());
|
||||
@@ -67,7 +67,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Contructs PIMathMatrixT from C++11 initializer list
|
||||
* \brief Contructs PIMathMatrixT from C++11 initializer list
|
||||
*/
|
||||
PIMathMatrixT(std::initializer_list<Type> init_list) {
|
||||
assert(Rows*Cols == init_list.size());
|
||||
@@ -76,7 +76,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Сreates a matrix whose main diagonal is filled with ones and the remaining elements are zeros
|
||||
* \brief Сreates a matrix whose main diagonal is filled with ones and the remaining elements are zeros
|
||||
*
|
||||
* @return identity matrix of type PIMathMatrixT
|
||||
*/
|
||||
@@ -87,21 +87,21 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which returns number of columns in matrix
|
||||
* \brief Method which returns number of columns in matrix
|
||||
*
|
||||
* @return type uint shows number of columns
|
||||
*/
|
||||
constexpr uint cols() const {return Cols;}
|
||||
|
||||
/**
|
||||
* @brief Method which returns number of rows in matrix
|
||||
* \brief Method which returns number of rows in matrix
|
||||
*
|
||||
* @return type uint shows number of rows
|
||||
*/
|
||||
constexpr uint rows() const {return Rows;}
|
||||
|
||||
/**
|
||||
* @brief Method which returns the selected column in PIMathVectorT format.
|
||||
* \brief Method which returns the selected column in PIMathVectorT format.
|
||||
* 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
|
||||
@@ -114,7 +114,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which returns the selected row in PIMathVectorT format
|
||||
* \brief Method which returns the selected row in PIMathVectorT format
|
||||
* 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 row
|
||||
@@ -127,7 +127,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set the selected column in matrix.
|
||||
* \brief Set the selected column in matrix.
|
||||
* 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
|
||||
@@ -140,7 +140,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set the selected row in matrix
|
||||
* \brief Set the selected row in matrix
|
||||
* 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 row
|
||||
@@ -153,7 +153,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which changes selected rows in a matrix.
|
||||
* \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 rf is the number of the first selected row
|
||||
@@ -166,7 +166,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which changes selected columns in a matrix.
|
||||
* \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 cf is the number of the first selected column
|
||||
@@ -179,7 +179,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which fills the matrix with selected value
|
||||
* \brief Method which fills the matrix with selected value
|
||||
*
|
||||
* @param v is a parameter the type and value of which is selected and later filled into the matrix
|
||||
* @return filled matrix type _CMatrix
|
||||
@@ -190,14 +190,14 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which checks if matrix is square
|
||||
* \brief Method which checks if matrix is square
|
||||
*
|
||||
* @return true if matrix is square, else false
|
||||
*/
|
||||
constexpr bool isSquare() const { return Rows == Cols; }
|
||||
|
||||
/**
|
||||
* @brief Method which checks if main diagonal of matrix consists of ones and another elements are zeros
|
||||
* \brief Method which checks if main diagonal of matrix consists of ones and another elements are zeros
|
||||
*
|
||||
* @return true if matrix is identitied, else false
|
||||
*/
|
||||
@@ -207,7 +207,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which checks if every elements of matrix are zeros
|
||||
* \brief Method which checks if every elements of matrix are zeros
|
||||
*
|
||||
* @return true if matrix is null, else false
|
||||
*/
|
||||
@@ -218,7 +218,7 @@ public:
|
||||
|
||||
|
||||
/**
|
||||
* @brief Read-only access to element by \a row and \a col.
|
||||
* \brief Read-only access to element by \a row and \a col.
|
||||
* If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param row of matrix
|
||||
@@ -228,7 +228,7 @@ public:
|
||||
Type at(uint row, uint col) const { return m[row][col]; }
|
||||
|
||||
/**
|
||||
* @brief Full access to element by \a row and \a col.
|
||||
* \brief Full access to element by \a row and \a col.
|
||||
* If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param row of matrix
|
||||
@@ -238,7 +238,7 @@ public:
|
||||
inline Type & element(uint row, uint col) {return m[row][col];}
|
||||
|
||||
/**
|
||||
* @brief Read-only access to element by \a row and \a col.
|
||||
* \brief Read-only access to element by \a row and \a col.
|
||||
* If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param row of matrix
|
||||
@@ -248,7 +248,7 @@ public:
|
||||
inline const Type & element(uint row, uint col) const {return m[row][col];}
|
||||
|
||||
/**
|
||||
* @brief Full access to the matrix row pointer. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Full access to the matrix row pointer. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param row of matrix
|
||||
* @return matrix row pointer
|
||||
@@ -256,7 +256,7 @@ public:
|
||||
Type *operator[](uint row) { return m[row]; }
|
||||
|
||||
/**
|
||||
* @brief Read-only access to the matrix row pointer. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Read-only access to the matrix row pointer. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param row of matrix
|
||||
* @return matrix row pointer
|
||||
@@ -264,7 +264,7 @@ public:
|
||||
const Type *operator[](uint row) const {return m[row];}
|
||||
|
||||
/**
|
||||
* @brief Matrix compare
|
||||
* \brief Matrix compare
|
||||
*
|
||||
* @param sm matrix for compare
|
||||
* @return if matrices are equal true, else false
|
||||
@@ -275,7 +275,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix negative compare
|
||||
* \brief Matrix negative compare
|
||||
*
|
||||
* @param sm matrix for compare
|
||||
* @return if matrices are not equal true, else false
|
||||
@@ -283,21 +283,21 @@ public:
|
||||
bool operator!=(const _CMatrix &sm) const { return !(*this == sm); }
|
||||
|
||||
/**
|
||||
* @brief Addition assignment with matrix "sm"
|
||||
* \brief Addition assignment with matrix "sm"
|
||||
*
|
||||
* @param sm matrix for the addition assigment
|
||||
*/
|
||||
void operator+=(const _CMatrix &sm) {PIMM_FOR m[r][c] += sm.m[r][c];}
|
||||
|
||||
/**
|
||||
* @brief Subtraction assignment with matrix "sm"
|
||||
* \brief Subtraction assignment with matrix "sm"
|
||||
*
|
||||
* @param sm matrix for the subtraction assigment
|
||||
*/
|
||||
void operator-=(const _CMatrix &sm) {PIMM_FOR m[r][c] -= sm.m[r][c];}
|
||||
|
||||
/**
|
||||
* @brief Multiplication assignment with value "v"
|
||||
* \brief Multiplication assignment with value "v"
|
||||
*
|
||||
* @param v value for the multiplication assigment
|
||||
*/
|
||||
@@ -306,7 +306,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Division assignment with value "v"
|
||||
* \brief Division assignment with value "v"
|
||||
*
|
||||
* @param v value for the division assigment
|
||||
*/
|
||||
@@ -316,7 +316,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix substraction
|
||||
* \brief Matrix substraction
|
||||
*
|
||||
* @return the result of matrix substraction
|
||||
*/
|
||||
@@ -327,7 +327,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix addition
|
||||
* \brief Matrix addition
|
||||
*
|
||||
* @param sm is matrix term
|
||||
* @return the result of matrix addition
|
||||
@@ -339,7 +339,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix substraction
|
||||
* \brief Matrix substraction
|
||||
*
|
||||
* @param sm is matrix subtractor
|
||||
* @return the result of matrix substraction
|
||||
@@ -351,7 +351,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix multiplication
|
||||
* \brief Matrix multiplication
|
||||
*
|
||||
* @param v is value factor
|
||||
* @return the result of matrix multiplication
|
||||
@@ -363,7 +363,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix division
|
||||
* \brief Matrix division
|
||||
*
|
||||
* @param v is value divider
|
||||
* @return the result of matrix division
|
||||
@@ -376,7 +376,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Determinant of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Determinant of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return matrix determinant
|
||||
@@ -394,7 +394,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Trace of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Trace of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @return matrix trace
|
||||
*/
|
||||
@@ -408,7 +408,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Transforming matrix to upper triangular. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Transforming matrix to upper triangular. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return copy of transformed upper triangular matrix
|
||||
@@ -448,7 +448,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return copy of inverted matrix
|
||||
@@ -502,7 +502,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return inverted matrix
|
||||
@@ -514,7 +514,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix transposition operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Matrix transposition operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @return transposed matrix
|
||||
*/
|
||||
@@ -525,7 +525,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix rotation operation. Works only with 2x2 matrix
|
||||
* \brief Matrix rotation operation. Works only with 2x2 matrix
|
||||
*
|
||||
* @return rotated matrix
|
||||
*/
|
||||
@@ -565,7 +565,7 @@ inline std::ostream & operator <<(std::ostream & s, const PIMathMatrixT<Rows, Co
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Add matrix "m" at the end of matrix and return reference to matrix
|
||||
* \brief Add matrix "m" at the end of matrix and return reference to matrix
|
||||
*
|
||||
* @param s PICout type
|
||||
* @param m PIMathMatrixT type
|
||||
@@ -586,7 +586,7 @@ inline PICout operator<<(PICout s, const PIMathMatrixT<Rows, Cols, Type> &m) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying matrices by each other. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying matrices by each other. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param fm first matrix multiplier
|
||||
* @param sm second matrix multiplier
|
||||
@@ -609,7 +609,7 @@ inline PIMathMatrixT<Rows0, Cols1, Type> operator*(const PIMathMatrixT<Rows0, CR
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying matrix and vector. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying matrix and vector. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param fm first matrix multiplier
|
||||
* @param sv second vector multiplier
|
||||
@@ -630,7 +630,7 @@ inline PIMathVectorT<Rows, Type> operator*(const PIMathMatrixT<Rows, Cols, Type>
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying vector and matrix. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying vector and matrix. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param sv first vector multiplier
|
||||
* @param fm second matrix multiplier
|
||||
@@ -651,7 +651,7 @@ inline PIMathVectorT<Cols, Type> operator*(const PIMathVectorT<Rows, Type> &sv,
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying value of type Type and matrix
|
||||
* \brief Multiplying value of type Type and matrix
|
||||
*
|
||||
* @param x first multiplier of type Type
|
||||
* @param fm second matrix multiplier
|
||||
@@ -689,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>
|
||||
@@ -698,7 +698,7 @@ class PIP_EXPORT PIMathMatrix : public PIVector2D<Type> {
|
||||
typedef PIMathMatrix<Type> _CMatrix;
|
||||
public:
|
||||
/**
|
||||
* @brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
* \brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
*
|
||||
* @param cols is number of matrix column uint type
|
||||
* @param rows is number of matrix row uint type
|
||||
@@ -707,7 +707,7 @@ public:
|
||||
PIMathMatrix(const uint cols = 0, const uint rows = 0, const Type &f = Type()) { _V2D::resize(rows, cols, f); }
|
||||
|
||||
/**
|
||||
* @brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
* \brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
*
|
||||
* @param cols is number of matrix column uint type
|
||||
* @param rows is number of matrix row uint type
|
||||
@@ -720,7 +720,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
* \brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
*
|
||||
* @param val is PIVector<Type> of PIVector, which creates matrix
|
||||
*/
|
||||
@@ -736,7 +736,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
* \brief Constructor of class PIMathMatrix, which creates a matrix
|
||||
*
|
||||
* @param val is PIVector2D<Type>, which creates matrix
|
||||
*/
|
||||
@@ -748,7 +748,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Creates a matrix whose main diagonal is filled with ones and the remaining elements are zeros
|
||||
* \brief Creates a matrix whose main diagonal is filled with ones and the remaining elements are zeros
|
||||
*
|
||||
* @param cols is number of matrix column uint type
|
||||
* @param rows is number of matrix row uint type
|
||||
@@ -761,7 +761,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Creates a row matrix of every element that is equal to every element of the vector
|
||||
* \brief Creates a row matrix of every element that is equal to every element of the vector
|
||||
*
|
||||
* @param val is the vector type PIMathVector
|
||||
* @return row matrix of every element that is equal to every element of the vector
|
||||
@@ -769,7 +769,7 @@ public:
|
||||
static _CMatrix matrixRow(const PIMathVector<Type> &val) {return _CMatrix(val.size(), 1, val.toVector());}
|
||||
|
||||
/**
|
||||
* @brief Creates a column matrix of every element that is equal to every element of the vector
|
||||
* \brief Creates a column matrix of every element that is equal to every element of the vector
|
||||
*
|
||||
* @param val is the vector type PIMathVector
|
||||
* @return column matrix of every element that is equal to every element of the vector
|
||||
@@ -777,7 +777,7 @@ public:
|
||||
static _CMatrix matrixCol(const PIMathVector<Type> &val) {return _CMatrix(1, val.size(), val.toVector());}
|
||||
|
||||
/**
|
||||
* @brief Set the selected column in matrix. If there are more elements of the vector than elements in the column of the matrix
|
||||
* \brief Set the selected column in matrix. If there are more elements of the vector than elements in the column of the matrix
|
||||
* or index larger than the number of columns otherwise there will be "undefined behavior"
|
||||
*
|
||||
* @param index is the number of the selected column
|
||||
@@ -791,7 +791,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Set the selected row in matrix. If there are more elements of the vector than elements in the row of the matrix,
|
||||
* \brief Set the selected row in matrix. If there are more elements of the vector than elements in the row of the matrix,
|
||||
* or index larger than the number of rows otherwise there will be "undefined behavior"
|
||||
* @param index is the number of the selected row
|
||||
* @param v is a vector of the type _CMCol that needs to fill the row
|
||||
@@ -804,7 +804,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which replace selected columns in a matrix. You cannot use an index larger than the number of columns,
|
||||
* \brief Method which replace selected columns in a matrix. You cannot use an index larger than the number of columns,
|
||||
* otherwise there will be "undefined behavior"
|
||||
*
|
||||
* @param r0 is the number of the first selected row
|
||||
@@ -817,7 +817,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which replace selected rows in a matrix. You cannot use an index larger than the number of rows,
|
||||
* \brief Method which replace selected rows in a matrix. You cannot use an index larger than the number of rows,
|
||||
* otherwise there will be "undefined behavior"
|
||||
*
|
||||
* @param c0 is the number of the first selected row
|
||||
@@ -830,7 +830,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which fills the matrix with selected value
|
||||
* \brief Method which fills the matrix with selected value
|
||||
*
|
||||
* @param v is a parameter the type and value of which is selected and later filled into the matrix
|
||||
* @return filled matrix type _CMatrix
|
||||
@@ -841,14 +841,14 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which checks if matrix is square
|
||||
* \brief Method which checks if matrix is square
|
||||
*
|
||||
* @return true if matrix is square, else false
|
||||
*/
|
||||
bool isSquare() const { return _V2D::cols_ == _V2D::rows_; }
|
||||
|
||||
/**
|
||||
* @brief Method which checks if main diagonal of matrix consists of ones and another elements are zeros
|
||||
* \brief Method which checks if main diagonal of matrix consists of ones and another elements are zeros
|
||||
*
|
||||
* @return true if matrix is identity, else false
|
||||
*/
|
||||
@@ -858,7 +858,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which checks if every elements of matrix are zeros
|
||||
* \brief Method which checks if every elements of matrix are zeros
|
||||
*
|
||||
* @return true if matrix elements equal to zero, else false
|
||||
*/
|
||||
@@ -868,14 +868,14 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Method which checks if matrix is empty
|
||||
* \brief Method which checks if matrix is empty
|
||||
*
|
||||
* @return true if matrix is valid, else false
|
||||
*/
|
||||
bool isValid() const { return !PIVector2D<Type>::isEmpty(); }
|
||||
|
||||
/**
|
||||
* @brief Addition assignment with matrix "sm"
|
||||
* \brief Addition assignment with matrix "sm"
|
||||
*
|
||||
* @param sm matrix for the addition assigment
|
||||
*/
|
||||
@@ -886,7 +886,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Subtraction assignment with matrix "sm"
|
||||
* \brief Subtraction assignment with matrix "sm"
|
||||
*
|
||||
* @param sm matrix for the subtraction assigment
|
||||
*/
|
||||
@@ -897,7 +897,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplication assignment with value "v"
|
||||
* \brief Multiplication assignment with value "v"
|
||||
*
|
||||
* @param v value for the multiplication assigment
|
||||
*/
|
||||
@@ -906,7 +906,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Division assignment with value "v"
|
||||
* \brief Division assignment with value "v"
|
||||
*
|
||||
* @param v value for the division assigment
|
||||
*/
|
||||
@@ -916,7 +916,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix substraction
|
||||
* \brief Matrix substraction
|
||||
*
|
||||
* @return the result of matrix substraction
|
||||
*/
|
||||
@@ -927,7 +927,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix addition
|
||||
* \brief Matrix addition
|
||||
*
|
||||
* @param sm is matrix term
|
||||
* @return the result of matrix addition
|
||||
@@ -941,7 +941,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix subtraction
|
||||
* \brief Matrix subtraction
|
||||
*
|
||||
* @param sm is matrix subtractor
|
||||
* @return the result of matrix subtraction
|
||||
@@ -955,7 +955,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix multiplication
|
||||
* \brief Matrix multiplication
|
||||
*
|
||||
* @param v is value factor
|
||||
* @return the result of matrix multiplication
|
||||
@@ -967,7 +967,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix division
|
||||
* \brief Matrix division
|
||||
*
|
||||
* @param v is value divider
|
||||
* @return the result of matrix division
|
||||
@@ -980,7 +980,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Determinant of the self matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Determinant of the self matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return matrix determinant
|
||||
@@ -1001,7 +1001,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Trace of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Trace of the matrix is calculated. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @return matrix trace
|
||||
*/
|
||||
@@ -1015,7 +1015,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Transforming matrix to upper triangular. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Transforming matrix to upper triangular. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return copy of transformed upper triangular matrix
|
||||
@@ -1055,7 +1055,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @param sv is a vector multiplier
|
||||
@@ -1114,7 +1114,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
* \brief Matrix inversion operation. Works only with square matrix, nonzero matrices and invertible matrix
|
||||
*
|
||||
* @param ok is a parameter with which we can find out if the method worked correctly
|
||||
* @return inverted matrix
|
||||
@@ -1126,7 +1126,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix transposition operation
|
||||
* \brief Matrix transposition operation
|
||||
*
|
||||
* @return transposed matrix
|
||||
*/
|
||||
@@ -1144,7 +1144,7 @@ inline std::ostream & operator <<(std::ostream & s, const PIMathMatrix<Type> & m
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Inline operator for outputting the matrix to the console
|
||||
* \brief Inline operator for outputting the matrix to the console
|
||||
*
|
||||
* @param s PICout type
|
||||
* @param the matrix type PIMathMatrix that we print to the console
|
||||
@@ -1165,7 +1165,7 @@ inline PICout operator<<(PICout s, const PIMathMatrix<Type> &m) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Inline operator for serializing a matrix into a PIByteArray
|
||||
* \brief Inline operator for serializing a matrix into a PIByteArray
|
||||
*
|
||||
* @param s PIByteArray type
|
||||
* @param v PIMathMatrix type
|
||||
@@ -1178,7 +1178,7 @@ inline PIByteArray &operator<<(PIByteArray &s, const PIMathMatrix<Type> &v) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Inline operator to deserialize matrix from PIByteArray
|
||||
* \brief Inline operator to deserialize matrix from PIByteArray
|
||||
*
|
||||
* @param s PIByteArray type
|
||||
* @param v PIMathMatrix type
|
||||
@@ -1192,7 +1192,7 @@ inline PIByteArray &operator>>(PIByteArray &s, PIMathMatrix<Type> &v) {
|
||||
|
||||
|
||||
/**
|
||||
* @brief Multiplying matrices by each other. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying matrices by each other. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param fm first matrix multiplier
|
||||
* @param sm second matrix multiplier
|
||||
@@ -1216,7 +1216,7 @@ inline PIMathMatrix<Type> operator*(const PIMathMatrix<Type> &fm,
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying matrix and vector. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying matrix and vector. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param fm first matrix multiplier
|
||||
* @param sv second vector multiplier
|
||||
@@ -1238,7 +1238,7 @@ inline PIMathVector<Type> operator*(const PIMathMatrix<Type> &fm,
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying vector and matrix. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
* \brief Multiplying vector and matrix. If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param sv first vector multiplier
|
||||
* @param fm second matrix multiplier
|
||||
@@ -1260,7 +1260,7 @@ inline PIMathVector<Type> operator*(const PIMathVector<Type> &sv,
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Multiplying value of type Type and matrix
|
||||
* \brief Multiplying value of type Type and matrix
|
||||
*
|
||||
* @param x first multiplier of type Type
|
||||
* @param v second matrix multiplier
|
||||
@@ -1275,7 +1275,7 @@ typedef PIMathMatrix<int> PIMathMatrixi;
|
||||
typedef PIMathMatrix<double> PIMathMatrixd;
|
||||
|
||||
/**
|
||||
* @brief Searching hermitian matrix
|
||||
* \brief Searching hermitian matrix
|
||||
*
|
||||
* @param m conjugate transpose matrix
|
||||
* @return result of the hermitian
|
||||
|
||||
Reference in New Issue
Block a user