PLearn 0.1
KPCATangentLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // KPCATangentLearner.h
00004 //
00005 // Copyright (C) 2004 Martin Monperrus 
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: KPCATangentLearner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Martin Monperrus
00040 
00044 #ifndef KPCATangentLearner_INC
00045 #define KPCATangentLearner_INC
00046 
00047 #include "plearn_learners/generic/PLearner.h"
00048 
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class KPCATangentLearner: public PLearner
00054 {
00055 
00056 private:
00057 
00058     typedef PLearner inherited;
00059   
00060 protected:
00061 
00062     // *********************
00063     // * protected options *
00064     // *********************
00065 
00066     // ### declare protected option fields (such as learnt parameters) here
00067     // ...
00068     KernelPCA KPCA;
00069 public:
00070 
00071     int n_comp;
00072     real sigma;
00073   
00074     // ************************
00075     // * public build options *
00076     // ************************
00077 
00078     // ### declare public option fields (such as build options) here
00079     // ...
00080 
00081     // ****************
00082     // * Constructors *
00083     // ****************
00084 
00086     // (Make sure the implementation in the .cc
00087     // initializes all fields to reasonable default values)
00088     KPCATangentLearner();
00089 
00090 
00091     // ********************
00092     // * PLearner methods *
00093     // ********************
00094 
00095 private: 
00096 
00098     // (Please implement in .cc)
00099     void build_();
00100 
00101 protected: 
00102   
00104     // (Please implement in .cc)
00105     static void declareOptions(OptionList& ol);
00106 
00107 public:
00108 
00109     // ************************
00110     // **** Object methods ****
00111     // ************************
00112 
00114     virtual void build();
00115 
00117     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00118 
00119     // Declares other standard object methods.
00120     // If your class is not instantiatable (it has pure virtual methods)
00121     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00122     PLEARN_DECLARE_OBJECT(KPCATangentLearner);
00123 
00124 
00125     // **************************
00126     // **** PLearner methods ****
00127     // **************************
00128 
00131     // (PLEASE IMPLEMENT IN .cc)
00132     virtual int outputsize() const;
00133 
00136     // (PLEASE IMPLEMENT IN .cc)
00137     virtual void forget();
00138 
00139     
00142     // (PLEASE IMPLEMENT IN .cc)
00143     virtual void train();
00144 
00145 
00147     // (PLEASE IMPLEMENT IN .cc)
00148     virtual void computeOutput(const Vec& input, Vec& output) const;
00149 
00151     // (PLEASE IMPLEMENT IN .cc)
00152     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00153                                          const Vec& target, Vec& costs) const;
00154                                 
00155 
00157     // (PLEASE IMPLEMENT IN .cc)
00158     virtual TVec<string> getTestCostNames() const;
00159 
00162     // (PLEASE IMPLEMENT IN .cc)
00163     virtual TVec<string> getTrainCostNames() const;
00164 
00165 
00166     // *** SUBCLASS WRITING: ***
00167     // While in general not necessary, in case of particular needs 
00168     // (efficiency concerns for ex) you may also want to overload
00169     // some of the following methods:
00170     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00171     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00172     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00173     // virtual int nTestCosts() const;
00174     // virtual int nTrainCosts() const;
00175 
00176 };
00177 
00178 // Declares a few other classes and functions related to this class.
00179 DECLARE_OBJECT_PTR(KPCATangentLearner);
00180   
00181 } // end of namespace PLearn
00182 
00183 #endif
00184 
00185 
00186 /*
00187   Local Variables:
00188   mode:c++
00189   c-basic-offset:4
00190   c-file-style:"stroustrup"
00191   c-file-offsets:((innamespace . 0)(inline-open . 0))
00192   indent-tabs-mode:nil
00193   fill-column:79
00194   End:
00195 */
00196 // 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