#ifndef Magnum_Math_Matrix_h #define Magnum_Math_Matrix_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** @file * @brief Class @ref Magnum::Math::Matrix, alias @ref Magnum::Math::Matrix2x2, @ref Magnum::Math::Matrix3x3, @ref Magnum::Math::Matrix4x4 */ /* std::declval() is said to be in but libstdc++, libc++ and MSVC STL all have it directly in because it just makes sense */ #include #include "Magnum/Math/RectangularMatrix.h" namespace Magnum { namespace Math { namespace Implementation { template struct MatrixDeterminant; } /** @brief Square matrix @tparam size Matrix size @tparam T Data type See @ref matrix-vector for brief introduction. @configurationvalueref{Magnum::Math::Matrix} @see @ref Matrix2x2, @ref Matrix3x3, @ref Matrix4x4, @ref Magnum::Matrix2x2, @ref Magnum::Matrix2x2d, @ref Magnum::Matrix2x2h, @ref Magnum::Matrix2x2b, @ref Magnum::Matrix2x2s, @ref Magnum::Matrix3x3, @ref Magnum::Matrix3x3d, @ref Magnum::Matrix3x3h, @ref Magnum::Matrix3x3b, @ref Magnum::Matrix3x3s, @ref Magnum::Matrix4x4, @ref Magnum::Matrix4x4d, @ref Magnum::Matrix4x4h, @ref Magnum::Matrix4x4b, @ref Magnum::Matrix4x4s */ template class Matrix: public RectangularMatrix { public: enum: std::size_t { Size = size /**< Matrix size */ }; /** * @brief Default constructor * * Equivalent to @ref Matrix(IdentityInitT, T). */ constexpr /*implicit*/ Matrix() noexcept: RectangularMatrix{typename Containers::Implementation::GenerateSequence::Type{}, Vector(T(1))} {} /** * @brief Construct an identity matrix * * The @p value allows you to specify a value on diagonal. * @see @ref Matrix(ZeroInitT), @ref fromDiagonal() */ constexpr explicit Matrix(IdentityInitT, T value = T(1)) noexcept: RectangularMatrix{IdentityInit, value} {} /** @copydoc RectangularMatrix::RectangularMatrix(ZeroInitT) */ constexpr explicit Matrix(ZeroInitT) noexcept: RectangularMatrix{ZeroInit} {} /** @copydoc RectangularMatrix::RectangularMatrix(Magnum::NoInitT) */ constexpr explicit Matrix(Magnum::NoInitT) noexcept: RectangularMatrix{Magnum::NoInit} {} /** @brief Construct from column vectors */ template constexpr /*implicit*/ Matrix(const Vector& first, const U&... next) noexcept: RectangularMatrix(first, next...) {} /** @brief Construct with one value for all elements */ constexpr explicit Matrix(T value) noexcept: RectangularMatrix{value} {} /** @copydoc RectangularMatrix::RectangularMatrix(const T(&)[cols_][rows_]) */ #if !defined(CORRADE_TARGET_GCC) || defined(CORRADE_TARGET_CLANG) || __GNUC__ >= 5 template constexpr explicit Matrix(const T(&data)[cols_][rows_]) noexcept: RectangularMatrix{data} {} #else /* GCC 4.8 workaround, see the RectangularMatrix base for details */ constexpr explicit Matrix(const T(&data)[size][size]) noexcept: RectangularMatrix{data} {} #endif /** * @brief Construct from a matrix of a different type * * Performs only default casting on the values, no rounding or * anything else. Example usage: * * @snippet Math.cpp Matrix-conversion */ template constexpr explicit Matrix(const RectangularMatrix& other) noexcept: RectangularMatrix(other) {} /** @brief Construct a matrix from external representation */ template::from(std::declval()))> constexpr explicit Matrix(const U& other): RectangularMatrix(Implementation::RectangularMatrixConverter::from(other)) {} /** @copydoc RectangularMatrix::RectangularMatrix(IdentityInitT, const RectangularMatrix&, T) */ template constexpr explicit Matrix(IdentityInitT, const RectangularMatrix& other, T value = T(1)) noexcept: RectangularMatrix{IdentityInit, other, value} {} /** @copydoc RectangularMatrix::RectangularMatrix(ZeroInitT, const RectangularMatrix&) */ template constexpr explicit Matrix(ZeroInitT, const RectangularMatrix& other) noexcept: RectangularMatrix{ZeroInit, other} {} /** * @brief Construct by slicing or expanding a matrix of different size * @m_since_latest * * Equivalent to @ref Matrix(IdentityInitT, const RectangularMatrix&, T). * Note that this default is different from @ref RectangularMatrix, * where it's equivalent to the @ref ZeroInit variant instead. */ template constexpr explicit Matrix(const RectangularMatrix& other, T value = T(1)) noexcept: RectangularMatrix{IdentityInit, other, value} {} /** @brief Copy constructor */ constexpr /*implicit*/ Matrix(const RectangularMatrix& other) noexcept: RectangularMatrix(other) {} /** * @brief Whether the matrix is orthogonal * * Also called an [orthonormal matrix](https://en.wikipedia.org/wiki/Orthogonal_matrix). * Returns @cpp true @ce if all basis vectors have unit length and are * orthogonal to each other. In other words, when its transpose is * equal to its inverse: @f[ * Q^T = Q^{-1} * @f] * @see @ref transposed(), @ref inverted(), * @ref Matrix3::isRigidTransformation(), * @ref Matrix4::isRigidTransformation(), * @ref Algorithms::gramSchmidtOrthogonalizeInPlace(), * @ref Algorithms::gramSchmidtOrthonormalizeInPlace() */ bool isOrthogonal() const; /** * @brief Trace of the matrix * * @f[ * tr(A) = \sum_{i=1}^n a_{i,i} * @f] */ T trace() const { return RectangularMatrix::diagonal().sum(); } /** * @brief Matrix without given column and row * * For the following matrix @f$ \boldsymbol{M} @f$, * @f$ \boldsymbol{M}_{3,2} @f$ is defined as: @f[ * \begin{array}{rcl} * \boldsymbol{M} & = & \begin{pmatrix} * \,\,\,1 & 4 & 7 \\ * \,\,\,3 & 0 & 5 \\ * -1 & 9 & \!11 \\ * \end{pmatrix} \\[2em] * \boldsymbol{M}_{2,3} & = & \begin{pmatrix} * \,\,1 & 4 & \Box\, \\ * \,\Box & \Box & \Box\, \\ * -1 & 9 & \Box\, \\ * \end{pmatrix} = \begin{pmatrix} * \,\,\,1 & 4\, \\ * -1 & 9\, \\ * \end{pmatrix} * \end{array} * @f] * * @see @ref cofactor(), @ref adjugate(), @ref determinant() */ Matrix ij(std::size_t skipCol, std::size_t skipRow) const; /** * @brief Cofactor * @m_since{2019,10} * * Cofactor @f$ C_{i,j} @f$ of a matrix @f$ \boldsymbol{M} @f$ is * defined as @f$ C_{i,j} = (-1)^{i + j} \det \boldsymbol{M}_{i,j} @f$, * with @f$ \boldsymbol{M}_{i,j} @f$ being @f$ \boldsymbol{M} @f$ * without the i-th column and j-th row. For example, calculating * @f$ C_{3,2} @f$ of @f$ \boldsymbol{M} @f$ defined as @f[ * \boldsymbol{M} = \begin{pmatrix} * \,\,\,1 & 4 & 7 \\ * \,\,\,3 & 0 & 5 \\ * -1 & 9 & \!11 \\ * \end{pmatrix} * @f] * * @m_class{m-noindent} * * would be @f[ * C_{3,2} = (-1)^{2 + 3} \det \begin{pmatrix} * \,\,1 & 4 & \Box\, \\ * \,\Box & \Box & \Box\, \\ * -1 & 9 & \Box\, \\ * \end{pmatrix} = -\det \begin{pmatrix} * \,\,\,1 & 4\, \\ * -1 & 9\, \\ * \end{pmatrix} = -(9-(-4)) = -13 * @f] * * @see @ref ij(), @ref comatrix(), @ref adjugate() */ T cofactor(std::size_t col, std::size_t row) const; /** * @brief Matrix of cofactors * @m_since{2019,10} * * A cofactor matrix @f$ \boldsymbol{C} @f$ of a matrix * @f$ \boldsymbol{M} @f$ is defined as the following, with each * @f$ C_{i,j} @f$ calculated as in @ref cofactor(). @f[ * \boldsymbol C = \begin{pmatrix} * C_{1,1} & C_{2,1} & \cdots & C_{n,1} \\ * C_{1,2} & C_{2,2} & \cdots & C_{n,2} \\ * \vdots & \vdots & \ddots & \vdots \\ * C_{1,n} & C_{2,n} & \cdots & C_{n,n} * \end{pmatrix} * @f] * * @see @ref inverted(), @ref ij(), @ref adjugate() */ Matrix comatrix() const; /** * @brief Adjugate matrix * @m_since{2019,10} * * @f$ adj(A) @f$. Transpose of a @ref comatrix(), used for example to * calculate an @ref inverted() matrix. */ Matrix adjugate() const; /** * @brief Determinant * * Returns 0 if the matrix is noninvertible, ±1 if the matrix is * orthogonal, 1 if it's a pure rotation and -1 if it contains a * reflection. Computed recursively using * Laplace's formula: @f[ * \det \boldsymbol{A} = \sum_{j=1}^n (-1)^{i+j} a_{i,j} \det \boldsymbol{A}_{i,j} * @f] @f$ \boldsymbol{A}_{i,j} @f$ is @f$ \boldsymbol{A} @f$ without * the i-th column and j-th row. The formula is recursed down to a 2x2 * matrix, where the determinant is calculated directly: @f[ * \det \boldsymbol{A} = a_{0, 0} a_{1, 1} - a_{1, 0} a_{0, 1} * @f] * * @see @ref ij() */ T determinant() const { return Implementation::MatrixDeterminant()(*this); } /** * @brief Inverted matrix * * Calculated using Cramer's rule and @ref adjugate(), or equivalently * using a @ref comatrix(): @f[ * \boldsymbol{A}^{-1} = \frac{1}{\det \boldsymbol{A}} adj(\boldsymbol{A}) = \frac{1}{\det \boldsymbol{A}} \boldsymbol{C}^T * @f] * See @ref invertedOrthogonal(), @ref Matrix3::invertedRigid() and * @ref Matrix4::invertedRigid() which are faster alternatives for * particular matrix types. * @see @ref Algorithms::gaussJordanInverted() * @m_keyword{inverse(),GLSL inverse(),} */ Matrix inverted() const; /** * @brief Inverted orthogonal matrix * * Equivalent to @ref transposed(), expects that the matrix is * orthogonal. @f[ * \boldsymbol{A}^{-1} = \boldsymbol{A}^T * @f] * @see @ref inverted(), @ref isOrthogonal(), * @ref Matrix3::invertedRigid(), * @ref Matrix4::invertedRigid() */ Matrix invertedOrthogonal() const { CORRADE_DEBUG_ASSERT(isOrthogonal(), "Math::Matrix::invertedOrthogonal(): the matrix is not orthogonal:" << Debug::Debug::newline << *this, {}); return RectangularMatrix::transposed(); } #ifndef DOXYGEN_GENERATING_OUTPUT /* Reimplementation of functions to return correct type */ Matrix operator*(const Matrix& other) const { return RectangularMatrix::operator*(other); } template RectangularMatrix operator*(const RectangularMatrix& other) const { return RectangularMatrix::operator*(other); } Vector operator*(const Vector& other) const { return RectangularMatrix::operator*(other); } Matrix transposed() const { return RectangularMatrix::transposed(); } MAGNUM_RECTANGULARMATRIX_SUBCLASS_IMPLEMENTATION(size, size, Matrix) #endif private: friend struct Implementation::MatrixDeterminant; }; /** @brief 2x2 matrix Convenience alternative to `Matrix<2, T>`. See @ref Matrix for more information. @see @ref Magnum::Matrix2x2, @ref Magnum::Matrix2x2d, @ref Magnum::Matrix2x2h, @ref Magnum::Matrix2x2b, @ref Magnum::Matrix2x2s */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ template using Matrix2x2 = Matrix<2, T>; #endif /** @brief 3x3 matrix Convenience alternative to `Matrix<3, T>`. See @ref Matrix for more information. Note that this is different from @ref Matrix3, which contains additional functions for transformations in 2D. @see @ref Magnum::Matrix3x3, @ref Magnum::Matrix3x3d, @ref Magnum::Matrix3x3h, @ref Magnum::Matrix3x3b, @ref Magnum::Matrix3x3s */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ template using Matrix3x3 = Matrix<3, T>; #endif /** @brief 4x4 matrix Convenience alternative to `Matrix<4, T>`. See @ref Matrix for more information. Note that this is different from @ref Matrix4, which contains additional functions for transformations in 3D. @see @ref Magnum::Matrix4x4, @ref Magnum::Matrix4x4d, @ref Magnum::Matrix4x4h, @ref Magnum::Matrix4x4b, @ref Magnum::Matrix4x4s */ #ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */ template using Matrix4x4 = Matrix<4, T>; #endif MAGNUM_MATRIX_OPERATOR_IMPLEMENTATION(Matrix) #ifndef DOXYGEN_GENERATING_OUTPUT #define MAGNUM_MATRIX_SUBCLASS_IMPLEMENTATION(size, Type, VectorType) \ VectorType& operator[](std::size_t col) { \ return static_cast&>(Matrix::operator[](col)); \ } \ constexpr const VectorType operator[](std::size_t col) const { \ return VectorType(Matrix::operator[](col)); \ } \ VectorType row(std::size_t row) const { \ return VectorType(Matrix::row(row)); \ } \ \ Type operator*(const Matrix& other) const { \ return Matrix::operator*(other); \ } \ template RectangularMatrix operator*(const RectangularMatrix& other) const { \ return Matrix::operator*(other); \ } \ VectorType operator*(const Vector& other) const { \ return Matrix::operator*(other); \ } \ \ Type transposed() const { return Matrix::transposed(); } \ constexpr VectorType diagonal() const { return Matrix::diagonal(); } \ Type inverted() const { return Matrix::inverted(); } \ Type invertedOrthogonal() const { \ return Matrix::invertedOrthogonal(); \ } namespace Implementation { template struct MatrixDeterminant { T operator()(const Matrix& m) { T out(0); /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ for(std::size_t col = 0; col != size; ++col) out += m._data[col]._data[0]*m.cofactor(col, 0); return out; } T operator()(const Matrix& m, const std::size_t skipCol, const std::size_t skipRow) { return m.ij(skipCol, skipRow).determinant(); } }; /* This is not *critically* needed here (the specializations for 2x2 and 1x1 are technically enough to make things work), but together with the raw data access it speeds up the debug build five times, so I think it's worth to have it */ template struct MatrixDeterminant<3, T> { constexpr T operator()(const Matrix<3, T>& m) const { /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ return m._data[0]._data[0]*((m._data[1]._data[1]*m._data[2]._data[2]) - (m._data[2]._data[1]*m._data[1]._data[2])) - m._data[0]._data[1]*(m._data[1]._data[0]*m._data[2]._data[2] - m._data[2]._data[0]*m._data[1]._data[2]) + m._data[0]._data[2]*(m._data[1]._data[0]*m._data[2]._data[1] - m._data[2]._data[0]*m._data[1]._data[1]); } /* Used internally by cofactor(), basically just an inlined variant of ij(skipCol, skipRow).determinant() */ constexpr T operator()(const Matrix<4, T>& m, const std::size_t skipCol, const std::size_t skipRow) const { #define _col(i) _data[i + (i >= skipCol)] #define _row(i) _data[i + (i >= skipRow)] return m._col(0)._row(0)*((m._col(1)._row(1)*m._col(2)._row(2)) - (m._col(2)._row(1)*m._col(1)._row(2))) - m._col(0)._row(1)*(m._col(1)._row(0)*m._col(2)._row(2) - m._col(2)._row(0)*m._col(1)._row(2)) + m._col(0)._row(2)*(m._col(1)._row(0)*m._col(2)._row(1) - m._col(2)._row(0)*m._col(1)._row(1)); #undef _col #undef _row } }; template struct MatrixDeterminant<2, T> { constexpr T operator()(const Matrix<2, T>& m) const { /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ return m._data[0]._data[0]*m._data[1]._data[1] - m._data[1]._data[0]*m._data[0]._data[1]; } /* Used internally by cofactor(), basically just an inlined variant of ij(skipCol, skipRow).determinant() */ constexpr T operator()(const Matrix<3, T>& m, const std::size_t skipCol, const std::size_t skipRow) const { #define _col(i) _data[i + (i >= skipCol)] #define _row(i) _data[i + (i >= skipRow)] return m._col(0)._row(0)*m._col(1)._row(1) - m._col(1)._row(0)*m._col(0)._row(1); #undef _col #undef _row } }; template struct MatrixDeterminant<1, T> { constexpr T operator()(const Matrix<1, T>& m) const { /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ return m._data[0]._data[0]; } /* Used internally by cofactor(), basically just an inlined variant of ij(skipCol, skipRow).determinant() */ constexpr T operator()(const Matrix<2, T>& m, const std::size_t skipCol, const std::size_t skipRow) const { return m._data[0 + (0 >= skipCol)]._data[0 + (0 >= skipRow)]; } }; #ifndef MAGNUM_NO_MATH_STRICT_WEAK_ORDERING template struct StrictWeakOrdering>: StrictWeakOrdering> {}; #endif } #endif template bool Matrix::isOrthogonal() const { /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ /* Normality */ for(std::size_t i = 0; i != size; ++i) if(!RectangularMatrix::_data[i].isNormalized()) return false; /* Orthogonality */ for(std::size_t i = 0; i != size-1; ++i) for(std::size_t j = i+1; j != size; ++j) if(std::abs(dot(RectangularMatrix::_data[i], RectangularMatrix::_data[j])) > TypeTraits::epsilon()) return false; return true; } template Matrix Matrix::ij(const std::size_t skipCol, const std::size_t skipRow) const { Matrix out{Magnum::NoInit}; /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ for(std::size_t col = 0; col != size-1; ++col) for(std::size_t row = 0; row != size-1; ++row) out._data[col]._data[row] = RectangularMatrix:: _data[col + (col >= skipCol)] ._data[row + (row >= skipRow)]; return out; } template T Matrix::cofactor(std::size_t col, std::size_t row) const { return (((row+col) & 1) ? -1 : 1)*Implementation::MatrixDeterminant()(*this, col, row); } template Matrix Matrix::comatrix() const { Matrix out{Magnum::NoInit}; /* Using ._data[] instead of [] to avoid function call indirection on debug builds (saves a lot, yet doesn't obfuscate too much) */ for(std::size_t col = 0; col != size; ++col) for(std::size_t row = 0; row != size; ++row) out._data[col]._data[row] = cofactor(col, row); return out; } template Matrix Matrix::adjugate() const { Matrix out{Magnum::NoInit}; /* Same as comatrix(), except using cofactor(row, col) instead of cofactor(col, row). Could also be just comatrix().transpose() but since this is used in inverted(), each extra operation hurts. */ for(std::size_t col = 0; col != size; ++col) for(std::size_t row = 0; row != size; ++row) out._data[col]._data[row] = cofactor(row, col); return out; } template Matrix Matrix::inverted() const { return adjugate()/determinant(); } }} #endif