PLearn 0.1
ClassErrorCostModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ClassErrorCostModule.h
00004 //
00005 // Copyright (C) 2007 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 // Authors: Pascal Lamblin
00036 
00040 #ifndef ClassErrorCostModule_INC
00041 #define ClassErrorCostModule_INC
00042 
00043 #include <plearn_learners/online/CostModule.h>
00044 
00045 namespace PLearn {
00046 
00055 class ClassErrorCostModule : public CostModule
00056 {
00057     typedef CostModule inherited;
00058 
00059 public:
00060     //#####  Public Build Options  ############################################
00061     
00062     Mat error_costs;
00063 
00064 public:
00065     //#####  Public Member Functions  #########################################
00066 
00068     ClassErrorCostModule();
00069 
00072     virtual void fprop(const Vec& input, const Vec& target, Vec& cost) const;
00073 
00075     virtual void fprop(const Mat& inputs, const Mat& targets, Mat& costs)
00076         const;
00077 
00080     virtual void fprop(const Vec& input, const Vec& target, real& cost) const;
00081 
00083     virtual void bpropUpdate(const Vec& input, const Vec& target, real cost);
00084 
00085     /*
00087     virtual void bpropUpdate(const Vec& input, const Vec& target, real cost,
00088                              Vec& input_gradient);
00089     */
00090 
00092     virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost);
00093 
00094     virtual void bpropUpdate(const Mat& inputs, const Mat& targets,
00095             const Vec& costs)
00096     {}
00097 
00098     /* Optional
00099        N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH
00100        RAISES A PLERROR.
00102     virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost,
00103                               Vec& input_gradient, Vec& input_diag_hessian);
00104     */
00105 
00109     virtual void forget();
00110 
00112     virtual void setLearningRate(real dynamic_learning_rate) {}
00113 
00115     virtual bool bpropDoesNothing();
00116 
00118     virtual TVec<string> costNames();
00119 
00120 
00121     //#####  PLearn::Object Protocol  #########################################
00122 
00123     // Declares other standard object methods.
00124     PLEARN_DECLARE_OBJECT(ClassErrorCostModule);
00125 
00126     // Simply calls inherited::build() then build_()
00127     virtual void build();
00128 
00130     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00131 
00132 
00133 protected:
00134     //#####  Protected Member Functions  ######################################
00135 
00137     static void declareOptions(OptionList& ol);
00138 
00139 private:
00140     //#####  Private Member Functions  ########################################
00141 
00143     void build_();
00144 
00145 private:
00146     //#####  Private Data Members  ############################################
00147 };
00148 
00149 // Declares a few other classes and functions related to this class
00150 DECLARE_OBJECT_PTR(ClassErrorCostModule);
00151 
00152 } // end of namespace PLearn
00153 
00154 #endif
00155 
00156 
00157 /*
00158   Local Variables:
00159   mode:c++
00160   c-basic-offset:4
00161   c-file-style:"stroustrup"
00162   c-file-offsets:((innamespace . 0)(inline-open . 0))
00163   indent-tabs-mode:nil
00164   fill-column:79
00165   End:
00166 */
00167 // 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