PLearn 0.1
IsomapTangentLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // IsomapTangentLearner.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: IsomapTangentLearner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Martin Monperrus
00040 
00044 #ifndef IsomapTangentLearner_INC
00045 #define IsomapTangentLearner_INC
00046 
00047 #include <plearn_learners/generic/PLearner.h>
00048 
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class IsomapTangentLearner: 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     Isomap iso_learner;
00069     Mat k_xi_x_sorted;
00070     
00071 public:
00072 
00073     int n_comp;
00074     int knn;
00075   
00076     // ************************
00077     // * public build options *
00078     // ************************
00079 
00080     // ### declare public option fields (such as build options) here
00081     // ...
00082 
00083     // ****************
00084     // * Constructors *
00085     // ****************
00086 
00088     // (Make sure the implementation in the .cc
00089     // initializes all fields to reasonable default values)
00090     IsomapTangentLearner();
00091 
00092 
00093     // ********************
00094     // * PLearner 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(IsomapTangentLearner);
00125 
00126 
00127     // **************************
00128     // **** PLearner methods ****
00129     // **************************
00130 
00133     // (PLEASE IMPLEMENT IN .cc)
00134     virtual int outputsize() const;
00135 
00138     // (PLEASE IMPLEMENT IN .cc)
00139     virtual void forget();
00140 
00141     
00144     // (PLEASE IMPLEMENT IN .cc)
00145     virtual void train();
00146 
00147 
00149     // (PLEASE IMPLEMENT IN .cc)
00150     virtual void computeOutput(const Vec& input, Vec& output) const;
00151 
00153     // (PLEASE IMPLEMENT IN .cc)
00154     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00155                                          const Vec& target, Vec& costs) const;
00156                                 
00157 
00159     // (PLEASE IMPLEMENT IN .cc)
00160     virtual TVec<string> getTestCostNames() const;
00161 
00164     // (PLEASE IMPLEMENT IN .cc)
00165     virtual TVec<string> getTrainCostNames() const;
00166 
00167 
00168     // *** SUBCLASS WRITING: ***
00169     // While in general not necessary, in case of particular needs 
00170     // (efficiency concerns for ex) you may also want to overload
00171     // some of the following methods:
00172     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00173     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00174     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00175     // virtual int nTestCosts() const;
00176     // virtual int nTrainCosts() const;
00177 
00178 };
00179 
00180 // Declares a few other classes and functions related to this class.
00181 DECLARE_OBJECT_PTR(IsomapTangentLearner);
00182   
00183 } // end of namespace PLearn
00184 
00185 #endif
00186 
00187 
00188 /*
00189   Local Variables:
00190   mode:c++
00191   c-basic-offset:4
00192   c-file-style:"stroustrup"
00193   c-file-offsets:((innamespace . 0)(inline-open . 0))
00194   indent-tabs-mode:nil
00195   fill-column:79
00196   End:
00197 */
00198 // 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