PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RegressorFromDistribution.h 00004 // 00005 // Copyright (C) 2006 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 RegressorFromDistribution_INC 00041 #define RegressorFromDistribution_INC 00042 00043 #include <plearn_learners/generic/PLearner.h> 00044 #include <plearn_learners/distributions/PDistribution.h> 00045 00046 namespace PLearn { 00047 00058 class RegressorFromDistribution : public PLearner 00059 { 00060 typedef PLearner inherited; 00061 00062 public: 00063 //##### Public Build Options ############################################ 00064 00065 PP<PDistribution> distribution; 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 RegressorFromDistribution(); 00074 00075 00076 //##### PLearner Member Functions ####################################### 00077 00080 // (PLEASE IMPLEMENT IN .cc) 00081 virtual int outputsize() const; 00082 00086 // (PLEASE IMPLEMENT IN .cc) 00087 virtual void forget(); 00088 00092 // (PLEASE IMPLEMENT IN .cc) 00093 virtual void train(); 00094 00096 // (PLEASE IMPLEMENT IN .cc) 00097 virtual void computeOutput(const Vec& input, Vec& output) const; 00098 00100 // (PLEASE IMPLEMENT IN .cc) 00101 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00102 const Vec& target, Vec& costs) const; 00103 00106 // (PLEASE IMPLEMENT IN .cc) 00107 virtual TVec<std::string> getTestCostNames() const; 00108 00111 // (PLEASE IMPLEMENT IN .cc) 00112 virtual TVec<std::string> getTrainCostNames() const; 00113 00115 virtual void setTrainingSet(VMat training_set, bool call_forget=true); 00116 00117 // *** SUBCLASS WRITING: *** 00118 // While in general not necessary, in case of particular needs 00119 // (efficiency concerns for ex) you may also want to overload 00120 // some of the following methods: 00121 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 00122 // Vec& output, Vec& costs) const; 00123 // virtual void computeCostsOnly(const Vec& input, const Vec& target, 00124 // Vec& costs) const; 00125 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, 00126 // VMat testoutputs=0, VMat testcosts=0) const; 00127 // virtual int nTestCosts() const; 00128 // virtual int nTrainCosts() const; 00129 // virtual void resetInternalState(); 00130 // virtual bool isStatefulLearner() const; 00131 00132 00133 //##### PLearn::Object Protocol ######################################### 00134 00135 // Declares other standard object methods. 00136 // ### If your class is not instantiatable (it has pure virtual methods) 00137 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00138 PLEARN_DECLARE_OBJECT(RegressorFromDistribution); 00139 00140 // Simply calls inherited::build() then build_() 00141 virtual void build(); 00142 00144 // (PLEASE IMPLEMENT IN .cc) 00145 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00146 00147 protected: 00148 //##### Protected Options ############################################### 00149 00150 // ### Declare protected option fields (such as learned parameters) here 00151 // ... 00152 00153 protected: 00154 //##### Protected Member Functions ###################################### 00155 00157 // (PLEASE IMPLEMENT IN .cc) 00158 static void declareOptions(OptionList& ol); 00159 00160 private: 00161 //##### Private Member Functions ######################################## 00162 00164 // (PLEASE IMPLEMENT IN .cc) 00165 void build_(); 00166 00167 private: 00168 //##### Private Data Members ############################################ 00169 00170 // The rest of the private stuff goes here 00171 }; 00172 00173 // Declares a few other classes and functions related to this class 00174 DECLARE_OBJECT_PTR(RegressorFromDistribution); 00175 00176 } // end of namespace PLearn 00177 00178 #endif 00179 00180 00181 /* 00182 Local Variables: 00183 mode:c++ 00184 c-basic-offset:4 00185 c-file-style:"stroustrup" 00186 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00187 indent-tabs-mode:nil 00188 fill-column:79 00189 End: 00190 */ 00191 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :