PLearn 0.1
CrossEntropyCostModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CrossEntropyCostModule.h
00004 //
00005 // Copyright (C) 2007 Pascal Lamblin, Dumitru Erhan and Hugo Larochelle
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: Pascal Lamblin, Dumitru Erhan and Hugo Larochelle
00036 
00040 #ifndef CrossEntropyCostModule_INC
00041 #define CrossEntropyCostModule_INC
00042 
00043 #include <plearn_learners/online/CostModule.h>
00044 
00045 namespace PLearn {
00046 
00050 class CrossEntropyCostModule : public CostModule
00051 {
00052     typedef CostModule inherited;
00053 
00054 public:
00055     //#####  Public Build Options  ############################################
00056 
00057 
00058 public:
00059     //#####  Public Member Functions  #########################################
00060 
00062     CrossEntropyCostModule();
00063 
00064     // Your other public member functions go here
00065 
00067     virtual void fprop(const Vec& input, const Vec& target, real& cost) const;
00068     virtual void fprop(const Vec& input, const Vec& target, Vec& cost) const;
00069     virtual void fprop(const Mat& input, const Mat& target, Mat& cost) const;
00070 
00072     virtual void bpropUpdate(const Vec& input, const Vec& target, real cost,
00073                              Vec& input_gradient, bool accumulate=false);
00074 
00076     virtual void bpropUpdate(const Mat& inputs, const Mat& targets,
00077                              const Vec& costs, Mat& input_gradients,
00078                              bool accumulate=false);
00079 
00081     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00082                                 const TVec<Mat*>& ports_gradient);
00083 
00085     virtual void setLearningRate(real dynamic_learning_rate) {}
00086 
00088     virtual TVec<string> costNames();
00089 
00090     //#####  PLearn::Object Protocol  #########################################
00091 
00092     // Declares other standard object methods.
00093     // ### If your class is not instantiatable (it has pure virtual methods)
00094     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00095     PLEARN_DECLARE_OBJECT(CrossEntropyCostModule);
00096 
00097     // Simply calls inherited::build() then build_()
00098     virtual void build();
00099 
00101     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00102 
00103 
00104 protected:
00105     //#####  Protected Member Functions  ######################################
00106 
00108     static void declareOptions(OptionList& ol);
00109 
00110 private:
00111     //#####  Private Member Functions  ########################################
00112 
00114     void build_();
00115 
00116 private:
00117     //#####  Private Data Members  ############################################
00118 
00119     // The rest of the private stuff goes here
00120 };
00121 
00122 // Declares a few other classes and functions related to this class
00123 DECLARE_OBJECT_PTR(CrossEntropyCostModule);
00124 
00125 } // end of namespace PLearn
00126 
00127 #endif
00128 
00129 
00130 /*
00131   Local Variables:
00132   mode:c++
00133   c-basic-offset:4
00134   c-file-style:"stroustrup"
00135   c-file-offsets:((innamespace . 0)(inline-open . 0))
00136   indent-tabs-mode:nil
00137   fill-column:79
00138   End:
00139 */
00140 // 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