PLearn 0.1
KroneckerBaseKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // KroneckerBaseKernel.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 KroneckerBaseKernel_INC
00041 #define KroneckerBaseKernel_INC
00042 
00043 #include <plearn/ker/MemoryCachedKernel.h>
00044 
00045 namespace PLearn {
00046 
00072 class KroneckerBaseKernel : public MemoryCachedKernel
00073 {
00074     typedef MemoryCachedKernel inherited;
00075 
00076 public:
00077     //#####  Public Build Options  ############################################
00078 
00081     TVec<int> m_kronecker_indexes;
00082 
00083 public:
00084     //#####  Public Member Functions  #########################################
00085 
00087     KroneckerBaseKernel();
00088 
00089 
00090     //#####  Kernel Member Functions  #########################################
00091 
00093     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00094 
00097     virtual void computeGramMatrix(Mat K) const;
00098     
00099 
00100     //#####  PLearn::Object Protocol  #########################################
00101 
00102     // Declares other standard object methods.
00103     PLEARN_DECLARE_OBJECT(KroneckerBaseKernel);
00104 
00105     // Simply calls inherited::build() then build_()
00106     virtual void build();
00107 
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00111 protected:
00118     mutable real m_default_value;
00119     
00120 protected:
00122     static void declareOptions(OptionList& ol);
00123 
00131     static real softplusFloor(real& value, real floor=1e-6);
00132 
00133 private:
00135     void build_();
00136 };
00137 
00138 // Declares a few other classes and functions related to this class
00139 DECLARE_OBJECT_PTR(KroneckerBaseKernel);
00140 
00141 } // end of namespace PLearn
00142 
00143 #endif
00144 
00145 
00146 /*
00147   Local Variables:
00148   mode:c++
00149   c-basic-offset:4
00150   c-file-style:"stroustrup"
00151   c-file-offsets:((innamespace . 0)(inline-open . 0))
00152   indent-tabs-mode:nil
00153   fill-column:79
00154   End:
00155 */
00156 // 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