SparseMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1999-2002 Yoshua Bengio
//

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

#ifndef SPARSEMATRIX
#define SPARSEMATRIX

#include "Mat.h"
#include <plearn/base/Array.h>

namespace PLearn {
using namespace std;


class SparseMatrix {
public:
  int n_rows;  
  Vec beginRow;
  Vec endRow;
  Vec row;
  Vec values;

  int length() const { return n_rows; }
  int width() const { return beginRow.length(); }

  SparseMatrix() {}
  SparseMatrix(int nbrows,int n_columns,int n_non_zero) 
    : n_rows(nbrows), beginRow(n_columns), endRow(n_columns), 
      row(n_non_zero), values(n_non_zero) {}
  SparseMatrix(Vec bRow, Vec eRow, Vec Row, Vec Values, int nbrows)
    : n_rows(nbrows), beginRow(bRow), endRow(eRow),
      row(Row), values(Values) {}

  SparseMatrix(Mat m);

  SparseMatrix(string filename) { loadFortran(filename.c_str()); }

  void resize(int nbrows,int n_columns,int n_non_zero);

  void loadFortran(const char* filename);
  void saveFortran(const char* filename);

  Mat toMat();

  void product(const Vec& x, Vec& y);
  void diag(Vec& d);
  void diagonalOfSquare(Vec& d); 
  real dotRow(int i, Vec v);
  real dotColumn(int j, Vec v);
};

SparseMatrix operator+(const SparseMatrix& A, const SparseMatrix& B);
SparseMatrix add(Array<SparseMatrix>& matrices);


} // end of namespace PLearn

#endif

---