PLearn 0.1
ThresholdVMatrix.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-2001 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2002 Pascal Vincent, Julien Keable, Xavier Saint-Mleux
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 
00037 #ifndef ThresholdVMatrix_INC
00038 #define ThresholdVMatrix_INC
00039 
00040 #include "SourceVMatrix.h"
00041 #include "VMat.h"
00042 
00043 namespace PLearn {
00044 using namespace std;
00045 
00046 /* A bit like OneHotVMatrix with a threshold level
00047  * instead.  The last column will become cold_value
00048  * if it was <= threshold, or hot_value if it was
00049  * > threshold.
00050  * N.B. the gt_threshold boolean value can be set
00051  * to true so that we get hot_value when
00052  * val > threshold, or false for val >= threshold.
00053  */
00054 class ThresholdVMatrix: public SourceVMatrix
00055 {
00056     typedef SourceVMatrix inherited;
00057 
00058 protected:
00059 
00060     // DEPRECATED - Use inherited::source instead
00061     // VMat underlying_distr;
00062     real threshold;
00063     real cold_value;
00064     real hot_value;
00065     bool gt_threshold;
00066 
00067 public:
00068     // ******************
00069     // *  Constructors  *
00070     // ******************
00071 
00073     ThresholdVMatrix(bool call_build_ = false);
00074 
00075     ThresholdVMatrix(VMat the_source,
00076                      real threshold_,
00077                      real the_cold_value=0.0, real the_hot_value=1.0,
00078                      bool gt_threshold_ = true, bool call_build_ = false);
00079 
00080     virtual void getNewRow(int i, const Vec& v) const;
00081     virtual void reset_dimensions()
00082     {
00083         source->reset_dimensions();
00084         width_=source->width();
00085         length_=source->length();
00086     }
00087 };
00088 
00089 inline VMat thresholdVMat(VMat source, real threshold,
00090                           real cold_value=0.0, real hot_value=1.0,
00091                           bool gt_threshold = true, bool call_build_ = false)
00092 { return new ThresholdVMatrix(source, threshold, cold_value, hot_value,
00093                               gt_threshold, call_build_); }
00094 
00095 } // end of namespace PLearn
00096 #endif
00097 
00098 
00099 /*
00100   Local Variables:
00101   mode:c++
00102   c-basic-offset:4
00103   c-file-style:"stroustrup"
00104   c-file-offsets:((innamespace . 0)(inline-open . 0))
00105   indent-tabs-mode:nil
00106   fill-column:79
00107   End:
00108 */
00109 // 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