PLearn 0.1
VMatKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // VMatKernel.h
00004 //
00005 // Copyright (C) 2005 Benoit Cromp 
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: VMatKernel.h 8130 2007-10-02 20:59:36Z louradou $ 
00037  ******************************************************* */
00038 
00039 // Authors: Benoit Cromp
00040 
00044 #ifndef VMatKernel_INC
00045 #define VMatKernel_INC
00046 
00047 #include "Kernel.h"
00048 #include <plearn/vmat/VMat.h>
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class VMatKernel: public Kernel
00054 {
00055 
00056 private:
00057 
00058     typedef Kernel inherited;
00059   
00060 protected:
00061 
00062     // *********************
00063     // * Protected options *
00064     // *********************
00065 
00066     // *************************
00067     // * Public learnt options *
00068     // *************************
00069 
00070     Vec train_indices;
00071     
00072 public:
00073 
00074     // ************************
00075     // * Public build options *
00076     // ************************ 
00077 
00078     VMat source;
00079 
00080 
00081     // ### declare public option fields (such as build options) here
00082     // ...
00083 
00084     // ****************
00085     // * Constructors *
00086     // ****************
00087 
00089     // Make sure the implementation in the .cc initializes all fields to
00090     // reasonable default values.
00091     VMatKernel();
00092 
00093     // ******************
00094     // * Kernel methods *
00095     // ******************
00096 
00097 private: 
00098 
00100     // (Please implement in .cc)
00101     void build_();
00102 
00103 protected: 
00104   
00106     // (Please implement in .cc)
00107     static void declareOptions(OptionList& ol);
00108 
00109 public:
00110 
00111     // ************************
00112     // **** Object methods ****
00113     // ************************
00114 
00116     virtual void build();
00117 
00119     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00120 
00121     // Declares other standard object methods.
00122     // If your class is not instantiatable (it has pure virtual methods)
00123     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00124     PLEARN_DECLARE_OBJECT(VMatKernel);
00125 
00126     // ************************
00127     // **** Kernel methods ****
00128     // ************************
00129 
00131     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00132     virtual real evaluate(real x1, real x2) const;
00133     virtual real evaluate(int x1, int x2) const;
00134 
00136     virtual void setDataForKernelMatrix(VMat the_data);
00137     virtual void addDataForKernelMatrix(const Vec& newRow);
00138     virtual real evaluate_i_j(int i, int j) const; 
00139     virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const;
00140     virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const;
00141     virtual void computeGramMatrix(Mat K) const;   
00142     
00144     // virtual void setParameters(Vec paramvec);
00145     // virtual Vec getParameters() const;
00146 };
00147 
00148 // Declares a few other classes and functions related to this class.
00149 DECLARE_OBJECT_PTR(VMatKernel);
00150   
00151 } // end of namespace PLearn
00152 
00153 #endif
00154 
00155 
00156 /*
00157   Local Variables:
00158   mode:c++
00159   c-basic-offset:4
00160   c-file-style:"stroustrup"
00161   c-file-offsets:((innamespace . 0)(inline-open . 0))
00162   indent-tabs-mode:nil
00163   fill-column:79
00164   End:
00165 */
00166 // 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