PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // TestLearner.h 00004 // 00005 // Copyright (C) 2005 Dan Popovici 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 /* ******************************************************* 00036 * $Id: .pyskeleton_header 544 2003-09-01 00:05:31Z plearner $ 00037 ******************************************************* */ 00038 00039 // Authors: Dan Popovici 00040 00044 #ifndef TestLearner_INC 00045 #define TestLearner_INC 00046 00047 #include <plearn_learners/generic/PLearner.h> 00048 00049 namespace PLearn { 00050 00061 class TestLearner : public PLearner 00062 { 00063 typedef PLearner inherited; 00064 00065 public: 00066 //##### Public Build Options ############################################ 00067 00070 00071 public: 00072 //##### Public Member Functions ######################################### 00073 00075 // ### Make sure the implementation in the .cc 00076 // ### initializes all fields to reasonable default values. 00077 TestLearner(); 00078 00079 std::string dir_path ; 00080 Vec train_costs ; 00081 00082 00083 //##### PLearner Member Functions ####################################### 00084 00087 // (PLEASE IMPLEMENT IN .cc) 00088 virtual int outputsize() const; 00089 00093 // (PLEASE IMPLEMENT IN .cc) 00094 virtual void forget(); 00095 00099 // (PLEASE IMPLEMENT IN .cc) 00100 virtual void train(); 00101 00103 // (PLEASE IMPLEMENT IN .cc) 00104 virtual void computeOutput(const Vec& input, Vec& output) const; 00105 00107 // (PLEASE IMPLEMENT IN .cc) 00108 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00109 const Vec& target, Vec& costs) const; 00110 00113 // (PLEASE IMPLEMENT IN .cc) 00114 virtual TVec<std::string> getTestCostNames() const; 00115 00118 // (PLEASE IMPLEMENT IN .cc) 00119 virtual TVec<std::string> getTrainCostNames() const; 00120 00121 00122 // *** SUBCLASS WRITING: *** 00123 // While in general not necessary, in case of particular needs 00124 // (efficiency concerns for ex) you may also want to overload 00125 // some of the following methods: 00126 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const; 00127 // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const; 00128 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const; 00129 // virtual int nTestCosts() const; 00130 // virtual int nTrainCosts() const; 00131 // virtual void resetInternalState(); 00132 // virtual bool isStatefulLearner() const; 00133 00134 00135 //##### PLearn::Object Protocol ######################################### 00136 00137 // Declares other standard object methods. 00138 // ### If your class is not instantiatable (it has pure virtual methods) 00139 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00140 PLEARN_DECLARE_OBJECT(TestLearner); 00141 00142 // Simply calls inherited::build() then build_() 00143 virtual void build(); 00144 00146 // (PLEASE IMPLEMENT IN .cc) 00147 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00148 00149 protected: 00150 //##### Protected Options ############################################### 00151 00152 // ### Declare protected option fields (such as learned parameters) here 00153 // ... 00154 00155 protected: 00156 //##### Protected Member Functions ###################################### 00157 00159 // (PLEASE IMPLEMENT IN .cc) 00160 static void declareOptions(OptionList& ol); 00161 00162 private: 00163 //##### Private Member Functions ######################################## 00164 00166 // (PLEASE IMPLEMENT IN .cc) 00167 void build_(); 00168 00169 private: 00170 //##### Private Data Members ############################################ 00171 00172 // The rest of the private stuff goes here 00173 }; 00174 00175 // Declares a few other classes and functions related to this class 00176 DECLARE_OBJECT_PTR(TestLearner); 00177 00178 } // end of namespace PLearn 00179 00180 #endif 00181 00182 00183 /* 00184 Local Variables: 00185 mode:c++ 00186 c-basic-offset:4 00187 c-file-style:"stroustrup" 00188 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00189 indent-tabs-mode:nil 00190 fill-column:79 00191 End: 00192 */ 00193 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :