00001 // -*- C++ -*- 00002 00003 // LLEKernel.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: LLEKernel.h,v 1.5 2004/07/21 15:55:21 tihocan Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Olivier Delalleau 00040 00044 #ifndef LLEKernel_INC 00045 #define LLEKernel_INC 00046 00047 #include "Kernel.h" 00048 #include "ReconstructionWeightsKernel.h" 00049 00050 namespace PLearn { 00051 using namespace std; 00052 00053 class LLEKernel: public Kernel 00054 { 00055 00056 private: 00057 00058 typedef Kernel inherited; 00059 00061 bool build_in_progress; 00062 00065 mutable bool x_is_training_point; 00066 00069 mutable int x_index; 00070 00071 protected: 00072 00073 // ********************* 00074 // * Protected options * 00075 // ********************* 00076 00077 // Fields below are not options. 00078 00080 PP<ReconstructionWeightsKernel> reconstruct_ker; 00081 00082 public: 00083 00084 // ************************ 00085 // * Public build options * 00086 // ************************ 00087 00088 int knn; 00089 real reconstruct_coeff; 00090 real regularizer; 00091 00092 // **************** 00093 // * Constructors * 00094 // **************** 00095 00097 LLEKernel(); 00098 00099 // ****************** 00100 // * Kernel methods * 00101 // ****************** 00102 00103 private: 00104 00106 void build_(); 00107 00108 protected: 00109 00111 static void declareOptions(OptionList& ol); 00112 00113 public: 00114 00115 // ************************ 00116 // **** Object methods **** 00117 // ************************ 00118 00120 virtual void build(); 00121 00123 virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies); 00124 00125 // Declares other standard object methods. 00126 PLEARN_DECLARE_OBJECT(LLEKernel); 00127 00128 // ************************** 00129 // **** Kernel methods **** 00130 // ************************** 00131 00133 virtual void computeGramMatrix(Mat K) const; 00134 00136 virtual real evaluate(const Vec& x1, const Vec& x2) const; 00137 00138 virtual real evaluate_i_j(int i, int j) const; 00139 00140 virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const; 00141 00142 virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const; 00143 00144 virtual void setDataForKernelMatrix(VMat the_data); 00145 00146 // *** SUBCLASS WRITING: *** 00147 // While in general not necessary, in case of particular needs 00148 // (efficiency concerns for ex) you may also want to overload 00149 // some of the following methods: 00150 // virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const; 00151 // virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const; 00152 // virtual void addDataForKernelMatrix(const Vec& newRow); 00153 // virtual void setParameters(Vec paramvec); 00154 // virtual Vec getParameters() const; 00155 00156 00157 }; 00158 00159 // Declares a few other classes and functions related to this class. 00160 DECLARE_OBJECT_PTR(LLEKernel); 00161 00162 } // end of namespace PLearn 00163 00164 #endif 00165