PLearn 0.1
LocallyMagnifiedDistribution.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // LocallyMagnifiedDistribution.h
00004 //
00005 // Copyright (C) 2005 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: LocallyMagnifiedDistribution.h 7469 2007-05-31 18:55:48Z plearner $
00037  ******************************************************* */
00038 
00039 // Authors: Pascal Vincent
00040 
00044 #ifndef LocallyMagnifiedDistribution_INC
00045 #define LocallyMagnifiedDistribution_INC
00046 
00047 #include <plearn_learners/distributions/PDistribution.h>
00048 #include <plearn/ker/Kernel.h>
00049 #include <plearn_learners/nearest_neighbors/GenericNearestNeighbors.h>
00050 
00051 namespace PLearn {
00052 
00053 class LocallyMagnifiedDistribution: public PDistribution
00054 {
00055 
00056 private:
00057 
00058     typedef PDistribution inherited;
00059 
00061     mutable Vec trainsample, weights;
00062 
00063 protected:
00064 
00065     mutable bool display_adapted_width;
00066 
00067     Vec emptyvec;
00068     mutable Vec NN_outputs;
00069     mutable Vec NN_costs;
00070 
00071     // *********************
00072     // * protected options *
00073     // *********************
00074 
00075     PP<GenericNearestNeighbors> NN;
00076 
00077 public:
00078 
00079     // ************************
00080     // * public build options *
00081     // ************************
00082     int mode;
00083     real computation_neighbors;
00084 
00085     Ker weighting_kernel;
00086     char kernel_adapt_width_mode;
00087 
00089     mutable PP<PDistribution> localdistr;
00090     bool fix_localdistr_center;
00091 
00092     real width_neighbors;
00093     real width_factor;
00094     string width_optionname;
00095 
00096     // ****************
00097     // * Constructors *
00098     // ****************
00099 
00101     LocallyMagnifiedDistribution();
00102 
00103     // *************************
00104     // * PDistribution methods *
00105     // *************************
00106 
00107 private:
00108 
00110     // ### Please implement in .cc.
00111     void build_();
00112 
00113 protected:
00114 
00116     // ### Please implement in .cc.
00117     static void declareOptions(OptionList& ol);
00118 
00119     int getActualNComputationNeighbors() const;
00120     int getActualNWidthNeighbors() const;
00121     double trainLocalDistrAndEvaluateLogDensity(VMat local_trainset, Vec y) const;
00122 
00123 public:
00124 
00125     // ************************
00126     // **** Object methods ****
00127     // ************************
00128 
00130     virtual void build();
00131 
00133     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00134 
00135     // Declare other standard object methods.
00136     // ### If your class is not instantiatable (it has pure virtual methods)
00137     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00138     PLEARN_DECLARE_OBJECT(LocallyMagnifiedDistribution);
00139 
00140     // *******************************
00141     // **** PDistribution methods ****
00142     // *******************************
00143 
00145     virtual real log_density(const Vec& x) const;
00146 
00147     // **************************
00148     // **** PLearner methods ****
00149     // **************************
00150 
00153     // ### You may remove this method if your distribution does not implement it.
00154     virtual void train();
00155 
00156     virtual void forget();
00157 
00158 };
00159 
00160 // Declare a few other classes and functions related to this class.
00161 DECLARE_OBJECT_PTR(LocallyMagnifiedDistribution);
00162 
00163 } // end of namespace PLearn
00164 
00165 #endif
00166 
00167 
00168 /*
00169   Local Variables:
00170   mode:c++
00171   c-basic-offset:4
00172   c-file-style:"stroustrup"
00173   c-file-offsets:((innamespace . 0)(inline-open . 0))
00174   indent-tabs-mode:nil
00175   fill-column:79
00176   End:
00177 */
00178 // 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