PLearn 0.1
ToBagClassifier.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ToBagClassifier.h
00004 //
00005 // Copyright (C) 2007 Olivier Delalleau
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: Olivier Delalleau
00036 
00040 #ifndef ToBagClassifier_INC
00041 #define ToBagClassifier_INC
00042 
00043 #include <plearn_learners/generic/EmbeddedLearner.h>
00044 
00045 namespace PLearn {
00046 
00057 class ToBagClassifier : public EmbeddedLearner
00058 {
00059     typedef EmbeddedLearner inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00064     int n_classes;
00065 
00066 public:
00067     //#####  Public Member Functions  #########################################
00068 
00070     // ### Make sure the implementation in the .cc
00071     // ### initializes all fields to reasonable default values.
00072     ToBagClassifier();
00073 
00074     //#####  PLearner Member Functions  #######################################
00075 
00077     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00078 
00080     virtual int targetsize() const;
00081 
00083     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00084                                          const Vec& target, Vec& costs) const;
00085 
00087     virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00088                                        Vec& output, Vec& costs) const;
00089 
00091     virtual void computeOutputsAndCosts(const Mat& input, const Mat& target,
00092                                         Mat& output, Mat& costs) const
00093     {
00094         PLearner::computeOutputsAndCosts(input, target, output, costs);
00095     }
00096 
00098     virtual TVec<string> getTestCostNames() const;
00099 
00100     //#####  PLearn::Object Protocol  #########################################
00101 
00102     // Declares other standard object methods.
00103     // ### If your class is not instantiatable (it has pure virtual methods)
00104     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00105     PLEARN_DECLARE_OBJECT(ToBagClassifier);
00106 
00107     // Simply calls inherited::build() then build_()
00108     virtual void build();
00109 
00111     // (PLEASE IMPLEMENT IN .cc)
00112     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00113 
00114 protected:
00115 
00117     mutable Vec sub_target;
00118 
00120     mutable Mat bag_output;
00121 
00123     mutable Vec votes;
00124 
00125     //#####  Protected Options  ###############################################
00126 
00127     // ### Declare protected option fields (such as learned parameters) here
00128     // ...
00129 
00130 protected:
00131     //#####  Protected Member Functions  ######################################
00132 
00134     static void declareOptions(OptionList& ol);
00135 
00139     void updateCostAndBagOutput(const Vec& target, const Vec& output,
00140                                 Vec& costs) const;
00141 
00143     void fillSubTarget(const Vec& target) const;
00144 
00145 private:
00146     //#####  Private Member Functions  ########################################
00147 
00149     // (PLEASE IMPLEMENT IN .cc)
00150     void build_();
00151 
00152 private:
00153     //#####  Private Data Members  ############################################
00154 
00155     // The rest of the private stuff goes here
00156 };
00157 
00158 // Declares a few other classes and functions related to this class
00159 DECLARE_OBJECT_PTR(ToBagClassifier);
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