CRNSquareMatrixDouble.h

Go to the documentation of this file.

/* Copyright 2008-2016 INSA-Lyon, ENS-Lyon
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNSquareMatrixDouble.h
 * \author Jean DUONG, Yann LEYDIER
 */

#ifndef CRNSQUAREMATRIXDOUBLE_HEADER
#define CRNSQUAREMATRIXDOUBLE_HEADER

#include <CRNMath/CRNMatrixDouble.h>
#include <map>

namespace crn
{
    /****************************************************************************/
    class SquareMatrixDouble: public MatrixDouble
    {   
        public:
            SquareMatrixDouble(size_t size, double value = 0.0) : MatrixDouble(size, size, value) {}
            SquareMatrixDouble(const Matrix<double> &m);
            SquareMatrixDouble(Matrix<double> &&m);
            SquareMatrixDouble(const std::vector<std::vector<double>> &m);
            SquareMatrixDouble(std::vector<std::vector<double>> &&m);
            SquareMatrixDouble(const SquareMatrixDouble &) = default;
            SquareMatrixDouble(SquareMatrixDouble &&) = default;
            
            virtual ~SquareMatrixDouble() override = default;
            
            SquareMatrixDouble& operator=(const SquareMatrixDouble &) = default;
            SquareMatrixDouble& operator=(SquareMatrixDouble &&) = default;
            
            /*********************************************************************/
            /* Special matrix constructors                                       */
            /*********************************************************************/
            static SquareMatrixDouble NewGaussian(double sigma);
            static SquareMatrixDouble NewGaussianSobelX(double sigma);
            static SquareMatrixDouble NewGaussianSobelY(double sigma);
            static SquareMatrixDouble NewIdentity(size_t n);

            bool IsUpperTriangular() const;
            bool IsLowerTriangular() const;
            bool IsUpperHessenberg() const;
            bool IsDiagonal() const;
            double Trace() const;
            double DiagonalProduct() const;
            virtual SquareMatrixDouble& Transpose() override;
            SquareMatrixDouble MakeMinor(size_t r, size_t c) const;
            double Cofactor(size_t r, size_t c) const;
            double Determinant() const;
            SquareMatrixDouble MakeInverse() const;
            SquareMatrixDouble MakeGaussJordanInverse() const;
            SquareMatrixDouble MakeCholesky() const;
            SquareMatrixDouble MakeUpperHessenberg() const;

            std::multimap<double, MatrixDouble> MakeSpectralEigensystem() const;
            std::multimap<double, MatrixDouble> MakeJacobiEigensystem(size_t MaxIteration = 100) const;
            std::multimap<double, MatrixDouble> MakeTQLIEigensystem(size_t maxiter = 30) const;
            std::vector<std::complex<double>> Eigenvalues(size_t max_iter = 30) const;

        private:
            void tred2(SquareMatrixDouble &z, std::vector<double> &diag, std::vector<double> &offdiag) const;
            virtual std::string getClassName() const override { return "SquareMatrixDouble"; }

            CRN_DECLARE_CLASS_CONSTRUCTOR(SquareMatrixDouble)
        public:
            SquareMatrixDouble(xml::Element &el):MatrixDouble(1, 1) { Deserialize(el); }
    };
    template<> struct IsSerializable<SquareMatrixDouble> : public std::true_type {};
    template<> struct IsClonable<SquareMatrixDouble> : public std::true_type {};

    template<> struct TypeInfo<SquareMatrixDouble>
    {
        using SumType = SquareMatrixDouble;
        using DiffType = SquareMatrixDouble;
        using DecimalType = SquareMatrixDouble;
    };

}

#include <CRNMath/CRNSquareMatrixDoublePtr.h>
#endif