spmh.h

Go to the documentation of this file.

/* $Header: /var/cvs/mbdyn/mbdyn/mbdyn-1.0/libraries/libmbmath/spmh.h,v 1.32 2017/01/12 14:43:54 masarati Exp $ */
/*
 * MBDyn (C) is a multibody analysis code. 
 * http://www.mbdyn.org
 *
 * Copyright (C) 2003-2017
 * 
 * This code is a partial merge of HmFe and MBDyn.
 *
 * Pierangelo Masarati  <masarati@aero.polimi.it>
 * Paolo Mantegazza     <mantegazza@aero.polimi.it>
 *
 * Dipartimento di Ingegneria Aerospaziale - Politecnico di Milano
 * via La Masa, 34 - 20156 Milano, Italy
 * http://www.aero.polimi.it
 *
 * Changing this copyright notice is forbidden.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation (version 2 of the License).
 * 
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef SPMH_H
#define SPMH_H

#include <vector>

#include "myassert.h"
#include "solman.h"

/* Sparse Matrix */
class SparseMatrixHandler : public MatrixHandler {
protected:
        integer NRows;
        integer NCols;
        integer NZ;

#ifdef DEBUG
        void IsValid(void) const {
                NO_OP;
        };
#endif /* DEBUG */

public:

        struct SparseMatrixElement_base {
                integer iRow;
                integer iCol;

                SparseMatrixElement_base(void)
                        : iRow(0), iCol(0) { NO_OP; };
                SparseMatrixElement_base(integer iRow, integer iCol)
                        : iRow(iRow), iCol(iCol) { NO_OP; };
                virtual ~SparseMatrixElement_base(void) { NO_OP; };
                bool operator == (const SparseMatrixElement_base& op) const
                        { return iRow == op.iRow && iCol == op.iCol; };
                bool operator != (const SparseMatrixElement_base& op) const
                        { return iRow != op.iRow || iCol != op.iCol; };
        };

        // copy
        struct SparseMatrixElement : public SparseMatrixElement_base {
                doublereal dCoef;

                SparseMatrixElement(void)
                        : dCoef(0.) {};
                SparseMatrixElement(integer iRow, integer iCol, const doublereal& dCoef)
                        : SparseMatrixElement_base(iRow, iCol), dCoef(dCoef) { NO_OP; };
        };

        // reference
        struct SparseMatrixElementRef : public SparseMatrixElement_base {
                doublereal& dCoef;

                SparseMatrixElementRef(integer iRow, integer iCol, doublereal& dCoef)
                        : SparseMatrixElement_base(iRow, iCol), dCoef(dCoef) { NO_OP; };
private:
                // do not use
                SparseMatrixElementRef(void);
        };

        // const reference
        struct SparseMatrixElementConstRef : public SparseMatrixElement_base {
                const doublereal& dCoef;

                SparseMatrixElementConstRef(void)
                        : dCoef(::Zero1) {};
                SparseMatrixElementConstRef(integer iRow, integer iCol, const doublereal& dCoef)
                        : SparseMatrixElement_base(iRow, iCol), dCoef(dCoef) { NO_OP; };
        };

public:
        const integer Nz() const {
                return NZ;
        };
        
        /* FIXME: always square? */
        SparseMatrixHandler(const integer &n, const integer &nn = 0);

        virtual ~SparseMatrixHandler(void);

        integer iGetNumRows(void) const {
                return NRows;
        };

        integer iGetNumCols(void) const {
                return NCols;
        };

        virtual
        integer MakeCompressedColumnForm(doublereal *const Ax,
                        integer *const Ai, integer *const Ap,
                        int offset = 0) const = 0;

        virtual
        integer MakeCompressedColumnForm(std::vector<doublereal>& Ax,
                        std::vector<integer>& Ai, std::vector<integer>& Ap,
                        int offset = 0) const = 0;

        virtual
        integer MakeIndexForm(doublereal *const Ax,
                        integer *const Arow, integer *const Acol,
                        integer *const AcolSt,
                        int offset = 0) const = 0;

        virtual
        integer MakeIndexForm(std::vector<doublereal>& Ax,
                        std::vector<integer>& Arow, std::vector<integer>& Acol,
                        std::vector<integer>& AcolSt,
                        int offset = 0) const = 0;

        /* Estrae una colonna da una matrice */
        virtual VectorHandler& GetCol(integer icol,
                        VectorHandler& out) const = 0;
};

/* Sparse Matrix in compact form */
class CompactSparseMatrixHandler : public SparseMatrixHandler {
protected:
        bool bMatDuplicate;
        std::vector<doublereal>& Ax;
        const std::vector<integer>& Ai;
        const std::vector<integer>& Ap;

#ifdef DEBUG
        void IsValid(void) const {
                NO_OP;
        };
#endif /* DEBUG */

public:
        CompactSparseMatrixHandler(const integer &n, const integer &nn,
                        std::vector<doublereal>& x,
                        const std::vector<integer>& i,
                        const std::vector<integer>& p);

        virtual ~CompactSparseMatrixHandler();

        /* used by MultiThreadDataManager to duplicate the storage array
         * while preserving the CC indices */
        virtual CompactSparseMatrixHandler *Copy(void) const = 0;

        /* used to sum CC matrices with identical indices */
        void AddUnchecked(const CompactSparseMatrixHandler& m);

        /* Restituisce un puntatore all'array di reali della matrice */
        virtual inline const doublereal* pdGetMat(void) const {
                return &Ax[0];
        };

public:
        void Reset(void);
        
        virtual
        integer MakeCompressedColumnForm(doublereal *const Ax,
                        integer *const Ai, integer *const Ap,
                        int offset = 0) const;

        virtual
        integer MakeCompressedColumnForm(std::vector<doublereal>& Ax,
                        std::vector<integer>& Ai, std::vector<integer>& Ap,
                        int offset = 0) const;

        virtual
        integer MakeIndexForm(doublereal *const Ax,
                        integer *const Arow, integer *const Acol,
                        integer *const AcolSt,
                        int offset = 0) const;

        virtual
        integer MakeIndexForm(std::vector<doublereal>& Ax,
                        std::vector<integer>& Arow, std::vector<integer>& Acol,
                        std::vector<integer>& AcolSt,
                        int offset = 0) const;
};

/* Sparse Matrix in compact form */
template <int off>
class CompactSparseMatrixHandler_tpl : public CompactSparseMatrixHandler {
public:
        CompactSparseMatrixHandler_tpl(const integer &n, const integer &nn,
                        std::vector<doublereal>& x,
                        const std::vector<integer>& i,
                        const std::vector<integer>& p);
        virtual ~CompactSparseMatrixHandler_tpl(void);

        class const_iterator {
        private:
                const CompactSparseMatrixHandler_tpl<off>& m;
                mutable integer i_idx;
                mutable SparseMatrixHandler::SparseMatrixElement elem;

        protected:
                void reset(bool is_end = false);

        public:
                const_iterator(const CompactSparseMatrixHandler_tpl<off>& m, bool is_end = false);
                ~const_iterator(void);
                const CompactSparseMatrixHandler_tpl<off>::const_iterator& operator ++ (void) const;
                const SparseMatrixHandler::SparseMatrixElement* operator -> (void);
                const SparseMatrixHandler::SparseMatrixElement& operator * (void);
                bool operator == (const CompactSparseMatrixHandler_tpl<off>::const_iterator& op) const;
                bool operator != (const CompactSparseMatrixHandler_tpl<off>::const_iterator& op) const;
        };

protected:
        /* Matrix Matrix product */
        MatrixHandler&
        MatMatMul_base(void (MatrixHandler::*op)(integer iRow, integer iCol,
                                const doublereal& dCoef),
                        MatrixHandler& out, const MatrixHandler& in) const;
        MatrixHandler&
        MatTMatMul_base(void (MatrixHandler::*op)(integer iRow, integer iCol,
                                const doublereal& dCoef),
                        MatrixHandler& out, const MatrixHandler& in) const;

        /* Matrix Vector product */
        virtual VectorHandler&
        MatVecMul_base(void (VectorHandler::*op)(integer iRow,
                                const doublereal& dCoef),
                        VectorHandler& out, const VectorHandler& in) const;
        virtual VectorHandler&
        MatTVecMul_base(void (VectorHandler::*op)(integer iRow,
                                const doublereal& dCoef),
                        VectorHandler& out, const VectorHandler& in) const;

protected:
        CompactSparseMatrixHandler_tpl<off>::const_iterator m_end;

public:
        CompactSparseMatrixHandler_tpl<off>::const_iterator begin(void) const {
                return CompactSparseMatrixHandler_tpl<off>::const_iterator(*this);
        };

        const CompactSparseMatrixHandler_tpl<off>::const_iterator& end(void) const {
                return m_end;
        };
};

#endif /* SPMH_H */