Files
pilotclient/src/blackmisc/mathmatrixbase.h

379 lines
9.7 KiB
C++

/* Copyright (C) 2013 VATSIM Community / contributors
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef BLACKMISC_MATHMATRIXBASE_H
#define BLACKMISC_MATHMATRIXBASE_H
#include "blackmisc/valueobject.h"
#include "blackmisc/mathvector3dbase.h"
#include <QGenericMatrix>
#include <QDBusMetaType>
namespace BlackMisc
{
namespace Math
{
/*!
* \brief Base functionality of a matrix
*/
template<class ImplMatrix, int Rows, int Columns> class CMatrixBase : public BlackMisc::CValueObject
{
private:
/*!
* \brief Easy access to derived class (CRTP template parameter)
* \return
*/
ImplMatrix const *derived() const
{
return static_cast<ImplMatrix const *>(this);
}
/*!
* \brief Easy access to derived class (CRTP template parameter)
* \return
*/
ImplMatrix *derived()
{
return static_cast<ImplMatrix *>(this);
}
protected:
// no bug, Qt expects columns rows
QGenericMatrix<Columns, Rows, double> m_matrix; //!< backing data
/*!
* \brief Conversion to string
* \param i18n
* \return
*/
QString convertToQString(bool i18n = false) const;
/*!
* \copydoc CValueObject::getMetaTypeId
*/
virtual int getMetaTypeId() const;
/*!
* \copydoc CValueObject::isA
*/
virtual bool isA(int metaTypeId) const;
/*!
* \copydoc CValueObject::compareImpl
*/
virtual int compareImpl(const CValueObject &other) const;
/*!
* \brief Stream to DBus
* \param argument
*/
virtual void marshallToDbus(QDBusArgument &argument) const;
/*!
* \brief Stream from DBus
* \param argument
*/
virtual void unmarshallFromDbus(const QDBusArgument &argument);
public:
/*!
* \brief Default constructor
*/
CMatrixBase() : m_matrix() {}
/*!
* \brief Fill with value
* \param fillValue
*/
explicit CMatrixBase(double fillValue) : m_matrix()
{
this->fill(fillValue);
}
/*!
* \brief Virtual destructor
*/
virtual ~CMatrixBase() {}
/*!
* \brief List of values
* \return
*/
QList<double> toList() const;
/*!
* \brief Value hash
* \return
*/
virtual uint getValueHash() const;
/*!
* \brief List of values
* \return
*/
void fromList(const QList<double> &list);
/*!
* \brief Equal operator ==
* \param other
* \return
*/
bool operator ==(const ImplMatrix &other) const
{
if (this == &other) return true;
return this->m_matrix == other.m_matrix;
}
/*!
* \brief Unequal operator !=
* \param other
* \return
*/
bool operator !=(const ImplMatrix &other) const
{
return !((*this) == other);
}
/*!
* \brief Operator *=
* \param factor
* \return
*/
CMatrixBase &operator *=(double factor)
{
this->m_matrix *= factor;
return *this;
}
/*!
* \brief Operator *
* \param factor
* \return
*/
ImplMatrix operator *(double factor) const
{
ImplMatrix m = *derived();
m *= factor;
return m;
}
/*!
* \brief Operator to support commutative scalar multiplication
* \param factor
* \param other
* \return
*/
friend ImplMatrix operator *(double factor, const ImplMatrix &other)
{
return other * factor;
}
/*!
* \brief Operator /=
* \param factor
* \return
*/
CMatrixBase &operator /=(double factor)
{
this->m_matrix /= factor;
return *this;
}
/*!
* \brief Operator /
* \param factor
* \return
*/
ImplMatrix operator /(double factor) const
{
ImplMatrix m = *derived();
m /= factor;
return m;
}
/*!
* \brief Operator +=
* \param other
* \return
*/
CMatrixBase &operator +=(const CMatrixBase &other)
{
this->m_matrix += other.m_matrix;
return *this;
}
/*!
* \brief Operator +
* \param other
* \return
*/
ImplMatrix operator +(const ImplMatrix &other) const
{
ImplMatrix m = *derived();
m += other;
return m;
}
/*!
* \brief Operator -=
* \param other
* \return
*/
CMatrixBase &operator -=(const CMatrixBase &other)
{
this->m_matrix -= other.m_matrix;
return *this;
}
/*!
* \brief Operator -
* \param other
* \return
*/
ImplMatrix operator -(const ImplMatrix &other) const
{
ImplMatrix m = *derived();
m -= other;
return m;
}
/*!
* \brief Is identity matrix?
* \return
*/
bool isIdentity() const
{
return this->m_matrix.isIdentity();
}
/*!
* \brief Is identity matrix? Epsilon considered.
* \return
*/
bool isIdentityEpsilon() const
{
ImplMatrix m = *derived();
m.round();
return m.isIdentity();
}
/*!
* \brief Set as identity matrix
* \return
*/
void setToIdentity()
{
this->m_matrix.setToIdentity();
}
/*!
* \brief All values to zero
*/
void setZero() { this->m_matrix.fill(0.0); }
/*!
* \brief Is zero
* \return
*/
bool isZero() const;
/*!
* \brief Each cell gets a unique index (used primarily for testing)
*/
void setCellIndex();
/*!
* \brief Is identity matrix? Epsilon considered.
* \return
*/
bool isZeroEpsilon() const
{
ImplMatrix m = *derived();
m.round();
return m.isZero();
}
/*!
* \brief Set all elements the same
* \param value
*/
void fill(double value) { this->m_matrix.fill(value); }
/*!
* \brief Round all values
*/
void round();
/*!
* \brief Return a rounded matrix
* \return
*/
ImplMatrix roundedMatrix() const
{
ImplMatrix m = *derived();
m.round();
return m;
}
/*!
* \brief Get element
* \param row
* \param column
* \return
*/
double getElement(int row, int column) const;
/*!
* \brief Get element
* \param row
* \param column
* \param value
*/
void setElement(int row, int column, double value);
/*!
* \brief Get element by operator () modifying
* \param row
* \param column
* \return
*/
double &operator()(int row, int column)
{
this->checkRange(row, column);
return this->m_matrix(row, column);
}
/*!
* \brief Get element by operator () read only
* \param row
* \param column
* \return
*/
double operator()(int row, int column) const
{
return this->getElement(row, column);
}
/*!
* \brief Register metadata
*/
static void registerMetadata();
private:
/*!
* \brief Check range of row / column
* \param row
* \param column
* \throws std::range_error if index out of bounds
*/
void checkRange(int row, int column) const;
};
} // namespace
} // namespace
#endif // guard