PLearn 0.1
StabilisationLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // StabilisationLearner.h
00004 //
00005 // Copyright (C) 2009 Frederic Bastien
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: Frederic Bastien
00036 
00040 #ifndef StabilisationLearner_INC
00041 #define StabilisationLearner_INC
00042 
00043 #include <plearn_learners/generic/PLearner.h>
00044 
00045 namespace PLearn {
00046 
00057 class StabilisationLearner : public PLearner
00058 {
00059     typedef PLearner inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00065     real threshold;
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     StabilisationLearner();
00074 
00075 
00076     //#####  PLearner Member Functions  #######################################
00077 
00080     virtual int outputsize() const;
00081 
00082 
00083 
00087     virtual void forget();
00088 
00092     virtual void train();
00093 
00095     virtual void computeOutput(const Vec& input, Vec& output) const;
00096 
00098     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00099                                          const Vec& target, Vec& costs) const;
00100 
00103     virtual TVec<std::string> getTestCostNames() const;
00104 
00107     virtual TVec<std::string> getTrainCostNames() const;
00108 
00109     virtual TVec<std::string> getOutputNames() const;
00110 
00111     //#####  PLearn::Object Protocol  #########################################
00112 
00113     PLEARN_DECLARE_OBJECT(StabilisationLearner);
00114 
00115     // Simply calls inherited::build() then build_()
00116     virtual void build();
00117 
00119     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00120 
00121 protected:
00122     //#####  Protected Options  ###############################################
00123 
00124     // ### Declare protected option fields (such as learned parameters) here
00125     // ...
00126 
00127 protected:
00128     //#####  Protected Member Functions  ######################################
00129 
00131     static void declareOptions(OptionList& ol);
00132 
00133 private:
00134     //#####  Private Member Functions  ########################################
00135 
00137     void build_();
00138 
00139 private:
00140     //#####  Private Data Members  ############################################
00141 
00142 };
00143 
00144 // Declares a few other classes and functions related to this class
00145 DECLARE_OBJECT_PTR(StabilisationLearner);
00146 
00147 } // end of namespace PLearn
00148 
00149 #endif
00150 
00151 
00152 /*
00153   Local Variables:
00154   mode:c++
00155   c-basic-offset:4
00156   c-file-style:"stroustrup"
00157   c-file-offsets:((innamespace . 0)(inline-open . 0))
00158   indent-tabs-mode:nil
00159   fill-column:79
00160   End:
00161 */
00162 // 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