1.0.2 API documentation: matrix_factorisation.hpp Source File

| 1.0.2 API documentation

matrix_factorisation.hpp
Go to the documentation of this file.
1
13 #pragma once
14
15 // Dependency:
16 #include "../glm.hpp"
17
18 #ifndef GLM_ENABLE_EXPERIMENTAL
19 # error "GLM: GLM_GTX_matrix_factorisation is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."
20 #elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
21 # pragma message("GLM: GLM_GTX_matrix_factorisation extension included")
22 #endif
23
24 /*
25 Suggestions:
26 - Move helper functions flipud and fliplr to another file: They may be helpful in more general circumstances.
27 - Implement other types of matrix factorisation, such as: QL and LQ, L(D)U, eigendecompositions, etc...
28 */
29
30 namespace glm
31 {
34
38 template <length_t C, length_t R, typename T, qualifier Q>
39 GLM_FUNC_DECL mat<C, R, T, Q> flipud(mat<C, R, T, Q> const& in);
40
44 template <length_t C, length_t R, typename T, qualifier Q>
45 GLM_FUNC_DECL mat<C, R, T, Q> fliplr(mat<C, R, T, Q> const& in);
46
52 template <length_t C, length_t R, typename T, qualifier Q>
53 GLM_FUNC_DISCARD_DECL void qr_decompose(mat<C, R, T, Q> const& in, mat<(C < R ? C : R), R, T, Q>& q, mat<C, (C < R ? C : R), T, Q>& r);
54
61 template <length_t C, length_t R, typename T, qualifier Q>
62 GLM_FUNC_DISCARD_DECL void rq_decompose(mat<C, R, T, Q> const& in, mat<(C < R ? C : R), R, T, Q>& r, mat<C, (C < R ? C : R), T, Q>& q);
63
65 }
66
67 #include "matrix_factorisation.inl"
glm::flipud
GLM_FUNC_DECL mat< C, R, T, Q > flipud(mat< C, R, T, Q > const &in)
Flips the matrix rows up and down.
glm::rq_decompose
GLM_FUNC_DISCARD_DECL void rq_decompose(mat< C, R, T, Q > const &in, mat<(C< R ? C :R), R, T, Q > &r, mat< C,(C< R ? C :R), T, Q > &q)
Performs RQ factorisation of a matrix.
glm::fliplr
GLM_FUNC_DECL mat< C, R, T, Q > fliplr(mat< C, R, T, Q > const &in)
Flips the matrix columns right and left.
glm::qr_decompose
GLM_FUNC_DISCARD_DECL void qr_decompose(mat< C, R, T, Q > const &in, mat<(C< R ? C :R), R, T, Q > &q, mat< C,(C< R ? C :R), T, Q > &r)
Performs QR factorisation of a matrix.