PLearn 0.1
ClassErrorCostFunction.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039  * $Id: ClassErrorCostFunction.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef ClassErrorCostFunction_INC
00044 #define ClassErrorCostFunction_INC
00045 
00046 #include "Kernel.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 
00053 
00066 class ClassErrorCostFunction: public Kernel
00067 {
00068     typedef Kernel inherited;
00069   
00070 protected:
00071     bool output_is_classnum;
00072     bool ignore_missing_values;
00073 
00074 public:
00084     ClassErrorCostFunction(bool the_output_is_classnum = false,bool the_ignore_missing_values=true)
00085         :output_is_classnum(the_output_is_classnum),ignore_missing_values(the_ignore_missing_values) {}
00086 
00087     PLEARN_DECLARE_OBJECT(ClassErrorCostFunction);
00088 
00089     virtual string info() const
00090     { return "class_error"; }
00091 
00092     virtual real evaluate(const Vec& output, const Vec& target) const;
00093 
00094 protected:
00096     static void declareOptions(OptionList &ol);
00097 };
00098 
00099 DECLARE_OBJECT_PTR(ClassErrorCostFunction);
00100 
00101 inline CostFunc class_error(bool output_is_classnum=false,bool ignore_missing_values=true) 
00102 { 
00103     return new ClassErrorCostFunction(output_is_classnum, ignore_missing_values); 
00104 } 
00105 
00106 
00107 } // end of namespace PLearn
00108 
00109 #endif
00110 
00111 
00112 /*
00113   Local Variables:
00114   mode:c++
00115   c-basic-offset:4
00116   c-file-style:"stroustrup"
00117   c-file-offsets:((innamespace . 0)(inline-open . 0))
00118   indent-tabs-mode:nil
00119   fill-column:79
00120   End:
00121 */
00122 // 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