PLearn 0.1
SplitModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SplitModule.h
00004 //
00005 // Copyright (C) 2007 Yoshua Bengio
00006 //
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 //
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 //
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 //
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 //
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 //
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 // Authors: Yoshua Bengio
00036 
00040 #ifndef SplitModule_INC
00041 #define SplitModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 
00045 namespace PLearn {
00046 
00057 class SplitModule : public OnlineLearningModule
00058 {
00059     typedef OnlineLearningModule inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00066 
00067     string down_port_name;
00068     TVec<int> up_port_sizes;
00069     TVec<string> up_port_names;
00070 
00071 public:
00072     //#####  Public Member Functions  #########################################
00073 
00075     // ### Make sure the implementation in the .cc
00076     // ### initializes all fields to reasonable default values.
00077     SplitModule();
00078 
00079     // Your other public member functions go here
00080 
00093     void fprop(const TVec<Mat*>& ports_value);
00094 
00116     virtual void bpropAccUpdate(const TVec<Mat*>& ports_value,
00117                                 const TVec<Mat*>& ports_gradient);
00118 
00119 
00123     virtual void forget() {}
00124 
00125 
00129     virtual const TVec<string>& getPorts();
00130 
00142     virtual const TMat<int>& getPortSizes();
00143 
00145     int nPorts();
00146 
00147     //#####  PLearn::Object Protocol  #########################################
00148 
00149     // Declares other standard object methods.
00150     // ### If your class is not instantiatable (it has pure virtual methods)
00151     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00152     PLEARN_DECLARE_OBJECT(SplitModule);
00153 
00154     // Simply calls inherited::build() then build_()
00155     virtual void build();
00156 
00158     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00159 
00160 
00161 protected:
00162     //#####  Protected Member Functions  ######################################
00163 
00165     static void declareOptions(OptionList& ol);
00166 
00167 private:
00168     //#####  Private Member Functions  ########################################
00169 
00171     void build_();
00172 
00173 private:
00174     //#####  Private Data Members  ############################################
00175 
00176     // The rest of the private stuff goes here
00177 
00178     TVec<string> port_names;
00179     TMat<int> sizes;
00180 
00181 };
00182 
00183 // Declares a few other classes and functions related to this class
00184 DECLARE_OBJECT_PTR(SplitModule);
00185 
00186 } // end of namespace PLearn
00187 
00188 #endif
00189 
00190 
00191 /*
00192   Local Variables:
00193   mode:c++
00194   c-basic-offset:4
00195   c-file-style:"stroustrup"
00196   c-file-offsets:((innamespace . 0)(inline-open . 0))
00197   indent-tabs-mode:nil
00198   fill-column:79
00199   End:
00200 */
00201 // 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