PLearn 0.1
ReIndexedTargetVariable.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: ReIndexedTargetVariable.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef ReIndexedTargetVariable_INC
00044 #define ReIndexedTargetVariable_INC
00045 
00046 #include "BinaryVariable.h"
00047 #include <plearn/vmat/VMat.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 /*
00053   Inspired from ReIndexedTargetVMatrix, this variable reindexes a
00054   variable (input1) according to the getValues(row,target_col,values) function of
00055   a given VMatrix. The user must specify the input part of the VMatrix
00056   (input2), and the columns numbers corresponding to input1's fields. 
00057   In order to construct a row when calling getValues(row,target_col,values), 
00058   input2 is used for the input part, and the rest of the row is filled
00059   with NaN.
00060   The user can, alternatively, directly give a Dictionary object
00061   that will give the possible values. Then, input2 is ignored.
00062 */
00063 class ReIndexedTargetVariable: public BinaryVariable
00064 {
00065     typedef BinaryVariable inherited;
00066 
00067 protected:
00068     Vec row;
00069     Vec values;
00070     TVec<string> options;
00071 
00072 public:
00074     VMat source;
00076     TVec<int> target_cols;
00079     PP<Dictionary> dict;
00080 
00081 public:
00083     ReIndexedTargetVariable();
00084     ReIndexedTargetVariable(Variable* input1, Variable* input2, VMat the_source, TVec<int> the_target_cols);
00085     ReIndexedTargetVariable(Variable* input1, Variable* input2, PP<Dictionary> the_dict, TVec<int> the_target_cols);
00086 
00087     PLEARN_DECLARE_OBJECT(ReIndexedTargetVariable);
00088     static void declareOptions(OptionList &ol);
00089 
00090     virtual void build();
00091 
00092     virtual void recomputeSize(int& l, int& w) const;  
00093     virtual void fprop();
00094     virtual void bprop();
00095     virtual void symbolicBprop();
00096     virtual void rfprop();
00097     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00098 
00099 protected:
00100     void build_();
00101 };
00102 
00103 DECLARE_OBJECT_PTR(ReIndexedTargetVariable);
00104 
00105 inline Var reindexed_target(Var target, Var input, VMat source, TVec<int> target_cols)
00106 { return new ReIndexedTargetVariable(target,input,source,target_cols); }
00107 
00108 inline Var reindexed_target(Var target, Var input, PP<Dictionary> dict, TVec<int> target_cols)
00109 { return new ReIndexedTargetVariable(target,input,dict,target_cols); }
00110 
00111 
00112 } // end of namespace PLearn
00113 
00114 #endif 
00115 
00116 
00117 /*
00118   Local Variables:
00119   mode:c++
00120   c-basic-offset:4
00121   c-file-style:"stroustrup"
00122   c-file-offsets:((innamespace . 0)(inline-open . 0))
00123   indent-tabs-mode:nil
00124   fill-column:79
00125   End:
00126 */
00127 // 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