PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // BinaryKernelDiscrimination.h 00004 // 00005 // Copyright (C) 2006 Pierre-Jean L Heureux 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: .pyskeleton_header 544 2003-09-01 00:05:31Z plearner $ 00037 ******************************************************* */ 00038 00039 // Authors: Pierre-Jean L Heureux 00040 00044 #ifndef BinaryKernelDiscrimination_INC 00045 #define BinaryKernelDiscrimination_INC 00046 00047 #include <plearn/ker/Kernel.h> 00048 00049 namespace PLearn { 00050 00061 class BinaryKernelDiscrimination : public Kernel 00062 { 00063 typedef Kernel inherited; 00064 00065 public: 00066 //##### Public Build Options ############################################ 00067 00070 00071 float K; 00072 float lambda; 00073 bool ExpOutput; 00074 00075 public: 00076 //##### Public Member Functions ######################################### 00077 00079 // ### Make sure the implementation in the .cc 00080 // ### initializes all fields to reasonable default values. 00081 BinaryKernelDiscrimination(); 00082 00083 00084 //##### Kernel Member Functions ######################################### 00085 00087 virtual real evaluate(const Vec& x1, const Vec& x2) const; 00088 00089 // *** SUBCLASS WRITING: *** 00090 // While in general not necessary, in case of particular needs 00091 // (efficiency concerns for ex) you may also want to overload 00092 // some of the following methods: 00093 // virtual real evaluate_i_j(int i, int j) const; 00094 // virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const; 00095 // virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const; 00096 // virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const; 00097 // virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const; 00098 // virtual void computeGramMatrix(Mat K) const; 00099 // virtual void setDataForKernelMatrix(VMat the_data); 00100 // virtual void addDataForKernelMatrix(const Vec& newRow); 00101 // virtual void setParameters(Vec paramvec); 00102 // virtual Vec getParameters() const; 00103 00104 00105 //##### PLearn::Object Protocol ######################################### 00106 00107 // Declares other standard object methods. 00108 // ### If your class is not instantiatable (it has pure virtual methods) 00109 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00110 PLEARN_DECLARE_OBJECT(BinaryKernelDiscrimination); 00111 00112 // Simply calls inherited::build() then build_() 00113 virtual void build(); 00114 00116 // (PLEASE IMPLEMENT IN .cc) 00117 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00118 00119 protected: 00120 //##### Protected Options ############################################### 00121 00122 // ### Declare protected option fields (such as learned parameters) here 00123 // ... 00124 00125 protected: 00126 //##### Protected Member Functions ###################################### 00127 00129 // (PLEASE IMPLEMENT IN .cc) 00130 static void declareOptions(OptionList& ol); 00131 00132 private: 00133 //##### Private Member Functions ######################################## 00134 00136 // (PLEASE IMPLEMENT IN .cc) 00137 void build_(); 00138 00139 private: 00140 //##### Private Data Members ############################################ 00141 00142 // The rest of the private stuff goes here 00143 }; 00144 00145 // Declares a few other classes and functions related to this class 00146 DECLARE_OBJECT_PTR(BinaryKernelDiscrimination); 00147 00148 } // end of namespace PLearn 00149 00150 #endif 00151 00152 00153 /* 00154 Local Variables: 00155 mode:c++ 00156 c-basic-offset:4 00157 c-file-style:"stroustrup" 00158 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00159 indent-tabs-mode:nil 00160 fill-column:79 00161 End: 00162 */ 00163 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :