sparse_matrix2d.h

Go to the documentation of this file.

/***************************************************************************
 * Authors:     Javier Vargas (jvargas@cnb.csic.es)
 *
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

#ifndef SPARSE_MATRIX2D_H_
#define SPARSE_MATRIX2D_H_

#include "core/multidim_array.h"

class SparseElement
{
public:
    size_t i;
    size_t j;
    double value;
};

inline bool operator< (const SparseElement& _x, const SparseElement& _y)
{
    return ( _x.i < _y.i) || (( _x.i== _y.i) && ( _x.j< _y.j));
}


class SparseMatrix2D
{
public:
    int N=0;

    MultidimArray<int>    iIdx;
    MultidimArray<int>    jIdx;
    MultidimArray<double> values;
public:
    int nrows() const
    {
        return N;
    }

    int ncols() const
    {
        return N;
    }

    SparseMatrix2D(std::vector<SparseElement> &_elements, int _Nelements);

    void sparseMatrix2DFromVector(std::vector<SparseElement> &_elements);

    void multMv(double* x, double* y);

    void multMM(const SparseMatrix2D &X, SparseMatrix2D &Y);

    void multMMDiagonal(const MultidimArray<double> &D, SparseMatrix2D &Y);

    friend std::ostream & operator << (std::ostream &out, const SparseMatrix2D &X);

    double getElemIJ(int row, int col) const;

    void loadMatrix(const FileName &fn);
};

#endif /* SPARSE_MATRIX2D_H_ */