PLearn 0.1
LogaddOnBagsModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // LogaddOnBagsModule.h
00004 //
00005 // Copyright (C) 2007 Jerome Louradour
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: Jerome Louradour
00036 
00039 #ifndef LogaddOnBagsModule_INC
00040 #define LogaddOnBagsModule_INC
00041 
00042 #include <plearn_learners/online/OnBagsModule.h>
00043 
00044 #include <map>
00045 
00046 namespace PLearn {
00047 
00048 class LogaddOnBagsModule : public OnBagsModule
00049 {
00050     typedef OnBagsModule inherited;
00051 
00052 public:
00053     //#####  Public Build Options  ############################################
00054 
00055     //#####  Public Learnt Options  ###########################################
00056 
00057 
00058 public:
00059     //#####  Public Member Functions  #########################################
00060 
00062     LogaddOnBagsModule();
00063 
00065     virtual void fpropAcc(const Vec& input);
00066     virtual void fpropInit(const Vec& input);
00067     virtual void fpropOutput(Vec& output);
00068 
00070     virtual void bprop( const Mat& baginputs,
00071                         const Vec& bagoutput_gradient,
00072                         Mat& baginputs_gradients);
00073 
00074     //#####  PLearn::Object Protocol  #########################################
00075 
00076     // Declares other standard object methods.
00077     // ### If your class is not instantiatable (it has pure virtual methods)
00078     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00079     PLEARN_DECLARE_OBJECT(LogaddOnBagsModule);
00080 
00081     // Simply calls inherited::build() then build_()
00082     virtual void build();
00083 
00085     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00086 
00087 protected:
00088 
00089     Vec accumulated_output;
00090 
00091     //#####  Protected Member Functions  ######################################
00092 
00094     static void declareOptions(OptionList& ol);
00095 
00096 private:
00097     //#####  Private Member Functions  ########################################
00098 
00100     void build_();
00101 
00102 private:
00103     //#####  Private Data Members  ############################################
00104 
00105 };
00106 
00107 // Declares a few other classes and functions related to this class
00108 DECLARE_OBJECT_PTR(LogaddOnBagsModule);
00109 
00110 } // end of namespace PLearn
00111 
00112 #endif
00113 
00114 
00115 /*
00116   Local Variables:
00117   mode:c++
00118   c-basic-offset:4
00119   c-file-style:"stroustrup"
00120   c-file-offsets:((innamespace . 0)(inline-open . 0))
00121   indent-tabs-mode:nil
00122   fill-column:79
00123   End:
00124 */
00125 // 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