PLearn 0.1
NegLogProbCostFunction.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: NegLogProbCostFunction.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef NegLogProbCostFunction_INC
00044 #define NegLogProbCostFunction_INC
00045 
00046 #include "Kernel.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 
00062 class NegLogProbCostFunction: public Kernel
00063 {
00064     typedef Kernel inherited;
00065                 
00066 public:
00067     bool normalize;
00068     bool smooth_map_outputs;
00069 #if USING_MPI
00070     int out_start;
00071     int out_end;
00072 #endif
00073 public:
00074 #if USING_MPI
00075     NegLogProbCostFunction(bool do_normalize=false, bool do_smooth_map_outputs=false,
00076                            int outstart=-1, int outend=-1)
00077         :normalize(do_normalize), smooth_map_outputs(do_smooth_map_outputs),
00078          out_start(outstart), out_end(outend) {}
00079 #else
00080     NegLogProbCostFunction(bool do_normalize=false, bool do_smooth_map_outputs=false)
00081         : normalize(do_normalize), smooth_map_outputs(do_smooth_map_outputs) {}
00082 #endif
00083     PLEARN_DECLARE_OBJECT(NegLogProbCostFunction);
00084 
00085     virtual string info() const
00086     { return "negative_log_probability"; }
00087 
00088     virtual real evaluate(const Vec& output, const Vec& target) const;
00089 
00090 protected:
00092     static void declareOptions(OptionList &ol);
00093 };
00094 
00095 DECLARE_OBJECT_PTR(NegLogProbCostFunction);
00096 
00098 #if USING_MPI
00099 inline CostFunc condprob_cost(bool normalize=false, bool smooth_map_outputs=false,
00100                               int outstart=-1, int outend=-1)
00101 { return new NegLogProbCostFunction(normalize,smooth_map_outputs,outstart,outend); }
00102 #else
00103 inline CostFunc condprob_cost(bool normalize=false, bool smooth_map_outputs=false)
00104 { return new NegLogProbCostFunction(normalize,smooth_map_outputs); }
00105 #endif
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