PLearn 0.1
OneHotVariable.cc
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: OneHotVariable.cc 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #include "OneHotVariable.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00051 PLEARN_IMPLEMENT_OBJECT(OneHotVariable,
00052                         "Represents a vector of a given lenth, that has value 1 at the index "
00053                         "given by another variable and 0 everywhere else",
00054                         "NO HELP");
00055 
00056 OneHotVariable::OneHotVariable(int thelength, Variable* hotindex, real the_coldvalue, real the_hotvalue)
00057     : inherited(hotindex,thelength,1), hotvalue(the_hotvalue), coldvalue(the_coldvalue), length_(thelength)
00058 {
00059     build_();
00060 }
00061 
00062 void
00063 OneHotVariable::build()
00064 {
00065     inherited::build();
00066     build_();
00067 }
00068 
00069 void
00070 OneHotVariable::build_()
00071 {
00072     // input is hotindex from constructor
00073     if (input && !input->isScalar())
00074         PLERROR("InterValuesVariable OneHotVariable(int thelength, Variable* hotindex, real the_coldvalue, real the_hotvalue) hotindex must be scalar as it is supposed to be an integer index");
00075 }
00076 
00077 void
00078 OneHotVariable::declareOptions(OptionList &ol)
00079 {
00080     declareOption(ol, "hotvalue", &OneHotVariable::hotvalue, OptionBase::buildoption, "");
00081     declareOption(ol, "coldvalue", &OneHotVariable::coldvalue, OptionBase::buildoption, "");
00082     declareOption(ol, "length_", &OneHotVariable::length_, OptionBase::buildoption, "");
00083     inherited::declareOptions(ol);
00084 }
00085 
00086 void OneHotVariable::recomputeSize(int& l, int& w) const
00087 { l=length_; w=1; }
00088 
00089 
00090 void OneHotVariable::fprop()
00091 {
00092     int index = int(input->valuedata[0]);
00093     if (nelems()==1)
00094         value[0] = index==0 ? coldvalue : hotvalue;
00095     else
00096     {
00097         for(int i=0; i<nelems(); i++)
00098             valuedata[i] = coldvalue;
00099         value[index] = hotvalue;
00100     }
00101 }
00102 
00103 
00104 void OneHotVariable::bprop() {}
00105 
00106 
00107 void OneHotVariable::symbolicBprop() {}
00108 
00109 
00110 void OneHotVariable::rfprop() {
00111     if (rValue.length()==0) resizeRValue();
00112 }
00113 
00114 
00115 
00116 } // end of namespace PLearn
00117 
00118 
00119 /*
00120   Local Variables:
00121   mode:c++
00122   c-basic-offset:4
00123   c-file-style:"stroustrup"
00124   c-file-offsets:((innamespace . 0)(inline-open . 0))
00125   indent-tabs-mode:nil
00126   fill-column:79
00127   End:
00128 */
00129 // 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