PLearn 0.1
AdditiveNormalizationKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // AdditiveNormalizationKernel.h
00004 //
00005 // Copyright (C) 2004 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: AdditiveNormalizationKernel.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef AdditiveNormalizationKernel_INC
00045 #define AdditiveNormalizationKernel_INC
00046 
00047 #include "SourceKernel.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class AdditiveNormalizationKernel: public SourceKernel
00053 {
00054 
00055 private:
00056 
00057     typedef SourceKernel inherited;
00058 
00060     mutable Vec all_k_x;
00061   
00062 protected:
00063 
00064     // *********************
00065     // * Protected options *
00066     // *********************
00067 
00068     Vec average_col;
00069     Vec average_row;
00070     real total_average;
00071     real total_average_unbiased;
00072 
00073     // Fields below are not options.
00074 
00076     mutable real avg_evaluate_i_x_again;
00077 
00079     mutable real avg_evaluate_x_i_again;
00080 
00082     real factor;
00083 
00084 public:
00085 
00086     // ************************
00087     // * Public build options *
00088     // ************************
00089 
00090     bool data_will_change;
00091     bool double_centering;
00092     bool remove_bias;
00093     bool remove_bias_in_evaluate;
00094 
00095     // ****************
00096     // * Constructors *
00097     // ****************
00098 
00100     AdditiveNormalizationKernel();
00101 
00103     AdditiveNormalizationKernel
00104     (Ker the_source, bool remove_bias = false, bool remove_bias_in_evaluate = false,
00105      bool double_centering = false);
00106 
00107     // ************************
00108     // * SourceKernel methods *
00109     // ************************
00110 
00111 private: 
00112 
00114     void build_();
00115 
00116 protected: 
00117   
00119     static void declareOptions(OptionList& ol);
00120 
00123     inline real computeAverage(const Vec& x, bool on_row, real squared_norm_of_x = -1) const;
00124 
00125 public:
00126 
00127     // ************************
00128     // **** Object methods ****
00129     // ************************
00130 
00132     virtual void build();
00133 
00135     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00136 
00137     // Declares other standard object methods.
00138     PLEARN_DECLARE_OBJECT(AdditiveNormalizationKernel);
00139 
00140     // ******************************
00141     // **** SourceKernel methods ****
00142     // ******************************
00143 
00145     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00146     virtual real evaluate_i_j(int i, int j) const;
00147     virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const;
00148     virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const;
00149     virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const;
00150     virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const;
00151     virtual void computeGramMatrix(Mat K) const;
00152     virtual void setDataForKernelMatrix(VMat the_data);
00153   
00154     // You may also want to override these methods if you don't want them
00155     // to be directly forwarded to the underlying kernel.
00156     // virtual void addDataForKernelMatrix(const Vec& newRow);
00157     // virtual void setParameters(Vec paramvec);
00158     // virtual Vec getParameters() const;
00159 
00160 };
00161 
00162 // Declares a few other classes and functions related to this class.
00163 DECLARE_OBJECT_PTR(AdditiveNormalizationKernel);
00164   
00165 } // end of namespace PLearn
00166 
00167 #endif
00168 
00169 
00170 /*
00171   Local Variables:
00172   mode:c++
00173   c-basic-offset:4
00174   c-file-style:"stroustrup"
00175   c-file-offsets:((innamespace . 0)(inline-open . 0))
00176   indent-tabs-mode:nil
00177   fill-column:79
00178   End:
00179 */
00180 // 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