PLearn 0.1
WPLS.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // WPLS.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: WPLS.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00043 #ifndef WPLS_INC
00044 #define WPLS_INC
00045 
00046 #include <plearn_learners/generic/PLearner.h>
00047 #include <plearn/vmat/VMat_basic_stats.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class WPLS: public PLearner
00053 {
00054 
00055 public:
00056 
00057     typedef PLearner inherited;
00058   
00059 protected:
00060 
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00065     Mat B;
00066     int m;
00067     Vec mean_input;
00068     Vec mean_target;
00069     int p;
00070     Vec stddev_input;
00071     Vec stddev_target;
00072     int w;
00073     Mat W;
00074     Mat P;
00075     Mat Q;
00076 //    PP<WPLS> parent;
00077     
00078 public:
00079 
00080     // ************************
00081     // * public build options *
00082     // ************************
00083 
00084     string method;
00085     real precision;
00086     bool output_the_score;
00087     bool output_the_target;
00088     string parent_filename;   
00089     int  parent_sub;   
00090 
00091     // ****************
00092     // * Constructors *
00093     // ****************
00094 
00095     // Default constructor, make sure the implementation in the .cc
00096     // initializes all fields to reasonable default values.
00097     WPLS();
00098 
00099 
00100     // ********************
00101     // * PLearner methods *
00102     // ********************
00103 
00104 private: 
00105 
00107     void build_();
00108 
00109 protected: 
00110   
00112     static void declareOptions(OptionList& ol);
00113 
00114 public:
00115 
00116     // ************************
00117     // **** Object methods ****
00118     // ************************
00119 
00121     virtual void build();
00122 
00124     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00125 
00126     // Declares other standard object methods.
00127     // If your class is not instantiatable (it has pure virtual methods)
00128     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00129     PLEARN_DECLARE_OBJECT(WPLS);
00130 
00131 
00132     // **************************
00133     // **** PLearner methods ****
00134     // **************************
00135 
00138     virtual int outputsize() const;
00139 
00142     virtual void forget();
00143 
00146     virtual void train();
00147 
00149     virtual void computeOutput(const Vec& input, Vec& output) const;
00150 
00152     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00153                                          const Vec& target, Vec& costs) const;
00154                                 
00156     virtual TVec<string> getTestCostNames() const;
00157 
00160     virtual TVec<string> getTrainCostNames() const;
00161 
00162     // *** SUBCLASS WRITING: ***
00163     // While in general not necessary, in case of particular needs 
00164     // (efficiency concerns for ex) you may also want to overload
00165     // some of the following methods:
00166     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00167     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00168     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00169     // virtual int nTestCosts() const;
00170     // virtual int nTrainCosts() const;
00171 
00172 
00173     //***** STATIC METHODS *****
00174 
00180     static void NIPALSEigenvector(const Mat& m, Vec& v, real precision);
00181 
00182 };
00183 
00184 // Declares a few other classes and functions related to this class.
00185 DECLARE_OBJECT_PTR(WPLS);
00186   
00187 } // end of namespace PLearn
00188 
00189 #endif
00190 
00191 
00192 /*
00193   Local Variables:
00194   mode:c++
00195   c-basic-offset:4
00196   c-file-style:"stroustrup"
00197   c-file-offsets:((innamespace . 0)(inline-open . 0))
00198   indent-tabs-mode:nil
00199   fill-column:79
00200   End:
00201 */
00202 // 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