PLearn 0.1
GradientCorrector.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // GradientCorrector.cc
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 #include "GradientCorrector.h"
00041 #include <plearn/math/TMat_maths.h>
00042 #include <plearn/math/plapack.h>
00043 
00044 namespace PLearn {
00045 using namespace std;
00046 
00047 // bool save_G=false;
00048 
00049 PLEARN_IMPLEMENT_ABSTRACT_OBJECT(
00050     GradientCorrector,
00051     "Virtual class used for correcting a sequence of n-dimensional gradients.\n",
00052     "The algorithm used for converting a sequence of n-dimensional gradients g_t\n"
00053     "into covariance-corrected update directions v_t depends on the subclass.\n"
00054     "The main method is the one that does the conversion:\n"
00055     "  operator(int t, Vec g, Vec v): (reads g and writes v)\n"
00056     "There is also an init() method to start a new sequence.\n"
00057     );
00058 
00059 GradientCorrector::GradientCorrector()
00060     /* ### Initialize all fields to their default value */
00061     : n_dim(-1),
00062       verbosity(0)
00063 {
00064 }
00065 
00066 // ### Nothing to add here, simply calls build_
00067 void GradientCorrector::build()
00068 {
00069     inherited::build();
00070     build_();
00071 }
00072 
00073 void GradientCorrector::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00074 {
00075     inherited::makeDeepCopyFromShallowCopy(copies);
00076 }
00077 
00078 void GradientCorrector::declareOptions(OptionList& ol)
00079 {
00080     // ### Declare all of this object's options here.
00081     // ### For the "flags" of each option, you should typically specify
00082     // ### one of OptionBase::buildoption, OptionBase::learntoption or
00083     // ### OptionBase::tuningoption. If you don't provide one of these three,
00084     // ### this option will be ignored when loading values from a script.
00085     // ### You can also combine flags, for example with OptionBase::nosave:
00086     // ### (OptionBase::buildoption | OptionBase::nosave)
00087 
00088     declareOption(ol, "n_dim", &GradientCorrector::n_dim,
00089                   OptionBase::learntoption,
00090                   "Number of dimensions of the gradient vectors\n");
00091     // Now call the parent class' declareOptions
00092     inherited::declareOptions(ol);
00093 }
00094 
00095 void GradientCorrector::build_()
00096 {
00097     init();
00098 }
00099 
00100 
00101 } // end of namespace PLearn
00102 
00103 
00104 /*
00105   Local Variables:
00106   mode:c++
00107   c-basic-offset:4
00108   c-file-style:"stroustrup"
00109   c-file-offsets:((innamespace . 0)(inline-open . 0))
00110   indent-tabs-mode:nil
00111   fill-column:79
00112   End:
00113 */
00114 
00115 // 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