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