PLearn 0.1
SummationKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SummationKernel.h
00004 //
00005 // Copyright (C) 2007 Nicolas Chapados
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 // Authors: Nicolas Chapados
00036 
00040 #ifndef SummationKernel_INC
00041 #define SummationKernel_INC
00042 
00043 #include <plearn/ker/Kernel.h>
00044 
00045 namespace PLearn {
00046 
00054 class SummationKernel : public Kernel
00055 {
00056     typedef Kernel inherited;
00057 
00058 public:
00059     //#####  Public Build Options  ############################################
00060 
00066     TVec<Ker> m_terms;
00067 
00076     TVec< TVec<int> > m_input_indexes;
00077 
00078 public:
00079     //#####  Public Member Functions  #########################################
00080 
00082     SummationKernel();
00083 
00084 
00085     //#####  Kernel Member Functions  #########################################
00086 
00088     virtual void setDataForKernelMatrix(VMat the_data);
00089 
00091     virtual void addDataForKernelMatrix(const Vec& newRow);
00092 
00094     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00095 
00097     virtual real evaluate_i_x(int i, const Vec& x, real) const;
00098     
00101     virtual void evaluate_all_i_x(const Vec& x, const Vec& k_xi_x,
00102                                   real squared_norm_of_x=-1, int istart = 0) const;
00103 
00105     virtual void computeGramMatrix(Mat K) const;
00106     
00109     virtual void computeGramMatrixDerivative(Mat& KD, const string& kernel_param,
00110                                              real epsilon=1e-6) const;
00111     
00112 
00113     //#####  PLearn::Object Protocol  #########################################
00114 
00115     // Declares other standard object methods.
00116     PLEARN_DECLARE_OBJECT(SummationKernel);
00117 
00118     // Simply calls inherited::build() then build_()
00119     virtual void build();
00120 
00122     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00123 
00124 protected:
00126     TVec<Vec> m_input_buf1;
00127     TVec<Vec> m_input_buf2;
00128 
00130     mutable Vec m_eval_buf;
00131     
00133     mutable Mat m_gram_buf;
00134 
00135 protected:
00137     static void declareOptions(OptionList& ol);
00138 
00139 private:
00141     void build_();
00142 };
00143 
00144 // Declares a few other classes and functions related to this class
00145 DECLARE_OBJECT_PTR(SummationKernel);
00146 
00147 } // end of namespace PLearn
00148 
00149 #endif
00150 
00151 
00152 /*
00153   Local Variables:
00154   mode:c++
00155   c-basic-offset:4
00156   c-file-style:"stroustrup"
00157   c-file-offsets:((innamespace . 0)(inline-open . 0))
00158   indent-tabs-mode:nil
00159   fill-column:79
00160   End:
00161 */
00162 // 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