PLearn 0.1
NLLNeighborhoodWeightsVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // NLLNeighborhoodWeightsVariable.h
00004 //
00005 // Copyright (C) 2006 Hugo Larochelle
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: Hugo Larochelle
00036 
00040 #ifndef NLLNeighborhoodWeightsVariable_INC
00041 #define NLLNeighborhoodWeightsVariable_INC
00042 
00043 #include <plearn/var/BinaryVariable.h>
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00053 class NLLNeighborhoodWeightsVariable : public BinaryVariable
00054 {
00055     typedef BinaryVariable inherited;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00061     int n;
00063     real alpha;
00064 
00065 public:
00066     //#####  Public Member Functions  #########################################
00067 
00069     NLLNeighborhoodWeightsVariable();
00070 
00072     NLLNeighborhoodWeightsVariable(Variable* neighbor_nlls, Variable* neighbor_indexes, int n, real alpha);
00073 
00074     //#####  PLearn::Variable methods #########################################
00075     // (PLEASE IMPLEMENT IN .cc)
00076     virtual void recomputeSize(int& l, int& w) const;
00077     virtual void fprop();
00078     virtual void bprop();
00079 
00080     // ### These ones are not always implemented
00081     // virtual void bbprop();
00082     // virtual void symbolicBprop();
00083     // virtual void rfprop();
00084 
00085     //#####  PLearn::Object Protocol  #########################################
00086 
00087     // Declares other standard object methods.
00088     // ### If your class is not instantiatable (it has pure virtual methods)
00089     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00090     PLEARN_DECLARE_OBJECT(NLLNeighborhoodWeightsVariable);
00091 
00092     // Simply calls inherited::build() then build_()
00093     virtual void build();
00094 
00096     // (PLEASE IMPLEMENT IN .cc)
00097     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00098 
00099 protected:
00100     //#####  Protected Options  ###############################################
00101 
00103     TVec<real> online_weights_log_sum;
00105     real log_alpha;
00106     real log_1_minus_alpha;
00107 
00108 protected:
00109     //#####  Protected Member Functions  ######################################
00110 
00112     // (PLEASE IMPLEMENT IN .cc)
00113     static void declareOptions(OptionList& ol);
00114 
00115 private:
00116     //#####  Private Member Functions  ########################################
00117 
00119     // (PLEASE IMPLEMENT IN .cc)
00120     void build_();
00121 
00122 private:
00123     //#####  Private Data Members  ############################################
00124 
00125     // The rest of the private stuff goes here
00126 };
00127 
00128 // Declares a few other classes and functions related to this class
00129 DECLARE_OBJECT_PTR(NLLNeighborhoodWeightsVariable);
00130 
00131 inline Var nll_neighborhood_weights(Var neighbor_nlls, Var neighbor_indexes, int n, real alpha)
00132  { 
00133      return new NLLNeighborhoodWeightsVariable(neighbor_nlls, neighbor_indexes, n, alpha); 
00134  }
00135 
00136 } // end of namespace PLearn
00137 
00138 #endif
00139 
00140 
00141 /*
00142   Local Variables:
00143   mode:c++
00144   c-basic-offset:4
00145   c-file-style:"stroustrup"
00146   c-file-offsets:((innamespace . 0)(inline-open . 0))
00147   indent-tabs-mode:nil
00148   fill-column:79
00149   End:
00150 */
00151 // 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