ExtendedVariable.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
// Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
// Copyright (C) 2002 Xiangdong Wang, Christian Dorion

// 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: ExtendedVariable.h,v 1.5 2004/04/27 16:03:35 morinf Exp $
   * This file is part of the PLearn library.
   ******************************************************* */

#ifndef ExtendedVariable_INC
#define ExtendedVariable_INC

#include "UnaryVariable.h"

namespace PLearn {
using namespace std;


class ExtendedVariable: public UnaryVariable
{
  typedef UnaryVariable inherited;

public:
  int top_extent;
  int bottom_extent;
  int left_extent;
  int right_extent;
  real fill_value; 

public:
  ExtendedVariable()
    : top_extent(), bottom_extent(), left_extent(), right_extent(), fill_value()
    {}
  ExtendedVariable(Variable* input, 
                   int the_top_extent, int the_bottom_extent, 
                   int the_left_extent, int the_right_extent, 
                   real the_fill_value);

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

  virtual void build();

  virtual void recomputeSize(int& l, int& w) const;  
  virtual void fprop();
  virtual void bprop();
  virtual void symbolicBprop();
  virtual void rfprop();

protected:
    void build_();
};

DECLARE_OBJECT_PTR(ExtendedVariable);

inline Var extend(Var v, int top_extent, int bottom_extent, int left_extent, int right_extent, real fill_value=0.0)
{ return new ExtendedVariable(v,top_extent,bottom_extent,left_extent,right_extent,fill_value); }

inline Var extend(Var v, real extension_value = 1.0, int n_extend = 1)
{ 
  if(v->isColumnVec())
    return new ExtendedVariable(v,0,n_extend,0,0,extension_value); 
  else if(v->isRowVec())
    return new ExtendedVariable(v,0,0,0,n_extend,extension_value); 
  PLERROR("In extend(Var v, real extension_value = 1.0, int n_extend = 1) v is not a vector (single row or single column)");
  return Var();
}


} // end of namespace PLearn

#endif 

---