PLearn 0.1
ConstantRegressor.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // ConstantRegressor.h
00005 //
00006 // Copyright (C) 2003  *AUTHOR(S)* 
00007 // 
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 // 
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 // 
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 // 
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 // 
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 // 
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 /* *******************************************************      
00037  * $Id: ConstantRegressor.h 3994 2005-08-25 13:35:03Z chapados $ 
00038  ******************************************************* */
00039 
00041 #ifndef ConstantRegressor_INC
00042 #define ConstantRegressor_INC
00043 
00044 #include <plearn_learners/generic/PLearner.h>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 class ConstantRegressor: public PLearner
00050 {
00051 private:
00052     typedef PLearner inherited;
00053   
00054 protected:
00055     // *********************
00056     // * protected options *
00057     // *********************
00058 
00059     // ### declare protected option fields (such as learnt parameters) here
00060     Vec constant_output;
00061     
00062 public:
00063 
00065     real weight_decay;
00066 
00067     // ************************
00068     // * public build options *
00069     // ************************
00070 
00071     // ### declare public option fields (such as build options) here
00072     // no option
00073 
00074     // ****************
00075     // * Constructors *
00076     // ****************
00077 
00078     // Default constructor, make sure the implementation in the .cc
00079     // initializes all fields to reasonable default values.
00080     ConstantRegressor();
00081 
00082 
00083     // ******************
00084     // * PLearner methods *
00085     // ******************
00086 
00087 private: 
00089     // (Please implement in .cc)
00090     void build_();
00091 
00092 protected: 
00094     // (Please implement in .cc)
00095     static void declareOptions(OptionList& ol);
00096 
00097 public:
00098 
00099     // ************************
00100     // **** Object methods ****
00101     // ************************
00102 
00104     virtual void build();
00105 
00107     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00108 
00109     // Declares other standard object methods
00110     //  If your class is not instantiatable (it has pure virtual methods)
00111     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
00112     PLEARN_DECLARE_OBJECT(ConstantRegressor);
00113 
00114 
00115     // **************************
00116     // **** PLearner methods ****
00117     // **************************
00118 
00121     // (PLEASE IMPLEMENT IN .cc)
00122     virtual int outputsize() const;
00123 
00126     virtual void forget();
00127 
00128     
00131     virtual void train();
00132 
00133 
00135     virtual void computeOutput(const Vec& input, Vec& output) const;
00136 
00138     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00139                                          const Vec& target, Vec& costs) const;
00140                                 
00141 
00143     virtual TVec<string> getTestCostNames() const;
00144 
00147     virtual TVec<string> getTrainCostNames() const;
00148 
00149 
00150     // *** SUBCLASS WRITING: ***
00151     // While in general not necessary, in case of particular needs 
00152     // (efficiency concerns for ex) you may also want to overload
00153     // some of the following methods:
00154     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00155     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00156     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00157     // virtual int nTestCosts() const;
00158     // virtual int nTrainCosts() const;
00159 
00160 };
00161 
00162 // Declares a few other classes and functions related to this class
00163 DECLARE_OBJECT_PTR(ConstantRegressor);
00164   
00165 } // end of namespace PLearn
00166 
00167 #endif
00168 
00169 
00170 /*
00171   Local Variables:
00172   mode:c++
00173   c-basic-offset:4
00174   c-file-style:"stroustrup"
00175   c-file-offsets:((innamespace . 0)(inline-open . 0))
00176   indent-tabs-mode:nil
00177   fill-column:79
00178   End:
00179 */
00180 // 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