PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // StatefulLearner.h 00004 // 00005 // Copyright (C) 2004 Réjean Ducharme 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: StatefulLearner.h 3994 2005-08-25 13:35:03Z chapados $ 00037 ******************************************************* */ 00038 00039 // Authors: Réjean Ducharme 00040 00044 #ifndef StatefulLearner_INC 00045 #define StatefulLearner_INC 00046 00047 #include "PLearner.h" 00048 00049 namespace PLearn { 00050 using namespace std; 00051 00052 class StatefulLearner: public PLearner 00053 { 00054 typedef PLearner inherited; 00055 00056 protected: 00061 mutable int current_test_t; 00062 00063 private: 00066 int test_start_time; 00067 00068 public: 00069 00071 StatefulLearner(); 00072 00073 private: 00074 00076 void build_(); 00077 00078 protected: 00079 00081 static void declareOptions(OptionList& ol); 00082 00083 public: 00084 00085 // ************************ 00086 // **** Object methods **** 00087 // ************************ 00088 00090 virtual void build(); 00091 00093 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00094 00095 // Declares other standard object methods. 00096 PLEARN_DECLARE_ABSTRACT_OBJECT(StatefulLearner); 00097 00098 00099 // ************************** 00100 // **** PLearner methods **** 00101 // ************************** 00102 00106 virtual void forget() = 0; 00107 00109 virtual void resetInternalState(); 00110 00113 virtual void computeOutput(const Vec& input, Vec& output) const; 00114 00118 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00119 const Vec& target, Vec& costs) const; 00120 00122 virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const =0; 00123 00126 virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const; 00127 00129 virtual void setTrainingSet(VMat training_set, bool call_forget=true); 00130 00131 00132 // ******************************* 00133 // **** StafulLearner methods **** 00134 // ******************************* 00135 00138 virtual bool isStatefulLearner() const; 00139 00142 virtual void setTestSet(VMat testset); 00143 00146 virtual void setTestStartTime(int t); 00147 00149 int getTestStartTime() const { return test_start_time; } 00150 }; 00151 00152 // Declares a few other classes and functions related to this class. 00153 DECLARE_OBJECT_PTR(StatefulLearner); 00154 00155 } // end of namespace PLearn 00156 00157 #endif 00158 00159 00160 /* 00161 Local Variables: 00162 mode:c++ 00163 c-basic-offset:4 00164 c-file-style:"stroustrup" 00165 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00166 indent-tabs-mode:nil 00167 fill-column:79 00168 End: 00169 */ 00170 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :