PLearn 0.1
SquaredErrModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SquaredErrModule.h
00004 //
00005 // Copyright (C) 2005 Pascal Lamblin
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 /* *******************************************************
00036    * $Id: SquaredErrModule.h,v 1.1 2005/11/30 04:36:17 lamblinp Exp $
00037    ******************************************************* */
00038 
00039 // Authors: Pascal Lamblin
00040 
00044 #ifndef SquaredErrModule_INC
00045 #define SquaredErrModule_INC
00046 
00047 #include <plearn/base/Object.h>
00048 #include <plearn/math/TMat_maths.h>
00049 #include <plearn_learners/online/OnlineLearningModule.h>
00050 
00051 namespace PLearn {
00052 
00058 class SquaredErrModule : public OnlineLearningModule
00059 {
00060     typedef OnlineLearningModule inherited;
00061 
00062 public:
00063     //#####  Public Build Options  ############################################
00064 
00065 
00066 public:
00067     //#####  Public Member Functions  #########################################
00068 
00070     SquaredErrModule();
00071 
00072     // Your other public member functions go here
00073 /*
00074     virtual void setTarget(const Vec the_target);
00075     virtual void setTarget(real the_target);
00076     virtual Vec getTarget() const;
00077 */
00078     virtual void fprop(const Vec& input, Vec& output) const;
00079 
00080     virtual void bpropUpdate(const Vec& input, const Vec& output,
00081                              const Vec& output_gradient);
00082 
00083     virtual void bpropUpdate(const Vec& input, const Vec& output,
00084                              Vec& input_gradient, const Vec& output_gradient);
00085 
00086     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00087                               const Vec& output_gradient,
00088                               const Vec& output_diag_hessian);
00089 
00090     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00091                               Vec& input_gradient,
00092                               const Vec& output_gradient,
00093                               Vec& input_diag_hessian,
00094                               const Vec& output_diag_hessian);
00095 
00096 
00097     virtual void forget();
00098 
00099     //#####  PLearn::Object Protocol  #########################################
00100 
00101     // Declares other standard object methods.
00102     PLEARN_DECLARE_OBJECT(SquaredErrModule);
00103 
00104     // Simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00108     // (PLEASE IMPLEMENT IN .cc)
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00111 protected:
00112     //#####  Protected Options  ###############################################
00113 //    Vec target;
00114     int target_size;
00115     //#####  Protected Member Functions  ######################################
00116 
00118     static void declareOptions(OptionList& ol);
00119 
00120 private:
00121     //#####  Private Member Functions  ########################################
00122 
00124     void build_();
00125 
00126 private:
00127     //#####  Private Data Members  ############################################
00128 
00129     // The rest of the private stuff goes here
00130 };
00131 
00132 // Declares a few other classes and functions related to this class
00133 DECLARE_OBJECT_PTR(SquaredErrModule);
00134 
00135 } // end of namespace PLearn
00136 
00137 #endif
00138 
00139 
00140 /*
00141   Local Variables:
00142   mode:c++
00143   c-basic-offset:4
00144   c-file-style:"stroustrup"
00145   c-file-offsets:((innamespace . 0)(inline-open . 0))
00146   indent-tabs-mode:nil
00147   fill-column:79
00148   End:
00149 */
00150 // 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