PLearn 0.1
RegressionTreeMulticlassLeave.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RegressionTreeMulticlassLeave.h
00004 // Copyright (c) 1998-2002 Pascal Vincent
00005 // Copyright (C) 1999-2002 Yoshua Bengio and University of Montreal
00006 // Copyright (c) 2002 Jean-Sebastien Senecal, Xavier Saint-Mleux, Rejean Ducharme
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  * $Id: RegressionTreeMulticlassLeave.h, v 1.0 2004/07/19 10:00:00 Bengio/Kegl/Godbout     *
00039  * This file is part of the PLearn library.                                      *
00040  ********************************************************************************* */
00041 
00042 #ifndef RegressionTreeMulticlassLeave_INC
00043 #define RegressionTreeMulticlassLeave_INC
00044 
00045 #include "RegressionTreeLeave.h"
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 
00050 class RegressionTreeMulticlassLeave: public RegressionTreeLeave
00051 {
00052     typedef RegressionTreeLeave inherited;
00053   
00054 private:
00055 
00056 /*
00057   Build options: they have to be set before building
00058 */
00059 
00060     Vec multiclass_outputs;
00061     string objective_function;       
00062  
00063 /*
00064   Learnt options: they are sized and initialized if need be, in initLeave(...)
00065 */
00066 
00067     real l1_loss_function_factor;
00068     real l2_loss_function_factor;
00069     Vec multiclass_weights_sum;
00070  
00071 public:
00072     RegressionTreeMulticlassLeave();
00073     virtual              ~RegressionTreeMulticlassLeave();
00074     PLEARN_DECLARE_OBJECT(RegressionTreeMulticlassLeave);
00075 
00076     static  void         declareOptions(OptionList& ol);
00077     virtual void         makeDeepCopyFromShallowCopy(CopiesMap &copies);
00078     virtual void         build();
00079     void         initStats();
00080     void         addRow(int row);
00081     void         addRow(int row, real target, real weight);
00082     void         addRow(int row, Vec outputv, Vec errorv);
00083     void         addRow(int row, real target, real weight, Vec outputv, Vec errorv);
00084     void         removeRow(int row, real target, real weight);
00085     void         removeRow(int row, Vec outputv, Vec errorv);
00086     void         removeRow(int row, real target, real weight, Vec outputv, Vec errorv);
00087     void         getOutputAndError(Vec& output, Vec& error)const;
00088     TVec<string> getOutputNames() const;
00089     void         printStats();
00090     virtual void         addLeave(PP<RegressionTreeLeave> leave);
00091     virtual void         removeLeave(PP<RegressionTreeLeave> leave);
00092 
00093 private:
00094     void         build_();
00095 };
00096 
00097 DECLARE_OBJECT_PTR(RegressionTreeMulticlassLeave);
00098 
00099 } // end of namespace PLearn
00100 
00101 #endif
00102 
00103 
00104 /*
00105   Local Variables:
00106   mode:c++
00107   c-basic-offset:4
00108   c-file-style:"stroustrup"
00109   c-file-offsets:((innamespace . 0)(inline-open . 0))
00110   indent-tabs-mode:nil
00111   fill-column:79
00112   End:
00113 */
00114 // 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