PLearn 0.1
EmbeddedSequentialLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // EmbeddedSequentialLearner.h
00004 //
00005 // Copyright (C) 2003 Rejean Ducharme, Yoshua Bengio
00006 // Copyright (C) 2003 Pascal Vincent
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 
00037 
00038 #ifndef EMBEDDED_SEQUENTIAL_LEARNER
00039 #define EMBEDDED_SEQUENTIAL_LEARNER
00040 
00041 #include "SequentialLearner.h"
00042 
00043 namespace PLearn {
00044 using namespace std;
00045 
00051 class EmbeddedSequentialLearner: public SequentialLearner
00052 {
00053 public:
00054 
00055     PP<PLearner> learner;  // the underlying Learner
00056 
00057 private:
00059     void build_();
00060 
00061 protected:
00063     static void declareOptions(OptionList& ol);
00064 
00065 public:
00066 
00068     EmbeddedSequentialLearner();
00069 
00071     virtual void build();
00072     
00074     virtual void train();
00075  
00082     virtual void test(VMat testset, PP<VecStatsCollector> test_stats,
00083                       VMat testoutputs=0, VMat testcosts=0) const;
00084 
00087     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00088 
00089     // PLearner methods to be passed to the underlying Learner
00090 
00091     virtual void forget();
00092  
00093     virtual void computeOutput(const Vec& input, Vec& output);
00094  
00095     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00096                                          const Vec& target, Vec& costs);
00097  
00098     virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00099                                        Vec& output, Vec& costs);
00100  
00101     virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs);
00102  
00103     virtual TVec<string> getTestCostNames() const;
00104  
00105     virtual TVec<string> getTrainCostNames() const;
00106 
00108     PLEARN_DECLARE_OBJECT(EmbeddedSequentialLearner);
00109 
00110 };
00111 
00113 DECLARE_OBJECT_PTR(EmbeddedSequentialLearner);
00114 
00115 } // end of namespace PLearn
00116 
00117 #endif
00118 
00119 
00120 /*
00121   Local Variables:
00122   mode:c++
00123   c-basic-offset:4
00124   c-file-style:"stroustrup"
00125   c-file-offsets:((innamespace . 0)(inline-open . 0))
00126   indent-tabs-mode:nil
00127   fill-column:79
00128   End:
00129 */
00130 // 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