PLearn 0.1
PrecomputedProcessedLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PrecomputedProcessedLearner.h
00004 //
00005 // Copyright (C) 2006 Nicolas Chapados
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 // Authors: Nicolas Chapados
00036 
00039 #ifndef PrecomputedProcessedLearner_INC
00040 #define PrecomputedProcessedLearner_INC
00041 
00042 #include <plearn_learners/generic/PLearner.h>
00043 
00044 namespace PLearn {
00045 
00063 class PrecomputedProcessedLearner : public PLearner
00064 {
00065     typedef PLearner inherited;
00066 
00067 public:
00068     //#####  Public Build Options  ############################################
00069 
00078     string m_precomp_type;
00079 
00080 public:
00081     //#####  Public Member Functions  #########################################
00082 
00084     PrecomputedProcessedLearner();
00085 
00086 
00087     //#####  PLearner Member Functions  #######################################
00088 
00090     virtual int outputsize() const;
00091 
00093     virtual void forget();
00094 
00096     virtual void train();
00097 
00099     virtual void computeOutput(const Vec& input, Vec& output) const;
00100 
00102     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00103                                          const Vec& target, Vec& costs) const;
00104 
00106     virtual TVec<std::string> getTestCostNames() const;
00107 
00109     virtual TVec<std::string> getTrainCostNames() const;
00110 
00117     virtual VMat processDataSet(VMat dataset) const;
00118 
00119 
00120     //#####  PLearn::Object Protocol  #########################################
00121 
00122     // Declares other standard object methods.
00123     PLEARN_DECLARE_OBJECT(PrecomputedProcessedLearner);
00124 
00125     // Simply calls inherited::build() then build_()
00126     virtual void build();
00127 
00129     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00130 
00131 protected:
00133     static void declareOptions(OptionList& ol);
00134 
00135 private:
00137     void build_();
00138 };
00139 
00140 // Declares a few other classes and functions related to this class
00141 DECLARE_OBJECT_PTR(PrecomputedProcessedLearner);
00142 
00143 } // end of namespace PLearn
00144 
00145 #endif
00146 
00147 
00148 /*
00149   Local Variables:
00150   mode:c++
00151   c-basic-offset:4
00152   c-file-style:"stroustrup"
00153   c-file-offsets:((innamespace . 0)(inline-open . 0))
00154   indent-tabs-mode:nil
00155   fill-column:79
00156   End:
00157 */
00158 // 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