PLearn 0.1
VPLCombinedLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // VPLCombinedLearner.h
00004 //
00005 // Copyright (C) 2005, 2006 Pascal Vincent 
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: VPLCombinedLearner.h 5480 2006-05-03 18:57:39Z plearner $ 
00037  ******************************************************* */
00038 
00039 // Authors: Pascal Vincent
00040 
00044 #ifndef VPLCombinedLearner_INC
00045 #define VPLCombinedLearner_INC
00046 
00047 #include <plearn_learners/generic/PLearner.h>
00048 #include <plearn/vmat/VMatLanguage.h>
00049 
00050 namespace PLearn {
00051 
00052 class VPLCombinedLearner: public PLearner
00053 {
00054 
00055 private:
00056 
00057     typedef PLearner inherited;
00058   
00059 protected:
00060 
00061     VMatLanguage output_prg_;
00062     VMatLanguage costs_prg_;
00063 
00064     TVec<string> outputnames_;
00065     TVec<string> costnames_;
00066 
00067     mutable Vec invec_for_output_prg;
00068     mutable Vec invec_for_costs_prg;
00069 
00070     TVec<int> sublearners_outputsizes;
00071     TVec<int> sublearners_ntestcosts;
00072     
00073 
00074     // *********************
00075     // * protected options *
00076     // *********************
00077 
00078     TVec<string> orig_fieldnames; // fieldnames of training set
00079     int orig_inputsize; // inputsize of training set
00080     int orig_targetsize; // targetsize of training set
00081 
00082     
00083 public:
00084 
00085     // ************************
00086     // * public build options *
00087     // ************************
00088 
00090     TVec< PP<PLearner> > sublearners_;
00091 
00092     string output_prg;
00093     string costs_prg;
00094   
00095     // ****************
00096     // * Constructors *
00097     // ****************
00098 
00100     // (Make sure the implementation in the .cc
00101     // initializes all fields to reasonable default values)
00102     VPLCombinedLearner();
00103 
00104 
00105     // ********************
00106     // * PLearner methods *
00107     // ********************
00108 
00109 private: 
00110 
00112     void build_();
00113 
00114     void initializeOutputPrograms();
00115     void initializeCostNames();
00116 
00117 protected: 
00118   
00120     // (Please implement in .cc)
00121     static void declareOptions(OptionList& ol);
00122 
00123 public:
00124 
00125     // ************************
00126     // **** Object methods ****
00127     // ************************
00128 
00130     virtual void build();
00131 
00133     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
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.
00138     PLEARN_DECLARE_OBJECT(VPLCombinedLearner);
00139 
00140 
00141     // **************************
00142     // **** PLearner methods ****
00143     // **************************
00144 
00145     virtual int outputsize() const;
00146     
00148     virtual void setValidationSet(VMat validset);
00149 
00151     virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol);
00152 
00154     virtual void setExperimentDirectory(const PPath& the_expdir);
00155  
00157     virtual void forget();
00158 
00159     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00160 
00161     virtual void train();
00162 
00163     virtual void computeOutput(const Vec& input, Vec& output) const;
00164 
00165     virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 
00166                                        Vec& output, Vec& costs) const;
00167 
00168     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00169                                          const Vec& target, Vec& costs) const;
00170 
00171     virtual TVec<string> getOutputNames() const;
00172 
00173     virtual TVec<std::string> getTestCostNames() const;
00174 
00175     virtual TVec<string> getTrainCostNames() const;
00176 
00177     virtual void resetInternalState();
00178 
00179     virtual bool isStatefulLearner() const;
00180 };
00181 
00182 // Declares a few other classes and functions related to this class.
00183 DECLARE_OBJECT_PTR(VPLCombinedLearner);
00184   
00185 } // end of namespace PLearn
00186 
00187 #endif
00188 
00189 
00190 /*
00191   Local Variables:
00192   mode:c++
00193   c-basic-offset:4
00194   c-file-style:"stroustrup"
00195   c-file-offsets:((innamespace . 0)(inline-open . 0))
00196   indent-tabs-mode:nil
00197   fill-column:79
00198   End:
00199 */
00200 // 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