PLearn 0.1
CorrelationKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CorrelationKernel.h
00004 //
00005 // Copyright (C) 2005 Olivier Delalleau 
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: CorrelationKernel.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef CorrelationKernel_INC
00045 #define CorrelationKernel_INC
00046 
00047 #include <plearn/ker/Kernel.h>
00048 #include <plearn/vmat/VMatLanguage.h>
00049 
00050 namespace PLearn {
00051 
00052 class CorrelationKernel: public Kernel
00053 {
00054 
00055 private:
00056 
00057     typedef Kernel inherited;
00058   
00059 protected:
00060 
00061     mutable Mat correl;     
00062     mutable Mat pvalues;    
00063     Vec mean_vec;           
00064     Vec var_vec;            
00065     real min_product_var;   
00066 
00067     PP<VMatLanguage> transform_prg;
00069     TVec<string> transform_prg_fields;
00071     Vec result_vec;
00073     Vec result_transformed_vec;
00074 
00075     // *********************
00076     // * Protected options *
00077     // *********************
00078 
00079     // ### declare protected option fields (such as learnt parameters) here
00080     // ...
00081     
00082 public:
00083 
00084     // ************************
00085     // * Public build options *
00086     // ************************
00087 
00088     string correlation;
00089     string transform;
00090     real   var_threshold;
00091 
00092     // ****************
00093     // * Constructors *
00094     // ****************
00095 
00097     // Make sure the implementation in the .cc initializes all fields to
00098     // reasonable default values.
00099     CorrelationKernel();
00100 
00101     // ******************
00102     // * Kernel methods *
00103     // ******************
00104 
00105 private: 
00106 
00108     // (Please implement in .cc)
00109     void build_();
00110 
00111 protected: 
00112   
00114     // (Please implement in .cc)
00115     static void declareOptions(OptionList& ol);
00116 
00117 public:
00118 
00119     // ************************
00120     // **** Object methods ****
00121     // ************************
00122 
00124     virtual void build();
00125 
00127     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00128 
00129     // Declares other standard object methods.
00130     // If your class is not instantiatable (it has pure virtual methods)
00131     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00132     PLEARN_DECLARE_OBJECT(CorrelationKernel);
00133 
00134     // ************************
00135     // **** Kernel methods ****
00136     // ************************
00137 
00139     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00140 
00142     virtual void setDataForKernelMatrix(VMat the_data);
00143 
00144     // *** SUBCLASS WRITING: ***
00145     // While in general not necessary, in case of particular needs 
00146     // (efficiency concerns for ex) you may also want to overload
00147     // some of the following methods:
00148     // virtual real evaluate_i_j(int i, int j) const;
00149     // virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const;
00150     // virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const;
00151     // virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const;
00152     // virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const;
00153     // virtual void computeGramMatrix(Mat K) const;
00154     // virtual void addDataForKernelMatrix(const Vec& newRow);
00155     // virtual void setParameters(Vec paramvec);
00156     // virtual Vec getParameters() const;
00157   
00158 
00159 };
00160 
00161 // Declares a few other classes and functions related to this class.
00162 DECLARE_OBJECT_PTR(CorrelationKernel);
00163   
00164 } // end of namespace PLearn
00165 
00166 #endif
00167 
00168 
00169 /*
00170   Local Variables:
00171   mode:c++
00172   c-basic-offset:4
00173   c-file-style:"stroustrup"
00174   c-file-offsets:((innamespace . 0)(inline-open . 0))
00175   indent-tabs-mode:nil
00176   fill-column:79
00177   End:
00178 */
00179 // 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