PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // NetworkConnection.h 00004 // 00005 // Copyright (C) 2007 Olivier Delalleau 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: Olivier Delalleau 00036 00040 #ifndef NetworkConnection_INC 00041 #define NetworkConnection_INC 00042 00043 #include <plearn/base/Object.h> 00044 #include <plearn_learners/online/OnlineLearningModule.h> 00045 00046 namespace PLearn { 00047 00048 class NetworkConnection : public Object 00049 { 00050 typedef Object inherited; 00051 00052 public: 00053 00054 //##### Public Build Options ############################################ 00055 00056 string source; 00057 string destination; 00058 bool propagate_gradient; 00059 00060 public: 00061 //##### Public Member Functions ######################################### 00062 00064 NetworkConnection(); 00065 00067 NetworkConnection(const string& the_source, const string& the_destination, 00068 bool the_propagate_gradient, bool call_build_ = true); 00069 00070 NetworkConnection(PP<OnlineLearningModule> the_src_module, 00071 const string& the_src_port, 00072 PP<OnlineLearningModule> the_dst_module, 00073 const string& the_dst_port, 00074 bool the_propagate_gradient, bool call_build_ = true); 00075 00080 void initialize(map<string, PP<OnlineLearningModule> >& modules); 00081 00083 static void declareOptions(OptionList& ol); 00084 00086 PP<OnlineLearningModule> getSourceModule(); 00087 00089 const string& getSourcePort(); 00090 00092 PP<OnlineLearningModule> getDestinationModule(); 00093 00095 const string& getDestinationPort(); 00096 00097 //##### PLearn::Object Protocol ######################################### 00098 00099 // Declares other standard object methods. 00100 // ### If your class is not instantiatable (it has pure virtual methods) 00101 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00102 PLEARN_DECLARE_OBJECT(NetworkConnection); 00103 00104 // Simply calls inherited::build() then build_() 00105 virtual void build(); 00106 00108 // (PLEASE IMPLEMENT IN .cc) 00109 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00110 00111 protected: 00112 00114 PP<OnlineLearningModule> src_module; 00115 00117 string src_port; 00118 00120 PP<OnlineLearningModule> dst_module; 00121 00123 string dst_port; 00124 00125 //##### Protected Options ############################################### 00126 00127 protected: 00128 //##### Protected Member Functions ###################################### 00129 00130 private: 00131 //##### Private Member Functions ######################################## 00132 00134 void build_(); 00135 00136 private: 00137 //##### Private Data Members ############################################ 00138 00139 // The rest of the private stuff goes here 00140 }; 00141 00142 // Declares a few other classes and functions related to this class 00143 DECLARE_OBJECT_PTR(NetworkConnection); 00144 00145 } // end of namespace PLearn 00146 00147 #endif 00148 00149 00150 /* 00151 Local Variables: 00152 mode:c++ 00153 c-basic-offset:4 00154 c-file-style:"stroustrup" 00155 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00156 indent-tabs-mode:nil 00157 fill-column:79 00158 End: 00159 */ 00160 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :