PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // KMeansClustering.h 00004 // 00005 // Copyright (C) 2004 Jean-Sébastien Senécal 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: KMeansClustering.h 6863 2007-04-09 20:15:52Z saintmlx $ 00037 ******************************************************* */ 00038 00039 // Authors: Jean-Sébastien Senécal 00040 00044 #ifndef KMeansClustering_INC 00045 #define KMeansClustering_INC 00046 00047 #include <plearn_learners/generic/PLearner.h> 00048 00049 namespace PLearn { 00050 using namespace std; 00051 00056 class KMeansClustering: public PLearner 00057 { 00058 private: 00059 typedef PLearner inherited; 00060 00061 public: 00063 int n_clusters_; 00064 00066 Mat clusters_; 00067 00069 KMeansClustering(); 00070 00071 private: 00073 void build_(); 00074 00075 protected: 00077 static void declareOptions(OptionList& ol); 00078 00079 public: 00081 virtual void build(); 00082 00084 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00085 00086 // Declares other standard object methods. 00087 PLEARN_DECLARE_OBJECT(KMeansClustering); 00088 00091 virtual int outputsize() const; 00092 00095 virtual void forget(); 00096 00099 virtual void train(); 00100 00103 virtual void computeOutput(const Vec& input, Vec& output) const; 00104 00106 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00107 const Vec& target, Vec& costs) const; 00108 00110 virtual TVec<string> getTestCostNames() const; 00111 00114 virtual TVec<string> getTrainCostNames() const; 00115 00116 00117 // *** SUBCLASS WRITING: *** 00118 // While in general not necessary, in case of particular needs 00119 // (efficiency concerns for ex) you may also want to overload 00120 // some of the following methods: 00121 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const; 00122 // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const; 00123 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const; 00124 // virtual int nTestCosts() const; 00125 // virtual int nTrainCosts() const; 00126 // virtual void resetInternalState(); 00127 // virtual bool isStatefulLearner() const; 00128 00129 }; 00130 00131 // Declares a few other classes and functions related to this class. 00132 DECLARE_OBJECT_PTR(KMeansClustering); 00133 00134 } // end of namespace PLearn 00135 00136 #endif 00137 00138 00139 /* 00140 Local Variables: 00141 mode:c++ 00142 c-basic-offset:4 00143 c-file-style:"stroustrup" 00144 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00145 indent-tabs-mode:nil 00146 fill-column:79 00147 End: 00148 */ 00149 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :