PLearn 0.1
PLearnerDiagonalKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearnerDiagonalKernel.h
00004 //
00005 // Copyright (C) 2009 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 MATERN1ARDKERNEL_INC
00041 #define MATERN1ARDKERNEL_INC
00042 
00043 #include <plearn/ker/KroneckerBaseKernel.h>
00044 #include <plearn_learners/generic/PLearner.h>
00045 
00046 namespace PLearn {
00047 
00061 class PLearnerDiagonalKernel : public KroneckerBaseKernel
00062 {
00063     typedef KroneckerBaseKernel inherited;
00064 
00065 public:
00066     //#####  Public Build Options  ############################################
00067 
00069     PP<PLearner> m_learner;
00070     
00072     mutable real m_isp_signal_sigma;
00073     
00074 public:
00075     //#####  Public Member Functions  #########################################
00076 
00078     PLearnerDiagonalKernel();
00079 
00080 
00081     //#####  Kernel Member Functions  #########################################
00082 
00084     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00085 
00087     virtual void computeGramMatrix(Mat K) const;
00088     
00091     virtual void computeGramMatrixDerivative(Mat& KD, const string& kernel_param,
00092                                              real epsilon=1e-6) const;
00093     
00095     virtual void evaluate_all_i_x(const Vec& x, const Vec& k_xi_x,
00096                                   real squared_norm_of_x=-1, int istart = 0) const;
00097 
00098 
00099     //#####  PLearn::Object Protocol  #########################################
00100 
00101     // Declares other standard object methods.
00102     PLEARN_DECLARE_OBJECT(PLearnerDiagonalKernel);
00103 
00104     // Simply calls inherited::build() then build_()
00105     virtual void build();
00106 
00108     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00109 
00110 protected:
00112     static void declareOptions(OptionList& ol);
00113 
00115     void computeGramMatrixDerivIspSignalSigma(Mat& KD) const;
00116 
00117 private:
00119     void build_();
00120 
00121 private:
00123     mutable Vec m_output_buffer;
00124 };
00125 
00126 // Declares a few other classes and functions related to this class
00127 DECLARE_OBJECT_PTR(PLearnerDiagonalKernel);
00128 
00129 } // end of namespace PLearn
00130 
00131 #endif
00132 
00133 
00134 /*
00135   Local Variables:
00136   mode:c++
00137   c-basic-offset:4
00138   c-file-style:"stroustrup"
00139   c-file-offsets:((innamespace . 0)(inline-open . 0))
00140   indent-tabs-mode:nil
00141   fill-column:79
00142   End:
00143 */
00144 // 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