PLearn 0.1
BinaryBallTree.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BinaryBallTree.h
00004 //
00005 // Copyright (C) 2004 Pascal Lamblin 
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: BinaryBallTree.h 6863 2007-04-09 20:15:52Z saintmlx $ 
00037  ******************************************************* */
00038 
00039 // Authors: Pascal Lamblin
00040 
00044 #ifndef BinaryBallTree_INC
00045 #define BinaryBallTree_INC
00046 
00047 #include <plearn/base/Object.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class BinaryBallTree;
00053 typedef PP<BinaryBallTree> BinBallTree;
00054 
00055 class BinaryBallTree: public Object
00056 {
00057 
00058 private:
00059   
00060     typedef Object inherited;
00061 
00062 protected:
00063     // *********************
00064     // * protected options *
00065     // *********************
00066 
00067     BinaryBallTree* parent;
00068     BinBallTree child1;
00069     BinBallTree child2;
00070 
00071 public:
00072 
00073     // ************************
00074     // * public build options *
00075     // ************************
00076 
00077     Vec pivot;
00078     real radius;
00079     TVec<int> point_set;
00080 
00081     // ****************
00082     // * Constructors *
00083     // ****************
00084 
00086     BinaryBallTree();
00087 
00088 
00089     // ******************
00090     // * Object methods *
00091     // ******************
00092 
00093 private: 
00095     void build_();
00096 
00097 protected: 
00099     static void declareOptions(OptionList& ol);
00100 
00101 public:
00102     // Declares other standard object methods.
00103     PLEARN_DECLARE_OBJECT(BinaryBallTree);
00104 
00105     // simply calls inherited::build() then build_() 
00106     virtual void build();
00107 
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00111     virtual void setFirstChild( const BinBallTree& first_child );
00112 
00113     virtual void setSecondChild( const BinBallTree& second_child );
00114 
00115     virtual BinBallTree getFirstChild();
00116 
00117     virtual BinBallTree getSecondChild();
00118 
00119     virtual BinaryBallTree* getParent();
00120 
00121     bool isEmpty() const
00122     {
00123         bool result = !pivot && !child1 && !child2 ;
00124         return result;
00125     }
00126 
00127 };
00128 
00129 // Declares a few other classes and functions related to this class
00130 DECLARE_OBJECT_PTR(BinaryBallTree);
00131   
00132 } // end of namespace PLearn
00133 
00134 #endif
00135 
00136 
00137 /*
00138   Local Variables:
00139   mode:c++
00140   c-basic-offset:4
00141   c-file-style:"stroustrup"
00142   c-file-offsets:((innamespace . 0)(inline-open . 0))
00143   indent-tabs-mode:nil
00144   fill-column:79
00145   End:
00146 */
00147 // 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