qr_decomposition.h

// Description: QR decomposition

#ifndef PASTELMATH_QR_DECOMPOSITION_H
#define PASTELMATH_QR_DECOMPOSITION_H

#include "pastel/math/matrix/matrix.h"

namespace Pastel
{

    template <typename Real, int M = Dynamic, int N = Dynamic>
    class QrDecomposition
    {
    public:
        QrDecomposition() = delete;
        // Using default copy constructor.
        // Using default assignment.
        // Using default destructor.

        //! A qr decomposition of the identity.
        /*!
       Preconditions:
       m >= 0
       n >= 0

       Both q and r are set to identity matrices.

       Exception safety:
       basic

       Time complexity:
       O(n^2)
       */
        explicit QrDecomposition(integer m, integer n);

        //! Decomposes the given matrix.
        /*!
       Exception safety:
       basic

       Time complexity:
       O(n^3)
       */
        QrDecomposition(const MatrixView<Real, M, N>& that);

        //! Copy-constructs from another decomposition.
        QrDecomposition(const QrDecomposition& that);

        //! Move-constructs from another decomposition.
        QrDecomposition(QrDecomposition&& that);

        //! Returns the width of the decomposed matrix.
        integer n() const;

        //! Returns the height of the decomposed matrix.
        integer m() const;

        //! Swaps two decompositions.
        /*!
       Exception safety:
       nothrow

       Time complexity:
       constant (dynamic matrices)
       n^2 (static matrices)       
       */
        void swap(
            QrDecomposition& that);

        //! Assigns from another decomposition.
        QrDecomposition& operator=(QrDecomposition that);

        //! Returns the orthogonal matrix Q^T.
        /*!
       Exception safety:
       nothrow

       Time complexity:
       constant
       */
        MatrixView<const Real, M, M> qTransposed() const;

        //! Returns the upper triangular matrix R.
        /*!
       Exception safety:
       nothrow

       Time complexity:
       constant
       */
        MatrixView<const Real, M, N> r() const;

    private:
        void decompose();

        Matrix<Real, M, M> q_;
        Matrix<Real, M, N> r_;
    };

}

#include "pastel/math/matrix/qr_decomposition/qr_decomposition.hpp"

#endif