#ifndef Magnum_Math_RectangularMatrix_h #define Magnum_Math_RectangularMatrix_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013 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 Magnum::Math::RectangularMatrix */ #include "Math/Vector.h" namespace Magnum { namespace Math { namespace Implementation { template struct RectangularMatrixConverter; } /** @brief Rectangular matrix @tparam cols Column count @tparam rows Row count @tparam T Underlying data type See @ref matrix-vector for brief introduction. See also Matrix (square) and Vector. The data are stored in column-major order, to reflect that, all indices in math formulas are in reverse order (i.e. @f$ \boldsymbol A_{ji} @f$ instead of @f$ \boldsymbol A_{ij} @f$). @see Magnum::Matrix2x3, Magnum::Matrix3x2, Magnum::Matrix2x4, Magnum::Matrix4x2, Magnum::Matrix3x4, Magnum::Matrix4x3, Magnum::Matrix2x3d, Magnum::Matrix3x2d, Magnum::Matrix2x4d, Magnum::Matrix4x2d, Magnum::Matrix3x4d, Magnum::Matrix4x3d */ template class RectangularMatrix { static_assert(cols != 0 && rows != 0, "RectangularMatrix cannot have zero elements"); template friend class RectangularMatrix; public: typedef T Type; /**< @brief Underlying data type */ const static std::size_t Cols = cols; /**< @brief %Matrix column count */ const static std::size_t Rows = rows; /**< @brief %Matrix row count */ /** * @brief Size of matrix diagonal * * @see fromDiagonal(), diagonal() */ const static std::size_t DiagonalSize = (cols < rows ? cols : rows); /** * @brief %Matrix from array * @return Reference to the data as if it was Matrix, thus doesn't * perform any copying. * * @attention Use with caution, the function doesn't check whether the * array is long enough. */ constexpr static RectangularMatrix& from(T* data) { return *reinterpret_cast*>(data); } /** @overload */ constexpr static const RectangularMatrix& from(const T* data) { return *reinterpret_cast*>(data); } /** * @brief Construct diagonal matrix * * @see diagonal() * @todo make this constexpr */ static RectangularMatrix fromDiagonal(const Vector& diagonal); /** * @brief Construct matrix from vector * * Rolls the vector into matrix, i.e. first `rows` elements of the * vector will make first column of resulting matrix. * @see toVector() */ static RectangularMatrix fromVector(const Vector& vector) { return *reinterpret_cast*>(vector.data()); } /** @brief Construct zero-filled matrix */ constexpr /*implicit*/ RectangularMatrix() {} /** * @brief Construct matrix from column vectors * @param first First column vector * @param next Next column vectors * * @todo Creating matrix from arbitrary combination of matrices with n rows */ template constexpr /*implicit*/ RectangularMatrix(const Vector& first, const U&... next): _data{first, next...} { static_assert(sizeof...(next)+1 == cols, "Improper number of arguments passed to RectangularMatrix constructor"); } /** * @brief Construct matrix from another of different type * * Performs only default casting on the values, no rounding or * anything else. Example usage: * @code * RectangularMatrix<4, 1, Float> floatingPoint(1.3f, 2.7f, -15.0f, 7.0f); * RectangularMatrix<4, 1, Byte> integral(floatingPoint); * // integral == {1, 2, -15, 7} * @endcode */ #ifndef CORRADE_GCC46_COMPATIBILITY template constexpr explicit RectangularMatrix(const RectangularMatrix& other): RectangularMatrix(typename Implementation::GenerateSequence::Type(), other) {} #else template explicit RectangularMatrix(const RectangularMatrix& other) { *this = RectangularMatrix(typename Implementation::GenerateSequence::Type(), other); } #endif /** @brief Construct matrix from external representation */ #ifndef CORRADE_GCC46_COMPATIBILITY template::from(std::declval()))> constexpr explicit RectangularMatrix(const U& other): RectangularMatrix(Implementation::RectangularMatrixConverter::from(other)) {} #else template::from(std::declval()))> explicit RectangularMatrix(const U& other) { *this = Implementation::RectangularMatrixConverter::from(other); } #endif /** @brief Copy constructor */ constexpr RectangularMatrix(const RectangularMatrix&) = default; /** @brief Assignment operator */ RectangularMatrix& operator=(const RectangularMatrix&) = default; /** @brief Convert matrix to external representation */ template::to(std::declval>()))> constexpr explicit operator U() const { /** @bug Why this is not constexpr under GCC 4.6? */ return Implementation::RectangularMatrixConverter::to(*this); } /** * @brief Raw data * @return One-dimensional array of `size*size` length in column-major * order. * * @see operator[] */ T* data() { return _data[0].data(); } constexpr const T* data() const { return _data[0].data(); } /**< @overload */ /** * @brief %Matrix column * * Particular elements can be accessed using Vector::operator[], e.g.: * @code * RectangularMatrix<4, 3, Float> m; * Float a = m[2][1]; * @endcode * * @see row(), data() */ Vector& operator[](std::size_t col) { return _data[col]; } constexpr const Vector& operator[](std::size_t col) const { return _data[col]; } /** @overload */ /** * @brief %Matrix row * * Consider using transposed() when accessing rows frequently, as this * is slower than accessing columns due to the way the matrix is stored. * @see operator[]() */ Vector row(std::size_t row) const; /** @brief Equality comparison */ bool operator==(const RectangularMatrix& other) const { for(std::size_t i = 0; i != cols; ++i) if(_data[i] != other._data[i]) return false; return true; } /** * @brief Non-equality operator * * @see Vector::operator<(), Vector::operator<=(), Vector::operator>=(), * Vector::operator>() */ bool operator!=(const RectangularMatrix& other) const { return !operator==(other); } /** * @brief Negated matrix * * The computation is done column-wise. @f[ * \boldsymbol B_j = -\boldsymbol A_j * @f] */ RectangularMatrix operator-() const; /** * @brief Add and assign matrix * * The computation is done column-wise in-place. @f[ * \boldsymbol A_j = \boldsymbol A_j + \boldsymbol B_j * @f] */ RectangularMatrix& operator+=(const RectangularMatrix& other) { for(std::size_t i = 0; i != cols; ++i) _data[i] += other._data[i]; return *this; } /** * @brief Add matrix * * @see operator+=() */ RectangularMatrix operator+(const RectangularMatrix& other) const { return RectangularMatrix(*this)+=other; } /** * @brief Subtract and assign matrix * * The computation is done column-wise in-place. @f[ * \boldsymbol A_j = \boldsymbol A_j - \boldsymbol B_j * @f] */ RectangularMatrix& operator-=(const RectangularMatrix& other) { for(std::size_t i = 0; i != cols; ++i) _data[i] -= other._data[i]; return *this; } /** * @brief Subtract matrix * * @see operator-=() */ RectangularMatrix operator-(const RectangularMatrix& other) const { return RectangularMatrix(*this)-=other; } /** * @brief Multiply matrix with number and assign * * The computation is done column-wise in-place. @f[ * \boldsymbol A_j = a \boldsymbol A_j * @f] */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline typename std::enable_if::value, RectangularMatrix&>::type operator*=(U number) { #else template RectangularMatrix& operator*=(U number) { #endif for(std::size_t i = 0; i != cols; ++i) _data[i] *= number; return *this; } /** * @brief Multiply matrix with number * * @see operator*=(U), operator*(U, const RectangularMatrix&) */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline typename std::enable_if::value, RectangularMatrix>::type operator*(U number) const { #else template RectangularMatrix operator*(U number) const { #endif return RectangularMatrix(*this)*=number; } /** * @brief Divide matrix with number and assign * * The computation is done column-wise in-place. @f[ * \boldsymbol A_j = \frac{\boldsymbol A_j} a * @f] */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline typename std::enable_if::value, RectangularMatrix&>::type operator/=(U number) { #else template RectangularMatrix& operator/=(U number) { #endif for(std::size_t i = 0; i != cols; ++i) _data[i] /= number; return *this; } /** * @brief Divide matrix with number * * @see operator/=(), operator/(U, const RectangularMatrix&) */ #ifndef DOXYGEN_GENERATING_OUTPUT template inline typename std::enable_if::value, RectangularMatrix>::type operator/(U number) const { #else template RectangularMatrix operator/(U number) const { #endif return RectangularMatrix(*this)/=number; } /** * @brief Multiply matrix * * @f[ * (\boldsymbol {AB})_{ji} = \sum_{k=0}^{m-1} \boldsymbol A_{ki} \boldsymbol B_{jk} * @f] */ template RectangularMatrix operator*(const RectangularMatrix& other) const; /** * @brief Multiply vector * * Internally the same as multiplying with one-column matrix, but * returns vector. @f[ * (\boldsymbol {Aa})_i = \sum_{k=0}^{m-1} \boldsymbol A_{ki} \boldsymbol a_k * @f] */ Vector operator*(const Vector& other) const { return operator*(RectangularMatrix<1, rows, T>(other))[0]; } /** * @brief Transposed matrix * * @see row() */ RectangularMatrix transposed() const; /** * @brief Values on diagonal * * @see fromDiagonal() * @todo constexpr */ Vector diagonal() const; /** * @brief Convert matrix to vector * * Returns the matrix unrolled into one large vector, i.e. first column * of the matrix will make first `rows` elements of resulting vector. * Useful for performing vector operations with the matrix (e.g. * summing the elements etc.). * @see fromVector() */ Vector toVector() const { return *reinterpret_cast*>(data()); } private: /* Implementation for RectangularMatrix::RectangularMatrix(const RectangularMatrix&) */ template constexpr explicit RectangularMatrix(Implementation::Sequence, const RectangularMatrix& matrix): _data{Vector(matrix[sequence])...} {} Vector _data[cols]; }; /** @relates RectangularMatrix @brief Multiply number with matrix Same as RectangularMatrix::operator*(U) const. */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline RectangularMatrix operator*(U number, const RectangularMatrix& matrix) { #else template inline typename std::enable_if::value, RectangularMatrix>::type operator*(U number, const RectangularMatrix& matrix) { #endif return matrix*number; } /** @relates RectangularMatrix @brief Divide matrix with number and invert The computation is done column-wise. @f[ \boldsymbol B_j = \frac a {\boldsymbol A_j} @f] @see RectangularMatrix::operator/(U) const */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline RectangularMatrix operator/(U number, const RectangularMatrix& matrix) { #else template inline typename std::enable_if::value, RectangularMatrix>::type operator/(U number, const RectangularMatrix& matrix) { #endif RectangularMatrix out; for(std::size_t i = 0; i != cols; ++i) out[i] = number/matrix[i]; return out; } /** @relates RectangularMatrix @brief Multiply vector with rectangular matrix Internally the same as multiplying one-column matrix with one-row matrix. @f[ (\boldsymbol {aA})_{ji} = \boldsymbol a_i \boldsymbol A_j @f] @see RectangularMatrix::operator*(const RectangularMatrix&) const */ template inline RectangularMatrix operator*(const Vector& vector, const RectangularMatrix& matrix) { return RectangularMatrix<1, size, T>(vector)*matrix; } /** @debugoperator{Magnum::Math::RectangularMatrix} */ template Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Magnum::Math::RectangularMatrix& value) { debug << "Matrix("; debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, false); for(std::size_t row = 0; row != rows; ++row) { if(row != 0) debug << ",\n "; for(std::size_t col = 0; col != cols; ++col) { if(col != 0) debug << ", "; debug << value[col][row]; } } debug << ")"; debug.setFlag(Corrade::Utility::Debug::SpaceAfterEachValue, true); return debug; } #ifndef DOXYGEN_GENERATING_OUTPUT /* Explicit instantiation for types used in OpenGL */ /* Square matrices */ extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 2, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 3, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 4, Float>&); #ifndef MAGNUM_TARGET_GLES extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 2, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 3, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 4, Double>&); #endif /* Rectangular matrices */ extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 3, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 2, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 4, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 2, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 4, Float>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 3, Float>&); #ifndef MAGNUM_TARGET_GLES extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 3, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 2, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<2, 4, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 2, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<3, 4, Double>&); extern template Corrade::Utility::Debug MAGNUM_EXPORT operator<<(Corrade::Utility::Debug, const RectangularMatrix<4, 3, Double>&); #endif #define MAGNUM_RECTANGULARMATRIX_SUBCLASS_IMPLEMENTATION(cols, rows, ...) \ constexpr static __VA_ARGS__& from(T* data) { \ return *reinterpret_cast<__VA_ARGS__*>(data); \ } \ constexpr static const __VA_ARGS__& from(const T* data) { \ return *reinterpret_cast(data); \ } \ \ __VA_ARGS__& operator=(const Math::RectangularMatrix& other) { \ Math::RectangularMatrix::operator=(other); \ return *this; \ } \ \ __VA_ARGS__ operator-() const { \ return Math::RectangularMatrix::operator-(); \ } \ __VA_ARGS__& operator+=(const Math::RectangularMatrix& other) { \ Math::RectangularMatrix::operator+=(other); \ return *this; \ } \ __VA_ARGS__ operator+(const Math::RectangularMatrix& other) const { \ return Math::RectangularMatrix::operator+(other); \ } \ __VA_ARGS__& operator-=(const Math::RectangularMatrix& other) { \ Math::RectangularMatrix::operator-=(other); \ return *this; \ } \ __VA_ARGS__ operator-(const Math::RectangularMatrix& other) const { \ return Math::RectangularMatrix::operator-(other); \ } \ template typename std::enable_if::value, __VA_ARGS__&>::type operator*=(U number) { \ Math::RectangularMatrix::operator*=(number); \ return *this; \ } \ template typename std::enable_if::value, __VA_ARGS__>::type operator*(U number) const { \ return Math::RectangularMatrix::operator*(number); \ } \ template typename std::enable_if::value, __VA_ARGS__&>::type operator/=(U number) { \ Math::RectangularMatrix::operator/=(number); \ return *this; \ } \ template typename std::enable_if::value, __VA_ARGS__>::type operator/(U number) const { \ return Math::RectangularMatrix::operator/(number); \ } #endif template inline RectangularMatrix RectangularMatrix::fromDiagonal(const Vector& diagonal) { RectangularMatrix out; for(std::size_t i = 0; i != DiagonalSize; ++i) out[i][i] = diagonal[i]; return out; } template inline Vector RectangularMatrix::row(std::size_t row) const { Vector out; for(std::size_t i = 0; i != cols; ++i) out[i] = _data[i][row]; return out; } template inline RectangularMatrix RectangularMatrix::operator-() const { RectangularMatrix out; for(std::size_t i = 0; i != cols; ++i) out._data[i] = -_data[i]; return out; } template template inline RectangularMatrix RectangularMatrix::operator*(const RectangularMatrix& other) const { RectangularMatrix out; for(std::size_t col = 0; col != size; ++col) for(std::size_t row = 0; row != rows; ++row) for(std::size_t pos = 0; pos != cols; ++pos) out[col][row] += _data[pos][row]*other._data[col][pos]; return out; } template inline RectangularMatrix RectangularMatrix::transposed() const { RectangularMatrix out; for(std::size_t col = 0; col != cols; ++col) for(std::size_t row = 0; row != rows; ++row) out[row][col] = _data[col][row]; return out; } template auto RectangularMatrix::diagonal() const -> Vector { Vector out; for(std::size_t i = 0; i != DiagonalSize; ++i) out[i] = _data[i][i]; return out; } }} namespace Corrade { namespace Utility { /** @configurationvalue{Magnum::Math::RectangularMatrix} */ template struct ConfigurationValue> { ConfigurationValue() = delete; /** @brief Writes elements separated with spaces */ static std::string toString(const Magnum::Math::RectangularMatrix& value, ConfigurationValueFlags flags) { std::string output; for(std::size_t row = 0; row != rows; ++row) { for(std::size_t col = 0; col != cols; ++col) { if(!output.empty()) output += ' '; output += ConfigurationValue::toString(value[col][row], flags); } } return output; } /** @brief Reads elements separated with whitespace */ static Magnum::Math::RectangularMatrix fromString(const std::string& stringValue, ConfigurationValueFlags flags) { Magnum::Math::RectangularMatrix result; std::size_t oldpos = 0, pos = std::string::npos, i = 0; do { pos = stringValue.find(' ', oldpos); std::string part = stringValue.substr(oldpos, pos-oldpos); if(!part.empty()) { result[i%cols][i/cols] = ConfigurationValue::fromString(part, flags); ++i; } oldpos = pos+1; } while(pos != std::string::npos); return result; } }; #ifndef DOXYGEN_GENERATING_OUTPUT /* Square matrices */ extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; #ifndef MAGNUM_TARGET_GLES extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; #endif /* Rectangular matrices */ extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; #ifndef MAGNUM_TARGET_GLES extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; extern template struct MAGNUM_EXPORT ConfigurationValue>; #endif #endif }} #endif