PLearn 0.1
TestingLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TestingLearner.h
00004 //
00005 // Copyright (C) 2004 Marius Muja 
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: TestingLearner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Marius Muja
00040 
00044 #ifndef TestingLearner_INC
00045 #define TestingLearner_INC
00046 
00047 #include "PLearner.h"
00048 #include <plearn_learners/testers/PTester.h>
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class TestingLearner: public PLearner
00054 {
00055 
00056 private:
00057 
00058     typedef PLearner inherited;
00059   
00060 protected:
00061 
00062     // *********************
00063     // * protected options *
00064     // *********************
00065 
00066 public:
00067 
00068     // ************************
00069     // * public build options *
00070     // ************************
00071 
00072     PP<PTester> tester;
00073 
00074     // ****************
00075     // * Constructors *
00076     // ****************
00077 
00079     // (Make sure the implementation in the .cc
00080     // initializes all fields to reasonable default values)
00081     TestingLearner();
00082 
00083 
00084     // ********************
00085     // * PLearner methods *
00086     // ********************
00087 
00088 private: 
00089 
00091     // (Please implement in .cc)
00092     void build_();
00093 
00094 protected: 
00095   
00097     // (Please implement in .cc)
00098     static void declareOptions(OptionList& ol);
00099 
00100 public:
00101 
00102     // ************************
00103     // **** Object methods ****
00104     // ************************
00105 
00107     virtual void build();
00108 
00110     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00111 
00112     // Declares other standard object methods.
00113     // If your class is not instantiatable (it has pure virtual methods)
00114     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT.
00115     PLEARN_DECLARE_OBJECT(TestingLearner);
00116 
00117 
00118     // **************************
00119     // **** PLearner methods ****
00120     // **************************
00121 
00124     // (PLEASE IMPLEMENT IN .cc)
00125     virtual int outputsize() const;
00126 
00129     // (PLEASE IMPLEMENT IN .cc)
00130     virtual void forget();
00131 
00132     
00135     // (PLEASE IMPLEMENT IN .cc)
00136     virtual void train();
00137 
00138 
00140     // (PLEASE IMPLEMENT IN .cc)
00141     virtual void computeOutput(const Vec& input, Vec& output) const;
00142 
00144     // (PLEASE IMPLEMENT IN .cc)
00145     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00146                                          const Vec& target, Vec& costs) const;
00147                                 
00148 
00150     // (PLEASE IMPLEMENT IN .cc)
00151     virtual TVec<string> getTestCostNames() const;
00152 
00155     // (PLEASE IMPLEMENT IN .cc)
00156     virtual TVec<string> getTrainCostNames() const;
00157 
00158     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00159 
00160     void setExperimentDirectory(const PPath& the_expdir);
00161 
00162     // *** SUBCLASS WRITING: ***
00163     // While in general not necessary, in case of particular needs 
00164     // (efficiency concerns for ex) you may also want to overload
00165     // some of the following methods:
00166     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00167     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00168     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00169     // virtual int nTestCosts() const;
00170     // virtual int nTrainCosts() const;
00171     // virtual void resetInternalState();
00172     // virtual bool isStatefulLearner() const;
00173 
00174 };
00175 
00176 // Declares a few other classes and functions related to this class.
00177 DECLARE_OBJECT_PTR(TestingLearner);
00178   
00179 } // end of namespace PLearn
00180 
00181 #endif
00182 
00183 
00184 /*
00185   Local Variables:
00186   mode:c++
00187   c-basic-offset:4
00188   c-file-style:"stroustrup"
00189   c-file-offsets:((innamespace . 0)(inline-open . 0))
00190   indent-tabs-mode:nil
00191   fill-column:79
00192   End:
00193 */
00194 // 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