PLearn 0.1
ClassMarginCostFunction.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: ClassMarginCostFunction.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef ClassMarginCostFunction_INC
00044 #define ClassMarginCostFunction_INC
00045 
00046 #include "Kernel.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 
00070 class ClassMarginCostFunction: public Kernel
00071 {
00072     typedef Kernel inherited;
00073 
00074 public:
00075     bool binary_target_is_01;
00076     bool output_is_positive;
00077     ClassMarginCostFunction(bool the_binary_target_is_01=false, 
00078                             bool out_is_positive=false)
00079         : binary_target_is_01(the_binary_target_is_01), 
00080           output_is_positive(out_is_positive) {}
00081 
00082     PLEARN_DECLARE_OBJECT(ClassMarginCostFunction);
00083 
00084     virtual string info() const
00085     { return "class_margin"; }
00086     virtual real evaluate(const Vec& output, const Vec& target) const;  
00087 
00088 protected:
00090     static void declareOptions(OptionList &ol);  
00091 };
00092 
00093 DECLARE_OBJECT_PTR(ClassMarginCostFunction);
00094 
00096 inline CostFunc class_margin(bool binary_target_is_01=false, 
00097                              bool output_is_positive=false) 
00098 { return new ClassMarginCostFunction(binary_target_is_01,output_is_positive); }
00099 
00100 } // end of namespace PLearn
00101 
00102 #endif
00103 
00104 
00105 /*
00106   Local Variables:
00107   mode:c++
00108   c-basic-offset:4
00109   c-file-style:"stroustrup"
00110   c-file-offsets:((innamespace . 0)(inline-open . 0))
00111   indent-tabs-mode:nil
00112   fill-column:79
00113   End:
00114 */
00115 // 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