PLearn 0.1
ClassifierFromDensity.h
Go to the documentation of this file.
00001 
00002 // -*- C++ -*-
00003 
00004 // ClassifierFromDensity.h
00005 //
00006 // Copyright (C) 20032-2005  Pascal Vincent & Olivier Delalleau
00007 // 
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 // 
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 // 
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 // 
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 // 
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 // 
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 /* *******************************************************      
00037  * $Id: ClassifierFromDensity.h 6639 2007-02-08 20:31:30Z tihocan $ 
00038  ******************************************************* */
00039 
00041 #ifndef ClassifierFromDensity_INC
00042 #define ClassifierFromDensity_INC
00043 
00044 #include <plearn_learners/distributions/PDistribution.h>
00045 #include <plearn_learners/generic/PLearner.h>
00046 
00047 namespace PLearn {
00048 
00049 class ClassifierFromDensity: public PLearner
00050 {
00051 
00052 private:
00053 
00054     typedef PLearner inherited;
00055 
00056 public:
00057 
00058 
00059     // ************************
00060     // * public build options *
00061     // ************************
00062 
00063     int nclasses;
00064     TVec< PP<PDistribution> > estimators;
00065     Vec log_priors;
00066     bool output_log_probabilities;
00067     bool normalize_probabilities;
00068     Vec use_these_priors;
00069     bool using_template_estimator;
00070     // ****************
00071     // * Constructors *
00072     // ****************
00073 
00075     ClassifierFromDensity();
00076 
00077     // ******************
00078     // * PLearner methods *
00079     // ******************
00080 
00081 private: 
00082 
00084     void build_();
00085 
00086 protected: 
00087 
00089     static void declareOptions(OptionList& ol);
00090 
00091 public:
00092 
00093     // ************************
00094     // **** Object methods ****
00095     // ************************
00096 
00098     virtual void build();
00099 
00101     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00102 
00103     // Declares other standard object methods
00104     //  If your class is not instantiatable (it has pure virtual methods)
00105     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
00106     PLEARN_DECLARE_OBJECT(ClassifierFromDensity);
00107 
00108 
00109     // **************************
00110     // **** PLearner methods ****
00111     // **************************
00112 
00115     virtual int outputsize() const;
00116 
00119     virtual void forget();
00120 
00121     
00124     virtual void train();
00125 
00126 
00128     virtual void computeOutput(const Vec& input, Vec& output) const;
00129 
00131     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00132                                          const Vec& target, Vec& costs) const;
00133                                 
00134 
00136     virtual TVec<string> getTestCostNames() const;
00137 
00140     virtual TVec<string> getTrainCostNames() const;
00141 
00142 
00143 };
00144 
00145 // Declares a few other classes and functions related to this class
00146 DECLARE_OBJECT_PTR(ClassifierFromDensity);
00147   
00148 } // end of namespace PLearn
00149 
00150 #endif
00151 
00152 
00153 /*
00154   Local Variables:
00155   mode:c++
00156   c-basic-offset:4
00157   c-file-style:"stroustrup"
00158   c-file-offsets:((innamespace . 0)(inline-open . 0))
00159   indent-tabs-mode:nil
00160   fill-column:79
00161   End:
00162 */
00163 // 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