PLearn 0.1
IsAboveThresholdVariable.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: IsAboveThresholdVariable.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef IsAboveThresholdVariable_INC
00044 #define IsAboveThresholdVariable_INC
00045 
00046 #include "UnaryVariable.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051   
00053 //        OR          newx_i = (x_i>threshold ?truevalue :falsevalue);
00054 // according to the 'strict' field.
00055 class IsAboveThresholdVariable: public UnaryVariable
00056 {
00057     typedef UnaryVariable inherited;
00058 
00059 protected:
00060     real threshold, truevalue, falsevalue;
00061     bool strict;
00062 
00063 public:
00065     IsAboveThresholdVariable() : threshold(), truevalue(), falsevalue() {}
00066     IsAboveThresholdVariable(Variable* input, real the_threshold, real the_truevalue, real the_falsevalue, bool strict=false);
00067 
00068     PLEARN_DECLARE_OBJECT(IsAboveThresholdVariable);
00069     static void declareOptions(OptionList &ol);
00070 
00071     virtual void recomputeSize(int& l, int& w) const;
00072     virtual void fprop();
00073     virtual void bprop();
00074     virtual void symbolicBprop();
00075     virtual void rfprop();
00076 };
00077 
00078 DECLARE_OBJECT_PTR(IsAboveThresholdVariable);
00079 
00080 inline Var isAboveThreshold(Var v, real threshold=0, real truevalue=1, real falsevalue=0, bool strict=false)
00081 { return new IsAboveThresholdVariable(v,threshold,truevalue,falsevalue,strict); }
00082 
00083 inline Var operator>=(Var v, real threshold)
00084 { return new IsAboveThresholdVariable(v, threshold, 1, 0); }
00085 
00086 inline Var operator<=(Var v, real threshold)
00087 { return new IsAboveThresholdVariable(v, threshold, 0, 1); }
00088 
00089 } // end of namespace PLearn
00090 
00091 #endif 
00092 
00093 
00094 /*
00095   Local Variables:
00096   mode:c++
00097   c-basic-offset:4
00098   c-file-style:"stroustrup"
00099   c-file-offsets:((innamespace . 0)(inline-open . 0))
00100   indent-tabs-mode:nil
00101   fill-column:79
00102   End:
00103 */
00104 // 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