PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // LLC.h 00004 // 00005 // Copyright (C) 2005 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: LLC.h 3994 2005-08-25 13:35:03Z chapados $ 00037 ******************************************************* */ 00038 00039 // Authors: Olivier Delalleau 00040 00044 #ifndef LLC_INC 00045 #define LLC_INC 00046 00047 #include <plearn_learners/generic/PLearner.h> 00048 00049 namespace PLearn { 00050 00051 class LLC: public PLearner { 00052 00053 private: 00054 00055 typedef PLearner inherited; 00056 00057 protected: 00058 00060 mutable Vec mixture_output; 00061 00062 // ********************* 00063 // * protected options * 00064 // ********************* 00065 00066 Mat L; 00067 int sum_of_dim; 00068 00069 public: 00070 00071 // ************************ 00072 // * public build options * 00073 // ************************ 00074 00075 int knn; 00076 PP<PLearner> mixture; 00077 int n_comp; 00078 real regularization; 00079 bool train_mixture; 00080 00081 // **************** 00082 // * Constructors * 00083 // **************** 00084 00086 LLC(); 00087 00088 // ******************** 00089 // * PLearner methods * 00090 // ******************** 00091 00092 private: 00093 00095 void build_(); 00096 00097 protected: 00098 00100 static void declareOptions(OptionList& ol); 00101 00102 public: 00103 00104 // ************************ 00105 // **** Object methods **** 00106 // ************************ 00107 00109 virtual void build(); 00110 00112 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00113 00114 // Declares other standard object methods. 00115 PLEARN_DECLARE_OBJECT(LLC); 00116 00117 // ************************** 00118 // **** PLearner methods **** 00119 // ************************** 00120 00123 virtual int outputsize() const; 00124 00127 virtual void forget(); 00128 00131 virtual void train(); 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 00141 virtual TVec<std::string> getTestCostNames() const; 00142 00145 virtual TVec<std::string> getTrainCostNames() const; 00146 00147 // *** SUBCLASS WRITING: *** 00148 // While in general not necessary, in case of particular needs 00149 // (efficiency concerns for ex) you may also want to overload 00150 // some of the following methods: 00151 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const; 00152 // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const; 00153 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const; 00154 // virtual int nTestCosts() const; 00155 // virtual int nTrainCosts() const; 00156 // virtual void setTrainingSet(VMat training_set, bool call_forget = true); 00157 // virtual void resetInternalState(); 00158 // virtual bool isStatefulLearner() const; 00159 00160 }; 00161 00162 // Declares a few other classes and functions related to this class. 00163 DECLARE_OBJECT_PTR(LLC); 00164 00165 } // end of namespace PLearn 00166 00167 #endif 00168 00169 00170 /* 00171 Local Variables: 00172 mode:c++ 00173 c-basic-offset:4 00174 c-file-style:"stroustrup" 00175 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00176 indent-tabs-mode:nil 00177 fill-column:79 00178 End: 00179 */ 00180 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :