PLearn 0.1
GradientCorrector.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // GradientCorrector.h
00004 //
00005 // Copyright (C) 2007 Yoshua Bengio
00006 //
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 //
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 //
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 //
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 //
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 //
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 // Authors: Yoshua Bengio
00036 
00040 #ifndef GradientCorrector_INC
00041 #define GradientCorrector_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include <plearn/math/TMat_impl.h>
00045 
00046 namespace PLearn {
00047 
00055 class GradientCorrector : public Object
00056 {
00057     typedef Object inherited;
00058 
00059 public:
00060     //#####  Public Build Options  ############################################
00061 
00063 
00065     int n_dim;
00066 
00068     int verbosity;
00069 
00070 public:
00071     //#####  Public Member Functions  #########################################
00072 
00074     // ### Make sure the implementation in the .cc
00075     // ### initializes all fields to reasonable default values.
00076     GradientCorrector();
00077 
00078     // Your other public member functions go here
00079 
00081     virtual void init() = 0;
00082 
00088     virtual void operator()(int t, const Vec& g, Vec v) = 0;
00089 
00090     //#####  PLearn::Object Protocol  #########################################
00091 
00092     // Declares other standard object methods.
00093     // ### If your class is not instantiatable (it has pure virtual methods)
00094     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00095     PLEARN_DECLARE_ABSTRACT_OBJECT(GradientCorrector);
00096 
00097     // Simply calls inherited::build() then build_()
00098     virtual void build();
00099 
00101     // (PLEASE IMPLEMENT IN .cc)
00102     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00103 
00104 protected:
00105     //#####  Protected Options  ###############################################
00106 
00107     // ### Declare protected option fields (such as learned parameters) here
00108 
00109 
00110 protected:
00111     //#####  Protected Member Functions  ######################################
00112 
00114     // (PLEASE IMPLEMENT IN .cc)
00115     static void declareOptions(OptionList& ol);
00116 
00117 private:
00118     //#####  Private Member Functions  ########################################
00119 
00121     // (PLEASE IMPLEMENT IN .cc)
00122     void build_();
00123 
00124 private:
00125     //#####  Private Data Members  ############################################
00126 
00127     // The rest of the private stuff goes here
00128 
00129 };
00130 
00131 // Declares a few other classes and functions related to this class
00132 DECLARE_OBJECT_PTR(GradientCorrector);
00133 
00134 } // end of namespace PLearn
00135 
00136 #endif
00137 
00138 
00139 /*
00140   Local Variables:
00141   mode:c++
00142   c-basic-offset:4
00143   c-file-style:"stroustrup"
00144   c-file-offsets:((innamespace . 0)(inline-open . 0))
00145   indent-tabs-mode:nil
00146   fill-column:79
00147   End:
00148 */
00149 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines