PLearn 0.1
BinaryStump.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BinaryStump.h
00004 //
00005 // Copyright (C) 2004 Hugo Larochelle 
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: BinaryStump.h 6833 2007-04-04 19:00:14Z tihocan $ 
00037  ******************************************************* */
00038 
00039 // Authors: Hugo Larochelle
00040 
00044 #ifndef BinaryStump_INC
00045 #define BinaryStump_INC
00046 
00047 #include <plearn_learners/generic/PLearner.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class BinaryStump: public PLearner
00053 {
00054 
00055 private:
00056 
00057     typedef PLearner inherited;
00058     TVec< pair<int, real> > sf;
00059 
00060 protected:
00061 
00062     // *********************
00063     // * protected options *
00064     // *********************
00065 
00066     int feature;
00067     int tag;
00068     real threshold;
00069     
00070 public:
00071 
00072     // ************************
00073     // * public build options *
00074     // ************************
00075 
00076     bool one_hot_output;
00077 
00078 
00079     // ****************
00080     // * Constructors *
00081     // ****************
00082 
00084     // (Make sure the implementation in the .cc
00085     // initializes all fields to reasonable default values)
00086     BinaryStump();
00087 
00088 
00089     // ********************
00090     // * PLearner methods *
00091     // ********************
00092 
00093 private: 
00094 
00096     // (Please implement in .cc)
00097     void build_();
00098 
00099 protected: 
00100   
00102     // (Please implement in .cc)
00103     static void declareOptions(OptionList& ol);
00104 
00105 public:
00106 
00107     // ************************
00108     // **** Object methods ****
00109     // ************************
00110 
00112     virtual void build();
00113 
00115     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00116 
00117     // Declares other standard object methods.
00118     // If your class is not instantiatable (it has pure virtual methods)
00119     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT.
00120     PLEARN_DECLARE_OBJECT(BinaryStump);
00121 
00122 
00123     // **************************
00124     // **** PLearner methods ****
00125     // **************************
00126 
00129     virtual int outputsize() const;
00130 
00133     virtual void forget();
00134 
00135     
00138     virtual void train();
00139 
00140 
00142     virtual void computeOutput(const Vec& input, Vec& output) const;
00143 
00145     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00146                                          const Vec& target, Vec& costs) const;
00147                                 
00148 
00150     virtual TVec<string> getTestCostNames() const;
00151 
00154     virtual TVec<string> getTrainCostNames() const;
00155 
00156 };
00157 
00158 // Declares a few other classes and functions related to this class.
00159 DECLARE_OBJECT_PTR(BinaryStump);
00160   
00161 } // end of namespace PLearn
00162 
00163 #endif
00164 
00165 
00166 /*
00167   Local Variables:
00168   mode:c++
00169   c-basic-offset:4
00170   c-file-style:"stroustrup"
00171   c-file-offsets:((innamespace . 0)(inline-open . 0))
00172   indent-tabs-mode:nil
00173   fill-column:79
00174   End:
00175 */
00176 // 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