PLearn 0.1
RankLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RankLearner.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: RankLearner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef RankLearner_INC
00045 #define RankLearner_INC
00046 
00047 #include <plearn_learners/generic/EmbeddedLearner.h>
00048 #include <plearn/vmat/RankedVMatrix.h>
00049 
00050 namespace PLearn {
00051 
00052 class RankLearner: public EmbeddedLearner {
00053 
00054 private:
00055 
00056     typedef EmbeddedLearner inherited;
00057   
00058 protected:
00059 
00060     // *********************
00061     // * protected options *
00062     // *********************
00063 
00064     Vec sorted_targets;
00065 
00066     // Fields below are not options.
00067 
00070     mutable Vec last_output;
00071   
00073     mutable Vec learner_output;
00074 
00077     Vec learner_target;
00078 
00080     PP<RankedVMatrix> ranked_trainset;
00081 
00082 public:
00083 
00084     // ************************
00085     // * public build options *
00086     // ************************
00087 
00088     // ****************
00089     // * Constructors *
00090     // ****************
00091 
00093     RankLearner();
00094 
00095     // ********************
00096     // * PLearner methods *
00097     // ********************
00098 
00099 private: 
00100 
00102     void build_();
00103 
00104 protected: 
00105   
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     PLEARN_DECLARE_OBJECT(RankLearner);
00123 
00124     // **************************
00125     // **** PLearner methods ****
00126     // **************************
00127 
00130     virtual int outputsize() const;
00131 
00134     virtual void forget();
00135     
00137     virtual void computeOutput(const Vec& input, Vec& output) const;
00138 
00140     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00141                                          const Vec& target, Vec& costs) const;
00142 
00144     virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00145                                        Vec& output, Vec& costs) const;
00146 
00149     virtual TVec<std::string> getTestCostNames() const;
00150 
00154     virtual TVec<std::string> getTrainCostNames() const;
00155 
00158     virtual void setTrainingSet(VMat training_set, bool call_forget = true);
00159 
00161     virtual void train();
00162 
00163     // *** SUBCLASS WRITING: ***
00164     // While in general not necessary, in case of particular needs 
00165     // (efficiency concerns for ex) you may also want to overload
00166     // some of the following methods:
00167     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00168     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00169     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00170     // virtual int nTestCosts() const;
00171     // virtual int nTrainCosts() const;
00172     // virtual void resetInternalState();
00173     // virtual bool isStatefulLearner() const;
00174 
00175 };
00176 
00177 // Declares a few other classes and functions related to this class.
00178 DECLARE_OBJECT_PTR(RankLearner);
00179   
00180 } // end of namespace PLearn
00181 
00182 #endif
00183 
00184 
00185 /*
00186   Local Variables:
00187   mode:c++
00188   c-basic-offset:4
00189   c-file-style:"stroustrup"
00190   c-file-offsets:((innamespace . 0)(inline-open . 0))
00191   indent-tabs-mode:nil
00192   fill-column:79
00193   End:
00194 */
00195 // 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