PLearn 0.1
ExtendedVariable.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: ExtendedVariable.h 3994 2005-08-25 13:35:03Z chapados $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef ExtendedVariable_INC
00044 #define ExtendedVariable_INC
00045 
00046 #include "UnaryVariable.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00061 class ExtendedVariable: public UnaryVariable
00062 {
00063     typedef UnaryVariable inherited;
00064 
00065 public:
00066     int top_extent;
00067     int bottom_extent;
00068     int left_extent;
00069     int right_extent;
00070     real fill_value; 
00071 
00072 public:
00074     ExtendedVariable()
00075         : top_extent(), bottom_extent(), left_extent(), right_extent(), fill_value()
00076     {}
00077     ExtendedVariable(Variable* input, 
00078                      int the_top_extent, int the_bottom_extent, 
00079                      int the_left_extent, int the_right_extent, 
00080                      real the_fill_value);
00081 
00082     PLEARN_DECLARE_OBJECT(ExtendedVariable);
00083     static void declareOptions(OptionList &ol);
00084 
00085     virtual void build();
00086 
00087     virtual void recomputeSize(int& l, int& w) const;  
00088     virtual void fprop();
00089     virtual void bprop();
00090     virtual void symbolicBprop();
00091     virtual void rfprop();
00092 
00093 protected:
00094     void build_();
00095 };
00096 
00097 DECLARE_OBJECT_PTR(ExtendedVariable);
00098 
00100 inline Var extend(Var v, int top_extent, int bottom_extent, int left_extent, int right_extent, real fill_value=0.0)
00101 { return new ExtendedVariable(v,top_extent,bottom_extent,left_extent,right_extent,fill_value); }
00102 
00104 inline Var extend(Var v, real extension_value = 1.0, int n_extend = 1)
00105 { 
00106     if(v->isColumnVec())
00107         return new ExtendedVariable(v,0,n_extend,0,0,extension_value); 
00108     else if(v->isRowVec())
00109         return new ExtendedVariable(v,0,0,0,n_extend,extension_value); 
00110     PLERROR("In extend(Var v, real extension_value = 1.0, int n_extend = 1) v is not a vector (single row or single column)");
00111     return Var();
00112 }
00113 
00114 
00115 } // end of namespace PLearn
00116 
00117 #endif 
00118 
00119 
00120 /*
00121   Local Variables:
00122   mode:c++
00123   c-basic-offset:4
00124   c-file-style:"stroustrup"
00125   c-file-offsets:((innamespace . 0)(inline-open . 0))
00126   indent-tabs-mode:nil
00127   fill-column:79
00128   End:
00129 */
00130 // 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