ShiftAndRescaleVMatrix.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: ShiftAndRescaleVMatrix.h,v 1.10 2004/07/19 13:28:48 tihocan Exp $
   ******************************************************* */


#ifndef ShiftAndRescaleVMatrix_INC
#define ShiftAndRescaleVMatrix_INC

#include "VMat.h"

namespace PLearn {
using namespace std;
 
class ShiftAndRescaleVMatrix: public VMatrix
{
  typedef VMatrix inherited;

public:
  VMat vm;
  Vec shift; 
  Vec scale; 
  bool automatic; // find shift and scale automatically?
  int n_train; // when automatic, use the n_train first examples to estimate shift and scale
  int n_inputs; // when automatic, 
  bool negate_shift;
  bool no_scale;
  bool ignore_missing;
  int verbosity;

  ShiftAndRescaleVMatrix();
  ShiftAndRescaleVMatrix(VMat underlying_distr, Vec the_shift, Vec the_scale);
  ShiftAndRescaleVMatrix(VMat underlying_distr, int n_inputs);
  ShiftAndRescaleVMatrix(VMat underlying_distr, int n_inputs, int n_train, bool the_ignore_missing = false, bool the_verbosity = 1);

  PLEARN_DECLARE_OBJECT(ShiftAndRescaleVMatrix);

  virtual real get(int i, int j) const;
  virtual void getSubRow(int i, int j, Vec v) const;
  virtual void reset_dimensions() 
    { 
      if (width_>0 && width_!=vm->width())
        PLERROR("ShiftAndRescaleVMatrix: can't change width"); 
      inherited::reset_dimensions();
    }
private: 
  void build_();

protected: 
  static void declareOptions(OptionList& ol);

public:
  // simply calls inherited::build() then build_() 
  virtual void build();

};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(ShiftAndRescaleVMatrix);

} // end of namespcae PLearn
#endif

---