PLearn 0.1
KernelRidgeRegressor.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // KernelRidgeRegressor.h
00004 //
00005 // Copyright (C) 2005 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 /* *******************************************************      
00036    * $Id: .pyskeleton_header 544 2003-09-01 00:05:31Z plearner $ 
00037    ******************************************************* */
00038 
00039 // Authors: Nicolas Chapados
00040 
00044 #ifndef KernelRidgeRegressor_INC
00045 #define KernelRidgeRegressor_INC
00046 
00047 // From PLearn
00048 #include <plearn/ker/Kernel.h>
00049 #include <plearn_learners/generic/PLearner.h>
00050 
00051 namespace PLearn {
00052 
00077 class KernelRidgeRegressor : public PLearner
00078 {
00079     typedef PLearner inherited;
00080 
00081 public:
00082     //#####  Public Build Options  ############################################
00083 
00085     bool m_include_bias;
00086     
00089     Ker m_kernel;
00090 
00092     real m_weight_decay;
00093     
00094 
00095 public:
00096     //#####  Public Member Functions  #########################################
00097 
00099     KernelRidgeRegressor();
00100 
00101 
00102     //#####  PLearner Member Functions  #######################################
00103 
00106     virtual int outputsize() const;
00107 
00111     virtual void forget();
00112     
00116     virtual void train();
00117 
00119     virtual void computeOutput(const Vec& input, Vec& output) const;
00120 
00122     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00123                                          const Vec& target, Vec& costs) const;
00124     
00127     virtual TVec<std::string> getTestCostNames() const;
00128 
00131     virtual TVec<std::string> getTrainCostNames() const;
00132 
00133 
00134     //#####  PLearn::Object Protocol  #########################################
00135 
00136     // Declares other standard object methods.
00137     PLEARN_DECLARE_OBJECT(KernelRidgeRegressor);
00138 
00139     // Simply calls inherited::build() then build_() 
00140     virtual void build();
00141 
00143     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00144 
00145 protected:
00146     //#####  Protected Options  ###############################################
00147 
00151     Mat m_params;
00152 
00155     VMat m_training_inputs;
00156 
00158     mutable Vec m_kernel_evaluations;
00159     
00160 protected:
00162     static void declareOptions(OptionList& ol);
00163 
00164 private: 
00166     void build_();
00167 };
00168 
00169 // Declares a few other classes and functions related to this class
00170 DECLARE_OBJECT_PTR(KernelRidgeRegressor);
00171   
00172 } // end of namespace PLearn
00173 
00174 #endif
00175 
00176 
00177 /*
00178   Local Variables:
00179   mode:c++
00180   c-basic-offset:4
00181   c-file-style:"stroustrup"
00182   c-file-offsets:((innamespace . 0)(inline-open . 0))
00183   indent-tabs-mode:nil
00184   fill-column:79
00185   End:
00186 */
00187 // 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