PLearn 0.1
learners_experimental/NoBpropVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039    * $Id: NoBpropVariable.h 2227 2004-08-21 14:42:05Z yoshua $
00040    * This file is part of the PLearn library.
00041    ******************************************************* */
00042 
00043 #ifndef NoBpropVariable_INC
00044 #define NoBpropVariable_INC
00045 
00046 #include <plearn/var/UnaryVariable.h>
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00061 class NoBpropVariable: public UnaryVariable
00062 {
00063   typedef UnaryVariable inherited;
00064 
00065 public:
00066   real  * gradient_scaling_factor;
00067 
00068 public:
00070   NoBpropVariable()
00071     : gradient_scaling_factor(0)
00072     {}
00073   NoBpropVariable(Variable* input, real  * the_gradient_scaling_factor);
00074 
00075   PLEARN_DECLARE_OBJECT(NoBpropVariable);
00076   static void declareOptions(OptionList &ol);
00077 
00078   virtual void build();
00079 
00080   virtual void recomputeSize(int& l, int& w) const;  
00081   virtual void fprop();
00082   virtual void bprop();
00083 
00084 protected:
00085     void build_();
00086 };
00087 
00088 DECLARE_OBJECT_PTR(NoBpropVariable);
00089 
00091 inline Var no_bprop(Var v, real  *gradient_scaling_factor)
00092 { return new NoBpropVariable(v,gradient_scaling_factor); }
00093 
00094 } // end of namespace PLearn
00095 
00096 #endif 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines