PLearn 0.1
ManifoldParzen.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ManifoldParzen.h
00004 //
00005 // Copyright (C) 2007 Hugo Larochelle
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 // Authors: Hugo Larochelle
00036 
00040 #ifndef ManifoldParzen_INC
00041 #define ManifoldParzen_INC
00042 
00043 #include <plearn/vmat/ClassSubsetVMatrix.h>
00044 #include <plearn_learners/generic/PLearner.h>
00045 
00046 namespace PLearn {
00047 
00051 class ManifoldParzen : public PLearner
00052 {
00053     typedef PLearner inherited;
00054 
00055 public:
00056     //#####  Public Build Options  ############################################
00057 
00060     int nneighbors;
00061 
00063     int ncomponents;
00064 
00066     real global_lambda0;
00067 
00069     bool learn_mu;
00070 
00072     int nclasses;
00073 
00074 public:
00075     //#####  Public Member Functions  #########################################
00076 
00078     ManifoldParzen();
00079 
00080     //#####  PLearner Member Functions  #######################################
00081 
00084     virtual int outputsize() const;
00085 
00089     virtual void forget();
00090 
00094     virtual void train();
00095 
00097     virtual void computeOutput(const Vec& input, Vec& output) const;
00098 
00100     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00101                                          const Vec& target, Vec& costs) const;
00102 
00105     virtual TVec<std::string> getTestCostNames() const;
00106 
00109     virtual TVec<std::string> getTrainCostNames() const;
00110 
00118     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00119 
00120     //#####  PLearn::Object Protocol  #########################################
00121 
00122     // Declares other standard object methods.
00123     // ### If your class is not instantiatable (it has pure virtual methods)
00124     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00125     PLEARN_DECLARE_OBJECT(ManifoldParzen);
00126 
00127     // Simply calls inherited::build() then build_()
00128     virtual void build();
00129 
00131     // (PLEASE IMPLEMENT IN .cc)
00132     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00133 
00134 protected:
00135     //#####  Not Options  #####################################################
00136 
00138     mutable Vec mu;
00139 
00141     mutable Mat Ut, U, V;
00142     mutable Vec diff_neighbor_input, uk, sm_svd, S, diff;
00143 
00144     // Saved components of manifold parzen windows
00146     mutable TVec<Mat> eigenvectors;
00148     mutable Mat eigenvalues;
00150     mutable Vec sigma_noises;
00152     mutable Mat mus;
00153 
00155     TVec< PP<ClassSubsetVMatrix> > class_datasets;
00156 
00159     //Vec class_proportions;
00160 
00162     TMat<int> nearest_neighbors_indices;
00163 
00165     mutable Vec test_votes;
00166 
00167 protected:
00168     //#####  Protected Member Functions  ######################################
00169 
00171     static void declareOptions(OptionList& ol);
00172 
00173 private:
00174     //#####  Private Member Functions  ########################################
00175 
00177     void build_();
00178 
00179 private:
00180     //#####  Private Data Members  ############################################
00181 
00182     // The rest of the private stuff goes here    
00183 };
00184 
00185 // Declares a few other classes and functions related to this class
00186 DECLARE_OBJECT_PTR(ManifoldParzen);
00187 
00188 } // end of namespace PLearn
00189 
00190 #endif
00191 
00192 
00193 /*
00194   Local Variables:
00195   mode:c++
00196   c-basic-offset:4
00197   c-file-style:"stroustrup"
00198   c-file-offsets:((innamespace . 0)(inline-open . 0))
00199   indent-tabs-mode:nil
00200   fill-column:79
00201   End:
00202 */
00203 // 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