ConcatRowsVMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2001 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
// Copyright (C) 2002 Pascal Vincent, Julien Keable, Xavier Saint-Mleux
//
// 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: ConcatRowsVMatrix.h,v 1.11 2004/08/09 16:29:19 tihocan Exp $
   ******************************************************* */


#ifndef ConcatRowsVMatrix_INC
#define ConcatRowsVMatrix_INC

#include "VMat.h"

namespace PLearn {
using namespace std;
 
class ConcatRowsVMatrix: public VMatrix
{
  
private:

  typedef VMatrix inherited;

protected:

  TVec<VMat> array;

  TVec<VMat> to_concat;

  bool need_fix_mappings;

  TMat< map<real, real> > fixed_mappings;

public:

  bool fully_check_mappings;
  bool only_common_fields;

  ConcatRowsVMatrix(TVec<VMat> the_array = TVec<VMat>());
  ConcatRowsVMatrix(VMat d1, VMat d2);

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

  virtual void reset_dimensions();

  virtual real dot(int i1, int i2, int inputsize) const;
  virtual real dot(int i, const Vec& v) const;
  virtual void putMat(int i, int j, Mat m);

  PLEARN_DECLARE_OBJECT(ConcatRowsVMatrix);
  virtual void build();

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

protected:

  void getpositions(int i, int& whichvm, int& rowofvm) const; 

  static void declareOptions(OptionList &ol);

private:

  void build_();

  void ensureMappingsConsistency();

  void fullyCheckMappings(bool report_progress = true);

  void findCommonFields();

  void recomputeDimensions();

};

DECLARE_OBJECT_PTR(ConcatRowsVMatrix);

inline VMat vconcat(VMat d1, VMat d2)
{ return new ConcatRowsVMatrix(d1,d2); }

inline VMat vconcat(Array<VMat> ds) {
  if (ds.size() == 1) {
    // Only one matrix: no need to use a ConcatRowsVMatrix.
    return ds[0];
  } else {
    return new ConcatRowsVMatrix(ds);
  }
}

} // end of namespcae PLearn
#endif

---