PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // NeighborhoodBoxVolumeDensityEstimator.h 00004 // 00005 // Copyright (C) 2006 Pascal Vincent 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: NeighborhoodBoxVolumeDensityEstimator.h 5388 2006-04-13 21:28:14Z lamblin $ 00037 ******************************************************* */ 00038 00039 // Authors: Pascal Vincent 00040 00044 #ifndef NeighborhoodBoxVolumeDensityEstimator_INC 00045 #define NeighborhoodBoxVolumeDensityEstimator_INC 00046 00047 #include <plearn_learners/distributions/UnconditionalDistribution.h> 00048 #include <plearn/ker/Kernel.h> 00049 #include <plearn_learners/nearest_neighbors/GenericNearestNeighbors.h> 00050 00051 namespace PLearn { 00052 00053 class NeighborhoodBoxVolumeDensityEstimator: public UnconditionalDistribution 00054 { 00055 00056 private: 00057 00058 typedef UnconditionalDistribution inherited; 00059 00061 mutable Vec trainsample; 00062 00063 protected: 00064 00065 // ********************* 00066 // * protected options * 00067 // ********************* 00068 00069 PP<GenericNearestNeighbors> NN; 00070 mutable Vec NN_outputs; 00071 00072 00073 public: 00074 00075 // ************************ 00076 // * public build options * 00077 // ************************ 00078 00079 int nneighbors; 00080 real min_radius; 00081 00082 // **************** 00083 // * Constructors * 00084 // **************** 00085 00087 NeighborhoodBoxVolumeDensityEstimator(); 00088 00089 // ************************* 00090 // * PDistribution methods * 00091 // ************************* 00092 00093 private: 00094 00096 // ### Please implement in .cc. 00097 void build_(); 00098 00099 protected: 00100 00102 bool box_contains(const Vec& center, const Vec& radius, const Vec& input) const; 00103 00104 00106 // ### Please implement in .cc. 00107 static void declareOptions(OptionList& ol); 00108 00109 public: 00110 00111 // ************************ 00112 // **** Object methods **** 00113 // ************************ 00114 00116 virtual void build(); 00117 00119 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00120 00121 // Declare other standard object methods. 00122 // ### If your class is not instantiatable (it has pure virtual methods) 00123 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS. 00124 PLEARN_DECLARE_OBJECT(NeighborhoodBoxVolumeDensityEstimator); 00125 00126 // ******************************* 00127 // **** PDistribution methods **** 00128 // ******************************* 00129 00131 virtual real log_density(const Vec& x) const; 00132 00133 // ************************** 00134 // **** PLearner methods **** 00135 // ************************** 00136 00139 // ### You may remove this method if your distribution does not implement it. 00140 virtual void train(); 00141 00142 virtual void forget(); 00143 00144 }; 00145 00146 // Declare a few other classes and functions related to this class. 00147 DECLARE_OBJECT_PTR(NeighborhoodBoxVolumeDensityEstimator); 00148 00149 } // end of namespace PLearn 00150 00151 #endif 00152 00153 00154 /* 00155 Local Variables: 00156 mode:c++ 00157 c-basic-offset:4 00158 c-file-style:"stroustrup" 00159 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00160 indent-tabs-mode:nil 00161 fill-column:79 00162 End: 00163 */ 00164 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :