PLearn 0.1
PlusManyVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PlusManyVariable.h
00004 //
00005 // Copyright (C) 2008 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 PlusManyVariable_INC
00041 #define PlusManyVariable_INC
00042 
00043 #include <plearn/var/NaryVariable.h>
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00050 class PlusManyVariable : public NaryVariable
00051 {
00052     typedef NaryVariable inherited;
00053 
00054 public:
00055     //#####  Public Build Options  ############################################
00056 
00059 
00060 public:
00061     //#####  Public Member Functions  #########################################
00062 
00064     PlusManyVariable();
00065 
00067     PlusManyVariable(const VarArray& the_array, bool call_build_ = true);
00068 
00069     // Your other public member functions go here
00070 
00071     //#####  PLearn::Variable methods #########################################
00072     virtual void recomputeSize(int& l, int& w) const;
00073     virtual void fprop();
00074     virtual void bprop();
00075 
00076     //#####  PLearn::Object Protocol  #########################################
00077 
00078     // Declares other standard object methods.
00079     PLEARN_DECLARE_OBJECT(PlusManyVariable);
00080 
00081     // Simply calls inherited::build() then build_()
00082     virtual void build();
00083 
00085     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00086 
00087 protected:
00088     //#####  Protected Options  ###############################################
00089 
00090     // ### Declare protected option fields (such as learned parameters) here
00091     // ...
00092 
00093 protected:
00094     //#####  Protected Member Functions  ######################################
00095 
00097     static void declareOptions(OptionList& ol);
00098 
00099 private:
00100     //#####  Private Member Functions  ########################################
00101 
00103     void build_();
00104 
00105 private:
00106     //#####  Private Data Members  ############################################
00107 
00108     // The rest of the private stuff goes here
00109 };
00110 
00111 // Declares a few other classes and functions related to this class
00112 DECLARE_OBJECT_PTR(PlusManyVariable);
00113 
00114 // ### Put here a convenient method for building your variable from other
00115 // ### existing ones, or a VarArray.
00116 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo
00117 // ### and bar_type bar, you could write, depending on your constructor:
00118 // inline Var toto(Var v1, Var v2, Var v3,
00119 //                 foo_type foo=default_foo, bar_type bar=default_bar)
00120 // { return new TotoVariable(v1, v2, v3, foo, bar); }
00121 // ### or:
00122 // inline Var toto(Var v1, Var v2, v3
00123 //                 foo_type foo=default_foo, bar_type bar=default_bar)
00124 // { return new TotoVariable(v1 & v2 & v3, foo, bar); }
00125 // ### or:
00126 // inline Var toto(const VarArray& varray, foo_type foo=default_foo,
00127 //                 bar_type bar=default_bar)
00128 // { return new TotoVariable( varray, foo, bar); }
00129 
00130 } // end of namespace PLearn
00131 
00132 #endif
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // 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