PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RankingFromKernel.h 00004 // 00005 // Copyright (C) 2006 Pierre-Jean L Heureux 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: .pyskeleton_header 544 2003-09-01 00:05:31Z plearner $ 00037 ******************************************************* */ 00038 00039 // Authors: Pierre-Jean L Heureux 00040 00044 #ifndef RankingFromKernel_INC 00045 #define RankingFromKernel_INC 00046 00047 #include <plearn/ker/Kernel.h> 00048 #include <plearn_learners/generic/PLearner.h> 00049 00050 namespace PLearn { 00051 00062 class RankingFromKernel : public PLearner 00063 { 00064 typedef PLearner inherited; 00065 00066 public: 00067 //##### Public Build Options ############################################ 00068 00071 00073 PP<Kernel> logKernel; 00074 00075 public: 00076 //##### Public Member Functions ######################################### 00077 00079 // ### Make sure the implementation in the .cc 00080 // ### initializes all fields to reasonable default values. 00081 RankingFromKernel(); 00082 00083 00084 //##### PLearner Member Functions ####################################### 00085 00088 // (PLEASE IMPLEMENT IN .cc) 00089 virtual int outputsize() const; 00090 00094 // (PLEASE IMPLEMENT IN .cc) 00095 virtual void forget(); 00096 00100 // (PLEASE IMPLEMENT IN .cc) 00101 virtual void train(); 00102 00104 // (PLEASE IMPLEMENT IN .cc) 00105 virtual void computeOutput(const Vec& input, Vec& output) const; 00106 00108 // (PLEASE IMPLEMENT IN .cc) 00109 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00110 const Vec& target, Vec& costs) const; 00111 00114 // (PLEASE IMPLEMENT IN .cc) 00115 virtual TVec<std::string> getTestCostNames() const; 00116 00119 // (PLEASE IMPLEMENT IN .cc) 00120 virtual TVec<std::string> getTrainCostNames() const; 00121 00122 00123 // *** SUBCLASS WRITING: *** 00124 // While in general not necessary, in case of particular needs 00125 // (efficiency concerns for ex) you may also want to overload 00126 // some of the following methods: 00127 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const; 00128 // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const; 00129 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const; 00130 // virtual int nTestCosts() const; 00131 // virtual int nTrainCosts() const; 00132 // virtual void resetInternalState(); 00133 // virtual bool isStatefulLearner() const; 00134 00135 00136 //##### PLearn::Object Protocol ######################################### 00137 00138 // Declares other standard object methods. 00139 // ### If your class is not instantiatable (it has pure virtual methods) 00140 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00141 PLEARN_DECLARE_OBJECT(RankingFromKernel); 00142 00143 // Simply calls inherited::build() then build_() 00144 virtual void build(); 00145 00147 // (PLEASE IMPLEMENT IN .cc) 00148 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00149 00150 protected: 00151 00152 mutable Vec x,target; 00153 //##### Protected Options ############################################### 00154 00155 // ### Declare protected option fields (such as learned parameters) here 00156 mutable Vec log_act,log_inact; 00157 00158 protected: 00159 //##### Protected Member Functions ###################################### 00160 00162 // (PLEASE IMPLEMENT IN .cc) 00163 static void declareOptions(OptionList& ol); 00164 00165 private: 00166 //##### Private Member Functions ######################################## 00167 00169 // (PLEASE IMPLEMENT IN .cc) 00170 void build_(); 00171 00172 private: 00173 //##### Private Data Members ############################################ 00174 00175 // The rest of the private stuff goes here 00176 }; 00177 00178 // Declares a few other classes and functions related to this class 00179 DECLARE_OBJECT_PTR(RankingFromKernel); 00180 00181 } // end of namespace PLearn 00182 00183 #endif 00184 00185 00186 /* 00187 Local Variables: 00188 mode:c++ 00189 c-basic-offset:4 00190 c-file-style:"stroustrup" 00191 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00192 indent-tabs-mode:nil 00193 fill-column:79 00194 End: 00195 */ 00196 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :