PLearn 0.1
ArgmaxModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ArgmaxModule.h
00004 //
00005 // Copyright (C) 2007 Olivier Delalleau
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: Olivier Delalleau
00036 
00040 #ifndef ArgmaxModule_INC
00041 #define ArgmaxModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 
00045 namespace PLearn {
00046 
00057 class ArgmaxModule : public OnlineLearningModule
00058 {
00059     typedef OnlineLearningModule inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00066 
00067 public:
00068     //#####  Public Member Functions  #########################################
00069 
00071     // ### Make sure the implementation in the .cc
00072     // ### initializes all fields to reasonable default values.
00073     ArgmaxModule();
00074 
00075     // Your other public member functions go here
00076 
00089     void fprop(const TVec<Mat*>& ports_value);
00090 
00112     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00113                                 const TVec<Mat*>& ports_gradient);
00114 
00115     /* Optional
00116 
00119     virtual void fprop(const Vec& input, Vec& output) const;
00120 
00123     virtual void fprop(const Mat& inputs, Mat& outputs);
00124     */
00125 
00126     /* Optional
00137     virtual void bpropUpdate(const Vec& input, const Vec& output,
00138                              Vec& input_gradient,
00139                              const Vec& output_gradient,
00140                              bool accumulate=false);
00141 
00145     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00146                              Mat& input_gradients,
00147                              const Mat& output_gradients,
00148                              bool accumulate=false);
00149     */
00150 
00151     /* Optional
00154        A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00155        JUST CALLS
00156             bpropUpdate(input, output, input_gradient, output_gradient)
00157        AND IGNORES INPUT GRADIENT.
00159     virtual void bpropUpdate(const Vec& input, const Vec& output,
00160                              const Vec& output_gradient);
00161 
00165     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00166                              const Mat& output_gradients);
00167     */
00168 
00169     /* Optional
00170        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00171        RAISES A PLERROR.
00176     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00177                               Vec& input_gradient,
00178                               const Vec& output_gradient,
00179                               Vec& input_diag_hessian,
00180                               const Vec& output_diag_hessian,
00181                               bool accumulate=false);
00182     */
00183 
00184     /* Optional
00185        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS,
00186        WHICH JUST CALLS
00187             bbpropUpdate(input, output, input_gradient, output_gradient,
00188                          out_hess, in_hess)
00189        AND IGNORES INPUT HESSIAN AND INPUT GRADIENT.
00191     virtual void bbpropUpdate(const Vec& input, const Vec& output,
00192                               const Vec& output_gradient,
00193                               const Vec& output_diag_hessian);
00194     */
00195 
00196 
00200     virtual void forget();
00201 
00202 
00203     /* Optional
00204        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS DOES NOT
00205        DO ANYTHING.
00209     virtual void finalize();
00210     */
00211 
00212     /* Optional
00213        THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS RETURNS false
00215     virtual bool bpropDoesNothing();
00216     */
00217 
00218     /* Optional
00219        Default implementation prints a warning and does nothing
00222     virtual void setLearningRate(real dynamic_learning_rate);
00223     */
00224 
00228     virtual const TVec<string>& getPorts();
00229 
00230     //#####  PLearn::Object Protocol  #########################################
00231 
00232     // Declares other standard object methods.
00233     // ### If your class is not instantiatable (it has pure virtual methods)
00234     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00235     PLEARN_DECLARE_OBJECT(ArgmaxModule);
00236 
00237     // Simply calls inherited::build() then build_()
00238     virtual void build();
00239 
00241     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00242 
00243 
00244 protected:
00245     //#####  Protected Member Functions  ######################################
00246 
00248     static void declareOptions(OptionList& ol);
00249 
00250 private:
00251     //#####  Private Member Functions  ########################################
00252 
00254     void build_();
00255 
00256 private:
00257     //#####  Private Data Members  ############################################
00258 
00259     // The rest of the private stuff goes here
00260 };
00261 
00262 // Declares a few other classes and functions related to this class
00263 DECLARE_OBJECT_PTR(ArgmaxModule);
00264 
00265 } // end of namespace PLearn
00266 
00267 #endif
00268 
00269 
00270 /*
00271   Local Variables:
00272   mode:c++
00273   c-basic-offset:4
00274   c-file-style:"stroustrup"
00275   c-file-offsets:((innamespace . 0)(inline-open . 0))
00276   indent-tabs-mode:nil
00277   fill-column:79
00278   End:
00279 */
00280 // 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