PLearn 0.1
SelectInputSubsetLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SelectInputSubsetLearner.h
00004 //
00005 // Copyright (C) 2004 Yoshua Bengio 
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: SelectInputSubsetLearner.h 3994 2005-08-25 13:35:03Z chapados $
00037  ******************************************************* */
00038 
00039 // Authors: Yoshua Bengio
00040 
00044 #ifndef SelectInputSubsetLearner_INC
00045 #define SelectInputSubsetLearner_INC
00046 
00047 #include "EmbeddedLearner.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class SelectInputSubsetLearner: public EmbeddedLearner
00053 {
00054 
00055 private:
00056 
00057     typedef EmbeddedLearner inherited;
00058   
00059 protected:
00060 
00061     // *********************
00062     // * protected options *
00063     // *********************
00064     Vec learner_inputs;
00065     TVec<int> all_indices; // indices of selected inputs + indices of the target and weight and other columns
00066 
00067     // ### declare protected option fields (such as learnt parameters) here
00068     
00069 public:
00070 
00071     // ************************
00072     // * public build options *
00073     // ************************
00074 
00075     // ### declare public option fields (such as build options) here
00076   
00077     // the inputs can be selected explicitly
00078     TVec<int> selected_inputs;
00079     // or they can be selected automatically and randomly
00080     // by taking a random subset from the original, if random_fraction>0
00081     // (that subset will be of size int(random_fraction*inputsize()).
00082     real random_fraction;
00083 
00084     // ****************
00085     // * Constructors *
00086     // ****************
00087 
00088     // Default constructor, make sure the implementation in the .cc
00089     // initializes all fields to reasonable default values.
00090     SelectInputSubsetLearner();
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(SelectInputSubsetLearner);
00125 
00126 
00127     // **************************
00128     // **** PLearner methods ****
00129     // **************************
00130 
00131     virtual int inputsize() const;
00132 
00134     virtual void computeOutput(const Vec& input, Vec& output) const;
00135 
00137     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00138                                          const Vec& target, Vec& costs) const;
00139                                 
00140 
00141     virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00142                                        Vec& output, Vec& costs) const;
00143 
00144     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00145 
00146 };
00147 
00148 // Declares a few other classes and functions related to this class.
00149 DECLARE_OBJECT_PTR(SelectInputSubsetLearner);
00150   
00151 } // end of namespace PLearn
00152 
00153 #endif
00154 
00155 
00156 /*
00157   Local Variables:
00158   mode:c++
00159   c-basic-offset:4
00160   c-file-style:"stroustrup"
00161   c-file-offsets:((innamespace . 0)(inline-open . 0))
00162   indent-tabs-mode:nil
00163   fill-column:79
00164   End:
00165 */
00166 // 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