Func.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 and University of Montreal
//

// 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: Func.h,v 1.11 2004/07/21 16:30:54 chrish42 Exp $
   * AUTHORS: Pascal Vincent & Yoshua Bengio
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef FUNCTION_INC
#define FUNCTION_INC

#include <plearn/base/general.h>
#include <plearn/base/PP.h>
#include <plearn/math/TMat.h>
#include <plearn/vmat/VMat.h>
#include "Variable.h"
#include "VarArray.h"

namespace PLearn {
using namespace std;


class Function;
class Func: public PP<Function>
{
public:
  Func();

  Func(Function* f);
 
  Func(const VarArray& the_inputs, const VarArray& the_outputs);

  Func(const VarArray& the_inputs, const VarArray& parameters_to_optimize,const VarArray& the_outputs);

  Vec operator()(const Vec& input) const;

  real operator()(const Vec& input1, const Vec& input2) const;

  VarArray operator()(const VarArray& new_inputs) const;
};

class Function: public Object
{
public:

  // Build options:
  mutable VarArray inputs;
  mutable VarArray parameters;  
  mutable VarArray outputs;

  // Other variables
  int inputsize;
  int outputsize;
  mutable VarArray fproppath;
  VarArray bproppath;
  VarArray parentspath; 

  Func df; 

private: 
  // (Please implement in .cc)
  void build_();

protected: 
  // (Please implement in .cc)
  static void declareOptions(OptionList& ol);


 public:
  Function();
  Function(const VarArray& the_inputs, const VarArray& the_outputs);
  Function(const VarArray& the_inputs, const VarArray& parameters_to_optimize,const VarArray& the_outputs);
  //void bprop(VarArray& parameters_to_optimize);

public:

  // ************************
  // **** Object methods ****
  // ************************

  virtual void build();

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

  // Declares other standard object methods
  //  If your class is not instantiatable (it has pure virtual methods)
  // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
  typedef Object inherited;
  PLEARN_DECLARE_OBJECT(Function);

  
  // **************************
  // **** Function methods ****
  // **************************

  void fprop(const Vec& in, const Vec& out) const;
  void fprop(const Array<Vec>& in, const Array<Vec>& out) const;

  void fbprop(const Vec& in, const Vec& out, const Vec& input_gradient, const Vec& output_gradient);
  void fbprop(const Array<Vec>& in, const Array<Vec>& out, 
              const Array<Vec>& input_gradient, const Array<Vec>& output_gradient);

  void fbbprop(const Vec& in, const Vec& out, const Vec& gradient, const Mat& hessian);
  void fbbpropAcc(const Vec& in, const Vec& out, const Vec& gradient, const Mat& hessian);
  
  void rfprop(const Vec& in, const Vec& out, const Vec& input_rvalue, const Vec& output_rvalue, bool do_fprop=true);
  
  void recomputeParents(); 

  Func differentiate();

  Vec operator()(const Vec& input) const;
  real operator()(const Vec& input1, const Vec& input2) const;

  VarArray operator()(const VarArray& new_inputs) const;

  void verifyGradient(const Vec& in, real step=0.01);

  void verifyHessian(const Vec& in, real step=0.01);

  void verifyGradient(real minval, real maxval, real step=0.01);

  void verifyGradient(real step=0.01);  

  void verifySymbolicGradient(const Vec& in);

  // This is developed to make sure that the code of rfprop is correct.
  // The value of H * r computed by rfprop or Hessian should be the same.
  void verifyrfprop(const Vec& in, real step=0.01);
};

DECLARE_OBJECT_PTR(Function);
DECLARE_OBJECT_PP(Func, Function);

Func operator/(Func f, real value);

template <> void deepCopyField(Func& field, CopiesMap& copies);

} // end of namespace PLearn

#endif

---