PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // GeodesicDistanceKernel.h 00004 // 00005 // Copyright (C) 2004 Olivier Delalleau 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: GeodesicDistanceKernel.h 8428 2008-01-30 16:23:53Z tihocan $ 00037 ******************************************************* */ 00038 00039 // Authors: Olivier Delalleau 00040 00044 #ifndef GeodesicDistanceKernel_INC 00045 #define GeodesicDistanceKernel_INC 00046 00047 #include "Kernel.h" 00048 00049 namespace PLearn { 00050 using namespace std; 00051 00052 class GeodesicDistanceKernel: public Kernel 00053 { 00054 00055 private: 00056 00057 typedef Kernel inherited; 00058 00060 mutable Mat dist_xi_x_sorted1, dist_xi_x_sorted2, dist_xi_x_sorted; 00061 00062 protected: 00063 00064 // ********************* 00065 // * Protected options * 00066 // ********************* 00067 00068 public: 00069 00070 // ************************ 00071 // * Public build options * 00072 // ************************ 00073 00074 Ker distance_kernel; 00075 PPath geodesic_file; 00076 int knn; 00077 bool pow_distance; 00078 string shortest_algo; 00079 VMat geo_distances; 00080 00081 // **************** 00082 // * Constructors * 00083 // **************** 00084 00086 GeodesicDistanceKernel(); 00087 00089 GeodesicDistanceKernel(Ker the_distance_kernel, int the_knn = 10, 00090 const PPath& the_geodesic_file = "", 00091 bool the_pow_distance = false, 00092 const string& the_method = "floyd", 00093 bool call_build_ = true); 00094 00095 // ****************** 00096 // * Kernel methods * 00097 // ****************** 00098 00099 private: 00100 00102 void build_(); 00103 00104 protected: 00105 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 // Declares 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(GeodesicDistanceKernel); 00125 00126 // ************************ 00127 // **** Kernel methods **** 00128 // ************************ 00129 00136 int computeNearestGeodesicNeighbour(int i, const Mat& distances_xi_x_sorted, real* dist_i = 0) const; 00137 00143 real computeShortestDistance(int i, const Mat& distances_xi_x_sorted) const; 00144 00146 virtual real evaluate(const Vec& x1, const Vec& x2) const; 00147 00148 virtual real evaluate_i_j(int i, int j) const; 00149 00150 virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const; 00151 00152 virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const; 00153 00156 virtual real evaluate_i_x_from_distances(int i, const Mat& distances_xi_x_sorted) const; 00157 00159 virtual void setDataForKernelMatrix(VMat the_data); 00160 00161 // *** SUBCLASS WRITING: *** 00162 // While in general not necessary, in case of particular needs 00163 // (efficiency concerns for ex) you may also want to overload 00164 // some of the following methods: 00165 // virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const; 00166 // virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const; 00167 // virtual void computeGramMatrix(Mat K) const; 00168 // virtual void addDataForKernelMatrix(const Vec& newRow); 00169 // virtual void setParameters(Vec paramvec); 00170 // virtual Vec getParameters() const; 00171 00172 00173 }; 00174 00175 // Declares a few other classes and functions related to this class. 00176 DECLARE_OBJECT_PTR(GeodesicDistanceKernel); 00177 00178 } // end of namespace PLearn 00179 00180 #endif 00181 00182 00183 /* 00184 Local Variables: 00185 mode:c++ 00186 c-basic-offset:4 00187 c-file-style:"stroustrup" 00188 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00189 indent-tabs-mode:nil 00190 fill-column:79 00191 End: 00192 */ 00193 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :