ForwardVMatrix.h

Go to the documentation of this file.

// ForwardVMatrix.h
// Copyright (C) 2002 Pascal Vincent
//

// 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


 

/* *******************************************************      
   * $Id: ForwardVMatrix.h,v 1.8 2004/05/14 02:13:41 tihocan Exp $
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef ForwardVMatrix_INC
#define ForwardVMatrix_INC

#include "VMat.h"

namespace PLearn {
using namespace std;


class ForwardVMatrix: public VMatrix
{
  typedef VMatrix inherited;

protected:
  VMat vm; // the underlying vmatrix to which all calls will be forwarded

public:

  ForwardVMatrix();
  ForwardVMatrix(VMat vm);

  PLEARN_DECLARE_OBJECT(ForwardVMatrix);
  static void declareOptions(OptionList &ol);

  virtual void build();

  void setVMat(VMat the_vm);

  virtual string getValString(int col, real val) const;
  
  virtual real getStringVal(int col, const string & str) const;

  virtual string getString(int row,int col) const;

  map<string,real> getStringMapping(int col) const;

  // Overridden from VMatrix.h to forward to the underlying VMat.
  virtual const map<string,real>& getStringToRealMapping(int col) const;
  virtual const map<real,string>& getRealToStringMapping(int col) const;

  virtual void computeStats(); 

  // default version calls savePMAT
  virtual void save(const string& filename) const;

  virtual void savePMAT(const string& pmatfile) const;
  virtual void saveDMAT(const string& dmatdir) const;
  virtual void saveAMAT(const string& amatfile) const;

  virtual real get(int i, int j) const; 

  virtual void put(int i, int j, real value); 

  virtual void getSubRow(int i, int j, Vec v) const; 

  virtual void putSubRow(int i, int j, Vec v);
    
  virtual void appendRow(Vec v);

  virtual void getRow(int i, Vec v) const; 
  virtual void putRow(int i, Vec v);
  virtual void fill(real value);
  virtual void getMat(int i, int j, Mat m) const; 
  virtual void putMat(int i, int j, Mat m); 

  virtual void getColumn(int i, Vec v) const;

  virtual Mat toMat() const;

  virtual void compacify();

  virtual void reset_dimensions();

  virtual VMat subMat(int i, int j, int l, int w);

  virtual real dot(int i1, int i2, int inputsize) const;

  virtual real dot(int i, const Vec& v) const;

  virtual void getRow(int i, VarArray& inputs) const;

  virtual void oldwrite(ostream& out) const;
  virtual void oldread(istream& in);

  void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);


  virtual void evaluateKernel(Ker ker, int v1_startcol, int v1_ncols, 
                              const Vec& v2, const Vec& result, int startrow=0, int nrows=-1) const;

  virtual real evaluateKernelSum(Ker ker, int v1_startcol, int v1_ncols, 
                                 const Vec& v2, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;

  virtual real evaluateKernelWeightedTargetSum(Ker ker, int v1_startcol, int v1_ncols, const Vec& v2, 
                                               int t_startcol, int t_ncols, Vec& targetsum, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;
  
   
  virtual TVec< pair<real,int> > evaluateKernelTopN(int N, Ker ker, int v1_startcol, int v1_ncols, 
                                                    const Vec& v2, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;

  virtual TVec< pair<real,int> > evaluateKernelBottomN(int N, Ker ker, int v1_startcol, int v1_ncols, 
                                                       const Vec& v2, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;


  virtual void accumulateXtY(int X_startcol, int X_ncols, int Y_startcol, int Y_ncols, 
                             Mat& result, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;


  virtual void accumulateXtX(int X_startcol, int X_ncols, 
                             Mat& result, int startrow=0, int nrows=-1, int ignore_this_row=-1) const;

  virtual void evaluateSumOfFprop(Func f, Vec& output_result, int nsamples=-1);
  virtual void evaluateSumOfFbprop(Func f, Vec& output_result, Vec& output_gradient, int nsamples=-1);

private:
  void build_();
};

DECLARE_OBJECT_PTR(ForwardVMatrix);

} // end of namespace PLearn

#endif

---