PLearn 0.1
BinaryClassificationLossVariable.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 // Copyright (C) 2004 Olivier Delalleau
00009 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are met:
00012 // 
00013 //  1. Redistributions of source code must retain the above copyright
00014 //     notice, this list of conditions and the following disclaimer.
00015 // 
00016 //  2. Redistributions in binary form must reproduce the above copyright
00017 //     notice, this list of conditions and the following disclaimer in the
00018 //     documentation and/or other materials provided with the distribution.
00019 // 
00020 //  3. The name of the authors may not be used to endorse or promote
00021 //     products derived from this software without specific prior written
00022 //     permission.
00023 // 
00024 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00025 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00026 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00027 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00028 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00029 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00030 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00031 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00032 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00033 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034 // 
00035 // This file is part of the PLearn library. For more information on the PLearn
00036 // library, go to the PLearn Web site at www.plearn.org
00037 
00038 
00039 /* *******************************************************      
00040  * $Id: BinaryClassificationLossVariable.h 3994 2005-08-25 13:35:03Z chapados $
00041  * This file is part of the PLearn library.
00042  ******************************************************* */
00043 
00044 #ifndef BinaryClassificationLossVariable_INC
00045 #define BinaryClassificationLossVariable_INC
00046 
00047 #include "BinaryVariable.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00053 class BinaryClassificationLossVariable: public BinaryVariable
00054 {
00055     typedef BinaryVariable inherited;
00056 
00057 public:
00058 
00059     int class_1, class_2;
00060     real threshold;
00061   
00063     BinaryClassificationLossVariable();
00064     BinaryClassificationLossVariable(Variable* netout, Variable* classnum);
00065 
00066     PLEARN_DECLARE_OBJECT(BinaryClassificationLossVariable);
00067 
00068     virtual void build();
00069 
00070     virtual void recomputeSize(int& l, int& w) const;
00071     virtual void fprop();
00073     virtual void bprop() {}
00074 
00075 private:
00076     void build_();
00077 
00078 protected:
00080     static void declareOptions(OptionList& ol);
00081 
00082 };
00083 
00084 DECLARE_OBJECT_PTR(BinaryClassificationLossVariable);
00085 
00086 inline Var binary_classification_loss(Var network_output, Var classnum)
00087 { 
00088     if (classnum->isScalar()) {
00089         return new BinaryClassificationLossVariable(network_output, classnum); 
00090     } else {
00091         PLERROR("In binary_classification_loss : Can only be used with a scalar output");
00092         // The line below is just for the compiler to stop complaining.
00093         return new BinaryClassificationLossVariable(network_output, classnum);
00094     }
00095 }
00096 
00097 } // end of namespace PLearn
00098 
00099 #endif 
00100 
00101 
00102 /*
00103   Local Variables:
00104   mode:c++
00105   c-basic-offset:4
00106   c-file-style:"stroustrup"
00107   c-file-offsets:((innamespace . 0)(inline-open . 0))
00108   indent-tabs-mode:nil
00109   fill-column:79
00110   End:
00111 */
00112 // 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