PLearn 0.1
SoftSoftMaxVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SoftSoftMaxVariable.h
00004 //
00005 // Copyright (C) 2007 Simon Lemieux, Pascal Vincent
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: Simon Lemieux, Pascal Vincent
00036 
00040 #ifndef SoftSoftMaxVariable_INC
00041 #define SoftSoftMaxVariable_INC
00042 
00043 #include <plearn/var/BinaryVariable.h>
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00058 class SoftSoftMaxVariable : public BinaryVariable
00059 {
00060     typedef BinaryVariable inherited;
00061 
00062 public:
00063     //#####  Public Build Options  ############################################
00064 
00067 
00068 public:
00069     //#####  Public Member Functions  #########################################
00070 
00072     SoftSoftMaxVariable(){}
00073 
00075     // ### Make sure the implementation in the .cc calls inherited constructor
00076     // ### and initializes all fields with reasonable default values.
00077     SoftSoftMaxVariable(Variable* input1, Variable* input2);
00078 
00079     // Your other public member functions go here
00080 
00081     //#####  PLearn::Variable methods #########################################
00082     virtual void recomputeSize(int& l, int& w) const;
00083     virtual void fprop();
00084     virtual void bprop();
00085 
00086     // ### These ones are not always implemented
00087     // virtual void bbprop();
00088     // virtual void symbolicBprop();
00089     // virtual void rfprop();
00090 
00091     //#####  PLearn::Object Protocol  #########################################
00092 
00093     // Declares other standard object methods.
00094     // ### If your class is not instantiatable (it has pure virtual methods)
00095     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00096     PLEARN_DECLARE_OBJECT(SoftSoftMaxVariable);
00097 
00098     // Simply calls inherited::build() then build_()
00099     virtual void build();
00100 
00102     // (PLEASE IMPLEMENT IN .cc)
00103     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00104 
00105 protected:
00106     //#####  Protected Options  ###############################################
00107 
00108     // ### Declare protected option fields (such as learned parameters) here
00109     // ...
00110 
00111 protected:
00112     //#####  Protected Member Functions  ######################################
00113 
00115     // (PLEASE IMPLEMENT IN .cc)
00116     static void declareOptions(OptionList& ol);
00117 
00118 private:
00119     //#####  Private Member Functions  ########################################
00120 
00122     // (PLEASE IMPLEMENT IN .cc)
00123     void build_();
00124 
00125 private:
00126     //#####  Private Data Members  ############################################
00127 
00128     // The rest of the private stuff goes here
00129     Mat logH_mat; // storage for keeping log of hidden
00130 };
00131 
00132 // Declares a few other classes and functions related to this class
00133 DECLARE_OBJECT_PTR(SoftSoftMaxVariable);
00134 
00135 // ### Put here a convenient method for building your variable from two
00136 // ### existing ones.
00137 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo
00138 // ### and bar_type bar, you could write:
00139 // inline Var toto(Var v1, Var v2,
00140 //                 foo_type foo=default_foo, bar_type bar=default_bar)
00141 // { return new TotoVariable(v1, v2, foo, bar); }
00142 
00143 } // end of namespace PLearn
00144 
00145 #endif
00146 
00147 
00148 /*
00149   Local Variables:
00150   mode:c++
00151   c-basic-offset:4
00152   c-file-style:"stroustrup"
00153   c-file-offsets:((innamespace . 0)(inline-open . 0))
00154   indent-tabs-mode:nil
00155   fill-column:79
00156   End:
00157 */
00158 // 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