Browse Source

Doc++

pull/7/head
Vladimír Vondruš 13 years ago
parent
commit
99e2bd4c64
  1. 2
      doc/matrix-vector.dox
  2. 4
      src/Math/Algorithms/GramSchmidt.h
  3. 1
      src/Math/Matrix.h
  4. 1
      src/Math/Matrix3.h
  5. 1
      src/Math/Matrix4.h
  6. 1
      src/Math/RectangularMatrix.h

2
doc/matrix-vector.dox

@ -175,7 +175,7 @@ mat[0] *= 2; // first column
mat[2][0] = 5; // first element of first column mat[2][0] = 5; // first element of first column
@endcode @endcode
- Various algorithms which commonly operate on matrix rows (such as - Various algorithms which commonly operate on matrix rows (such as
@ref Algorithms::GaussJordan "Gauss-Jordan elimination") have faster @ref Algorithms::gaussJordanInPlace() "Gauss-Jordan elimination") have faster
alternatives which operate on columns. It's then up to user decision to alternatives which operate on columns. It's then up to user decision to
operate with transposed matrices or use the slower non-transposed operate with transposed matrices or use the slower non-transposed
alternative of the algorithm. alternative of the algorithm.

4
src/Math/Algorithms/GramSchmidt.h

@ -25,7 +25,7 @@ namespace Magnum { namespace Math { namespace Algorithms {
/** /**
@brief In-place Gram-Schmidt matrix orthogonalization @brief In-place Gram-Schmidt matrix orthogonalization
@param[in,out] matrix Matrix to perform orthogonalization on @param[in,out] matrix %Matrix to perform orthogonalization on
*/ */
template<std::size_t cols, std::size_t rows, class T> void gramSchmidtOrthogonalizeInPlace(RectangularMatrix<cols, rows, T>& matrix) { template<std::size_t cols, std::size_t rows, class T> void gramSchmidtOrthogonalizeInPlace(RectangularMatrix<cols, rows, T>& matrix) {
static_assert(cols <= rows, "Unsupported matrix aspect ratio"); static_assert(cols <= rows, "Unsupported matrix aspect ratio");
@ -48,7 +48,7 @@ template<std::size_t cols, std::size_t rows, class T> RectangularMatrix<cols, ro
/** /**
@brief In-place Gram-Schmidt matrix orthonormalization @brief In-place Gram-Schmidt matrix orthonormalization
@param[in,out] matrix Matrix to perform orthonormalization on @param[in,out] matrix %Matrix to perform orthonormalization on
*/ */
template<std::size_t cols, std::size_t rows, class T> void gramSchmidtOrthonormalizeInPlace(RectangularMatrix<cols, rows, T>& matrix) { template<std::size_t cols, std::size_t rows, class T> void gramSchmidtOrthonormalizeInPlace(RectangularMatrix<cols, rows, T>& matrix) {
static_assert(cols <= rows, "Unsupported matrix aspect ratio"); static_assert(cols <= rows, "Unsupported matrix aspect ratio");

1
src/Math/Matrix.h

@ -61,6 +61,7 @@ template<std::size_t size, class T> class Matrix: public RectangularMatrix<size,
* You can also explicitly call this constructor with * You can also explicitly call this constructor with
* `Matrix m(Matrix::Identity);`. Optional parameter @p value allows * `Matrix m(Matrix::Identity);`. Optional parameter @p value allows
* you to specify value on diagonal. * you to specify value on diagonal.
* @todo use constexpr fromDiagonal() for this when it's done
*/ */
inline /*implicit*/ Matrix(IdentityType = Identity, T value = T(1)) { inline /*implicit*/ Matrix(IdentityType = Identity, T value = T(1)) {
for(std::size_t i = 0; i != size; ++i) for(std::size_t i = 0; i != size; ++i)

1
src/Math/Matrix3.h

@ -119,6 +119,7 @@ template<class T> class Matrix3: public Matrix<3, T> {
inline constexpr explicit Matrix3(typename Matrix<3, T>::ZeroType): Matrix<3, T>(Matrix<3, T>::Zero) {} inline constexpr explicit Matrix3(typename Matrix<3, T>::ZeroType): Matrix<3, T>(Matrix<3, T>::Zero) {}
/** @copydoc Matrix::Matrix(IdentityType, T) */ /** @copydoc Matrix::Matrix(IdentityType, T) */
/** @todo Use constexpr implementation in Matrix, when done */
inline constexpr /*implicit*/ Matrix3(typename Matrix<3, T>::IdentityType = (Matrix<3, T>::Identity), T value = T(1)): Matrix<3, T>( inline constexpr /*implicit*/ Matrix3(typename Matrix<3, T>::IdentityType = (Matrix<3, T>::Identity), T value = T(1)): Matrix<3, T>(
Vector<3, T>(value, T(0), T(0)), Vector<3, T>(value, T(0), T(0)),
Vector<3, T>( T(0), value, T(0)), Vector<3, T>( T(0), value, T(0)),

1
src/Math/Matrix4.h

@ -243,6 +243,7 @@ template<class T> class Matrix4: public Matrix<4, T> {
inline constexpr explicit Matrix4(typename Matrix<4, T>::ZeroType): Matrix<4, T>(Matrix<4, T>::Zero) {} inline constexpr explicit Matrix4(typename Matrix<4, T>::ZeroType): Matrix<4, T>(Matrix<4, T>::Zero) {}
/** @copydoc Matrix::Matrix(IdentityType, T) */ /** @copydoc Matrix::Matrix(IdentityType, T) */
/** @todo Use constexpr implementation in Matrix, when done */
inline constexpr /*implicit*/ Matrix4(typename Matrix<4, T>::IdentityType = (Matrix<4, T>::Identity), T value = T(1)): Matrix<4, T>( inline constexpr /*implicit*/ Matrix4(typename Matrix<4, T>::IdentityType = (Matrix<4, T>::Identity), T value = T(1)): Matrix<4, T>(
Vector<4, T>(value, T(0), T(0), T(0)), Vector<4, T>(value, T(0), T(0), T(0)),
Vector<4, T>( T(0), value, T(0), T(0)), Vector<4, T>( T(0), value, T(0), T(0)),

1
src/Math/RectangularMatrix.h

@ -73,6 +73,7 @@ template<std::size_t cols, std::size_t rows, class T> class RectangularMatrix {
* @brief Construct diagonal matrix * @brief Construct diagonal matrix
* *
* @see diagonal() * @see diagonal()
* @todo make this constexpr
*/ */
inline static RectangularMatrix<cols, rows, T> fromDiagonal(const Vector<DiagonalSize, T>& diagonal) { inline static RectangularMatrix<cols, rows, T> fromDiagonal(const Vector<DiagonalSize, T>& diagonal) {
RectangularMatrix<cols, rows, T> out; RectangularMatrix<cols, rows, T> out;

Loading…
Cancel
Save