CVarMatrix.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// ACF includes
#include <istd/istd.h>
#include <istd/TArray.h>
#include <istd/CIndex2d.h>
 
 
namespace iser
{
       class IArchive;
}
 
 
namespace imath
{
 
 
class CVarVector;
 
 
class CVarMatrix: public istd::TArray<double, 2>
{
public:
       typedef istd::TArray<double, 2> BaseClass;
 
       CVarMatrix();
 
       CVarMatrix(const CVarMatrix& matrix);
 
       explicit CVarMatrix(istd::CIndex2d size);
 
       explicit CVarMatrix(const CVarVector& vector, bool isTransposed = false);
 
       void Clear();
 
       void InitToIdentity(int size);
 
       /*
              Get a matrix element at the given position.
       */
       double GetElementAt(int x, int y) const;
 
       /*
              Get the reference of a matrix element at the given position.
       */
       double& GetElementRef(int x, int y);
 
       double GetMaxElement() const;
 
       /*
              Get minimal element.
       */
       double GetMinElement() const;
 
       void GetNegated(CVarMatrix& result);
 
       void GetAdded(const CVarMatrix& matrix, CVarMatrix& result) const;
 
       void GetSubstracted(const CVarMatrix& matrix, CVarMatrix& result) const;
 
       void GetMultiplied(const CVarMatrix& matrix, CVarMatrix& result) const;
 
       CVarMatrix GetMultiplied(const CVarMatrix& matrix) const;
 
       void GetScaled(double value, CVarMatrix& result) const;
 
       void GetTransposed(CVarMatrix& result) const;
 
       CVarMatrix GetTransposed() const;
 
       void Transpose();
 
       double GetTrace() const;
 
       /*
              Get square of euclidean norm.
       */
       double GetFrobeniusNorm2() const;
 
       /*
              Get euclidean norm.
       */
       double GetFrobeniusNorm() const;
 
       bool GetTriangleDecomposed(
                            CVarMatrix& result,
                            CVarMatrix* matrix2Ptr = NULL,
                            int maxColumns = -1,
                            double minHhNorm = I_BIG_EPSILON) const;
 
       bool TransformR(int firstPartWidth);
 
       bool GetSolvedTriangle(const CVarMatrix& vector, CVarMatrix& result, double accuracy = I_BIG_EPSILON) const;
 
       bool GetSolvedLSP(const CVarMatrix& vector, CVarMatrix& result, double minHhNorm = I_BIG_EPSILON) const;
 
       bool GetDecompositionQDQ(CVarMatrix& matrixQ, CVarVector& diagonalD, double tolerance = I_BIG_EPSILON, int maxIterations = 100) const;
 
       void GetColumnVector(int columnIndex, CVarVector& result);
       void GetRowVector(int rowIndex, CVarVector& result);
 
       bool Serialize(iser::IArchive& archive);
 
       // operators
       CVarMatrix operator+(const CVarMatrix& b) const;
       CVarMatrix operator-(const CVarMatrix& b) const;
       CVarMatrix operator-();
       CVarMatrix operator*(const CVarMatrix& b) const;
       CVarMatrix operator*(double value) const;
 
       bool operator==(const CVarMatrix& matrix) const;
       bool operator!=(const CVarMatrix& matrix) const;
 
       // static methods
       static void SolveRobustLSP(CVarMatrix matrixA, CVarMatrix& matrixY, CVarMatrix& matrixX, double minHhNorm = I_BIG_EPSILON);
};
 
 
// inline methods
 
inline CVarMatrix CVarMatrix::GetMultiplied(const CVarMatrix& matrix) const
{
       CVarMatrix result;
 
       GetMultiplied(matrix, result);
 
       return result;
}
 
 
inline void CVarMatrix::Transpose()
{
       CVarMatrix result;
 
       GetTransposed(result);
 
       *this=result;
}
 
 
inline CVarMatrix CVarMatrix::operator+(const CVarMatrix& matrix) const
{
       CVarMatrix result;
 
       GetAdded(matrix, result);
 
       return result;
}
 
 
inline CVarMatrix CVarMatrix::operator-(const CVarMatrix& matrix) const
{
       CVarMatrix result;
 
       GetSubstracted(matrix, result);
 
       return result;
}
 
 
inline CVarMatrix CVarMatrix::operator-()
{
       CVarMatrix result;
 
       GetNegated(result);
 
       return result;
}
 
 
inline CVarMatrix CVarMatrix::operator*(const CVarMatrix& matrix) const
{
       CVarMatrix result;
 
       GetMultiplied(matrix, result);
 
       return result;
}
 
 
inline CVarMatrix CVarMatrix::operator*(double value) const
{
       CVarMatrix result;
 
       GetScaled(value, result);
 
       return result;
}
 
 
inline CVarMatrix operator*(double value, const imath::CVarMatrix& matrix)
{
       return matrix * value;
}
 
 
} // namespace imath