/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QGENERICMATRIX_H

#define QGENERICMATRIX_H

#include <QtCore/qmetatype.h>

#include <QtCore/qdebug.h>

#include <QtCore/qdatastream.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

template <int N, int M, typename T>

class QGenericMatrix

{

public:

    QGenericMatrix();

    QGenericMatrix(const QGenericMatrix<N, M, T>& other);

    explicit QGenericMatrix(const T *values);

    const T& operator()(int row, int column) const;

    T& operator()(int row, int column);

    bool isIdentity() const;

    void setToIdentity();

    void fill(T value);

    QGenericMatrix<M, N, T> transposed() const;

    QGenericMatrix<N, M, T>& operator+=(const QGenericMatrix<N, M, T>& other);

    QGenericMatrix<N, M, T>& operator-=(const QGenericMatrix<N, M, T>& other);

    QGenericMatrix<N, M, T>& operator*=(T factor);

    QGenericMatrix<N, M, T>& operator/=(T divisor);

    bool operator==(const QGenericMatrix<N, M, T>& other) const;

    bool operator!=(const QGenericMatrix<N, M, T>& other) const;

    void copyDataTo(T *values) const;

    T *data() { return m[0]; }

    const T *data() const { return m[0]; }

    const T *constData() const { return m[0]; }

#if !defined(Q_NO_TEMPLATE_FRIENDS)

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator+(const QGenericMatrix<NN, MM, TT>& m1, const QGenericMatrix<NN, MM, TT>& m2);

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator-(const QGenericMatrix<NN, MM, TT>& m1, const QGenericMatrix<NN, MM, TT>& m2);

    template<int NN, int M1, int M2, typename TT>

    friend QGenericMatrix<M1, M2, TT> operator*(const QGenericMatrix<NN, M2, TT>& m1, const QGenericMatrix<M1, NN, TT>& m2);

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator-(const QGenericMatrix<NN, MM, TT>& matrix);

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator*(TT factor, const QGenericMatrix<NN, MM, TT>& matrix);

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator*(const QGenericMatrix<NN, MM, TT>& matrix, TT factor);

    template<int NN, int MM, typename TT>

    friend QGenericMatrix<NN, MM, TT> operator/(const QGenericMatrix<NN, MM, TT>& matrix, TT divisor);

private:

#endif

    T m[N][M];    // Column-major order to match OpenGL.

    QGenericMatrix(int) {}       // Construct without initializing identity matrix.

#if !defined(Q_NO_TEMPLATE_FRIENDS)

    template <int NN, int MM, typename TT>

    friend class QGenericMatrix;

#endif

};

template <int N, int M, typename T>

Q_INLINE_TEMPLATE QGenericMatrix<N, M, T>::QGenericMatrix()

{

    setToIdentity();

}

template <int N, int M, typename T>

Q_INLINE_TEMPLATE QGenericMatrix<N, M, T>::QGenericMatrix(const QGenericMatrix<N, M, T>& other)

{

    for (int col = 0; col < N; ++col)

        for (int row = 0; row < M; ++row)

            m[col][row] = other.m[col][row];

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T>::QGenericMatrix(const T *values)

{

    for (int col = 0; col < N; ++col)

        for (int row = 0; row < M; ++row)

            m[col][row] = values[row * N + col];

}

template <int N, int M, typename T>

Q_INLINE_TEMPLATE const T& QGenericMatrix<N, M, T>::operator()(int row, int column) const

{

    Q_ASSERT(row >= 0 && row < M && column >= 0 && column < N);

    return m[column][row];

}

template <int N, int M, typename T>

Q_INLINE_TEMPLATE T& QGenericMatrix<N, M, T>::operator()(int row, int column)

{

    Q_ASSERT(row >= 0 && row < M && column >= 0 && column < N);

    return m[column][row];

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE bool QGenericMatrix<N, M, T>::isIdentity() const

{

    for (int col = 0; col < N; ++col) {

        for (int row = 0; row < M; ++row) {

            if (row == col) {

                if (m[col][row] != 1.0f)

                    return false;

            } else {

                if (m[col][row] != 0.0f)

                    return false;

            }

        }

    }

    return true;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE void QGenericMatrix<N, M, T>::setToIdentity()

{

    for (int col = 0; col < N; ++col) {

        for (int row = 0; row < M; ++row) {

            if (row == col)

                m[col][row] = 1.0f;

            else

                m[col][row] = 0.0f;

        }

    }

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE void QGenericMatrix<N, M, T>::fill(T value)

{

    for (int col = 0; col < N; ++col)

        for (int row = 0; row < M; ++row)

            m[col][row] = value;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<M, N, T> QGenericMatrix<N, M, T>::transposed() const

{

    QGenericMatrix<M, N, T> result(1);

    for (int row = 0; row < M; ++row)

        for (int col = 0; col < N; ++col)

            result.m[row][col] = m[col][row];

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T>& QGenericMatrix<N, M, T>::operator+=(const QGenericMatrix<N, M, T>& other)

{

    for (int index = 0; index < N * M; ++index)

        m[0][index] += other.m[0][index];

    return *this;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T>& QGenericMatrix<N, M, T>::operator-=(const QGenericMatrix<N, M, T>& other)

{

    for (int index = 0; index < N * M; ++index)

        m[0][index] -= other.m[0][index];

    return *this;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T>& QGenericMatrix<N, M, T>::operator*=(T factor)

{

    for (int index = 0; index < N * M; ++index)

        m[0][index] *= factor;

    return *this;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE bool QGenericMatrix<N, M, T>::operator==(const QGenericMatrix<N, M, T>& other) const

{

    for (int index = 0; index < N * M; ++index) {

        if (m[0][index] != other.m[0][index])

            return false;

    }

    return true;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE bool QGenericMatrix<N, M, T>::operator!=(const QGenericMatrix<N, M, T>& other) const

{

    for (int index = 0; index < N * M; ++index) {

        if (m[0][index] != other.m[0][index])

            return true;

    }

    return false;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T>& QGenericMatrix<N, M, T>::operator/=(T divisor)

{

    for (int index = 0; index < N * M; ++index)

        m[0][index] /= divisor;

    return *this;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator+(const QGenericMatrix<N, M, T>& m1, const QGenericMatrix<N, M, T>& m2)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = m1.m[0][index] + m2.m[0][index];

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator-(const QGenericMatrix<N, M, T>& m1, const QGenericMatrix<N, M, T>& m2)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = m1.m[0][index] - m2.m[0][index];

    return result;

}

template <int N, int M1, int M2, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<M1, M2, T> operator*(const QGenericMatrix<N, M2, T>& m1, const QGenericMatrix<M1, N, T>& m2)

{

    QGenericMatrix<M1, M2, T> result(1);

    for (int row = 0; row < M2; ++row) {

        for (int col = 0; col < M1; ++col) {

            T sum(0.0f);

            for (int j = 0; j < N; ++j)

                sum += m1.m[j][row] * m2.m[col][j];

            result.m[col][row] = sum;

        }

    }

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator-(const QGenericMatrix<N, M, T>& matrix)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = -matrix.m[0][index];

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator*(T factor, const QGenericMatrix<N, M, T>& matrix)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = matrix.m[0][index] * factor;

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator*(const QGenericMatrix<N, M, T>& matrix, T factor)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = matrix.m[0][index] * factor;

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE QGenericMatrix<N, M, T> operator/(const QGenericMatrix<N, M, T>& matrix, T divisor)

{

    QGenericMatrix<N, M, T> result(1);

    for (int index = 0; index < N * M; ++index)

        result.m[0][index] = matrix.m[0][index] / divisor;

    return result;

}

template <int N, int M, typename T>

Q_OUTOFLINE_TEMPLATE void QGenericMatrix<N, M, T>::copyDataTo(T *values) const

{

    for (int col = 0; col < N; ++col)

        for (int row = 0; row < M; ++row)

            values[row * N + col] = T(m[col][row]);

}

// Define aliases for the useful variants of QGenericMatrix.

typedef QGenericMatrix<2, 2, qreal> QMatrix2x2;

typedef QGenericMatrix<2, 3, qreal> QMatrix2x3;

typedef QGenericMatrix<2, 4, qreal> QMatrix2x4;

typedef QGenericMatrix<3, 2, qreal> QMatrix3x2;

typedef QGenericMatrix<3, 3, qreal> QMatrix3x3;

typedef QGenericMatrix<3, 4, qreal> QMatrix3x4;

typedef QGenericMatrix<4, 2, qreal> QMatrix4x2;

typedef QGenericMatrix<4, 3, qreal> QMatrix4x3;

#ifndef QT_NO_DEBUG_STREAM

template <int N, int M, typename T>

QDebug operator<<(QDebug dbg, const QGenericMatrix<N, M, T> &m)

{

    dbg.nospace() << "QGenericMatrix<" << N << ", " << M

        << ", " << QTypeInfo<T>::name()

        << ">(" << endl << qSetFieldWidth(10);

    for (int row = 0; row < M; ++row) {

        for (int col = 0; col < N; ++col)

            dbg << m(row, col);

        dbg << endl;

    }

    dbg << qSetFieldWidth(0) << ')';

    return dbg.space();

}

#endif

#ifndef QT_NO_DATASTREAM

template <int N, int M, typename T>

QDataStream &operator<<(QDataStream &stream, const QGenericMatrix<N, M, T> &matrix)

{

    for (int row = 0; row < M; ++row)

        for (int col = 0; col < N; ++col)

            stream << double(matrix(row, col));

    return stream;

}

template <int N, int M, typename T>

QDataStream &operator>>(QDataStream &stream, QGenericMatrix<N, M, T> &matrix)

{

    double x;

    for (int row = 0; row < M; ++row) {

        for (int col = 0; col < N; ++col) {

            stream >> x;

            matrix(row, col) = T(x);

        }

    }

    return stream;

}

#endif

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QMatrix2x2)

Q_DECLARE_METATYPE(QMatrix2x3)

Q_DECLARE_METATYPE(QMatrix2x4)

Q_DECLARE_METATYPE(QMatrix3x2)

Q_DECLARE_METATYPE(QMatrix3x3)

Q_DECLARE_METATYPE(QMatrix3x4)

Q_DECLARE_METATYPE(QMatrix4x2)

Q_DECLARE_METATYPE(QMatrix4x3)

QT_END_HEADER

#endif