DoubleAccessSparseMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1999-2002 Christian Jauvin
//

// 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 DoubleAccessSparseMatrix_INC
#define DoubleAccessSparseMatrix_INC

#include <plearn/base/general.h>

namespace PLearn {
using namespace std;

#define ROW_WISE -1000
#define COLUMN_WISE -2000

template <class T>
class SMat;
class PSMat;

template<class T>
class DoubleAccessSparseMatrix : public PPointable
{

protected:

  vector<map<int, T> > rows;

  vector<map<int, T> > cols;

  string name;

  int mode;

  bool double_access;

  int height;

  int width;

  T null_elem;

public:

  DoubleAccessSparseMatrix(int n_rows = 0, int n_cols = 0, string _name = "<no-name>", int _mode = ROW_WISE, bool _double_access = false, T _null_elem = 0);

  virtual ~DoubleAccessSparseMatrix() {}

  virtual void resize(int n_rows, int n_cols);
  
  virtual void clear();

  virtual void clearRow(int i, bool force_synchro_if_double_accessible); // force_synchro is expensive!

  virtual void clearCol(int j, bool force_synchro_if_double_accessible); // force_synchro is expensive!

  virtual void clearElem(int i, int j);

  virtual T get(int i, int j);

  virtual T operator()(int i, int j) { return get(i, j); }

  virtual bool exists(int i, int j);

  virtual void set(int i, int j, T value);

  virtual void incr(int i, int j, T inc);

  //virtual void operator=(SMat<T> m);

  virtual map<int, T>& getRow(int i);
  
  virtual map<int, T>& getCol(int j);

  virtual void addRow(map<int, T>& row);

  virtual void addCol(map<int, T>& col);

  virtual int size();

  virtual T sumRow(int i);

  virtual T sumCol(int j);

  virtual T* getAsCompressedVec();

  virtual void getAsMaxSizedCompressedVecs(int max_size, vector<pair<T*, int> >& vectors);

  virtual void addCompressedVec(T* compressed_vec, int n_elems);

  virtual void setCompressedVec(T* compressed_vec, int n_elems);
 
  virtual T sumOfElements();

  virtual int getHeight() const { return height; }

  virtual int getWidth() const { return width; }

  virtual void setDoubleAccessible(bool da);

  virtual bool isDoubleAccessible() { return double_access; }

  virtual void setMode(int new_mode);

  virtual int getMode() { return mode; }

  virtual void setName(string n) { name = n; }
  
  virtual string getName() { return name; }

  virtual void write(PStream& out) const;

  virtual void read(PStream& in);

  virtual T getNullElem() { return null_elem; }

  virtual string getClassName() const { return "DoubleAccesSparseMatrix"; }

};

template <class T> 
inline PStream& operator<<(PStream &out, const DoubleAccessSparseMatrix<T> &m)
{ 
  m.write(out); 
  return out;
}

template <class T> 
inline PStream& operator>>(PStream &in, DoubleAccessSparseMatrix<T> &m)
{ 
  m.read(in); 
  return in;
}

template <class T>
class SMat : public PP<DoubleAccessSparseMatrix<T> > //: public PP<PPointableDoubleAccessSparseMatrix<T> >
{

public:

  SMat(int n_rows = 0, int n_cols = 0, string name = "<no-name>", int mode = ROW_WISE, bool double_access = false) : PP<DoubleAccessSparseMatrix<T> >(new DoubleAccessSparseMatrix<T>(n_rows, n_cols, name, mode, double_access)) {}

  SMat(DoubleAccessSparseMatrix<T>* p) : PP<DoubleAccessSparseMatrix<T> >(p) {}

  DoubleAccessSparseMatrix<T>* getPtr() { return ptr; }

};

} // end of namespace PLearn

#include "DoubleAccessSparseMatrix_impl.h"

#endif

---