PLearn 0.1
RegressionTreeQueue.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RegressionTreeQueue.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: RegressionTreeQueue.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 RegressionTreeQueue_INC
00043 #define RegressionTreeQueue_INC
00044 
00045 #include <plearn/base/Object.h>
00046 
00047 namespace PLearn {
00048 using namespace std;
00049 class RegressionTreeNode;
00050 
00051 class RegressionTreeQueue: public Object
00052 {
00053     typedef Object inherited;
00054   
00055 private:
00056 
00057 /*
00058   Build options: they have to be set before training
00059 */
00060 
00061     int verbosity;
00062     int maximum_number_of_nodes;
00063   
00064 /*
00065   Learnt options: they are sized and initialized if need be, in initHeap()
00066 */
00067 
00068     int next_available_node;
00069     TVec< PP<RegressionTreeNode> > nodes;
00070   
00071 public:
00072   
00073     RegressionTreeQueue();
00074     RegressionTreeQueue(int verbosity, int maximum_number_of_nodes);
00075 
00076     virtual              ~RegressionTreeQueue();
00077     PLEARN_DECLARE_OBJECT(RegressionTreeQueue);
00078 
00079     static  void         declareOptions(OptionList& ol);
00080     virtual void         makeDeepCopyFromShallowCopy(CopiesMap &copies);
00081     virtual void         build();
00082     void         addHeap(PP<RegressionTreeNode> new_node);
00083     PP<RegressionTreeNode>   popHeap();
00084     PP<RegressionTreeNode>   upHeap(PP<RegressionTreeNode> new_node, int node_ind);
00085     PP<RegressionTreeNode>   downHeap(PP<RegressionTreeNode> new_node, int node_ind);
00086     int          isEmpty();
00087     int          compareNode(PP<RegressionTreeNode> node1, PP<RegressionTreeNode> node2);
00088   
00089 private:
00090     void         build_();
00091     void         verbose(string msg, int level);
00092 };
00093 
00094 DECLARE_OBJECT_PTR(RegressionTreeQueue);
00095 
00096 } // end of namespace PLearn
00097 
00098 #endif
00099 
00100 
00101 /*
00102   Local Variables:
00103   mode:c++
00104   c-basic-offset:4
00105   c-file-style:"stroustrup"
00106   c-file-offsets:((innamespace . 0)(inline-open . 0))
00107   indent-tabs-mode:nil
00108   fill-column:79
00109   End:
00110 */
00111 // 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