PLearn 0.1
SumOverBagsVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039  * $Id: SumOverBagsVariable.h 9436 2008-09-04 18:48:55Z nouiz $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef SumOverBagsVariable_INC
00044 #define SumOverBagsVariable_INC
00045 
00046 #include "NaryVariable.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 
00052 class SumOverBagsVariable: public NaryVariable
00053 {
00054     typedef NaryVariable inherited;
00055 
00056 public:
00057 //protected:
00058     VMat vmat;
00059     Func f;
00060     bool average;
00061     int max_bag_size;
00062     int n_samples;
00063     bool transpose;
00064 
00065     int curpos; 
00066     // To avoid allocation/deallocations in fprop/bprop
00067     Vec output_value;
00068     Mat input_values;
00069     Vec bag_size_vec;
00070     Vec bag_target_and_bag_signal;
00071     Vec bag_target;
00072     Vec bag_signal;
00073     Vec bag_weight;
00074     Array<Vec> f_inputs; // (matrix of bag inputs, the bag size, the bag target, the bag weight)
00075     Array<Vec> unused_gradients;
00076     Array<Vec> output_av; // Array<Vec>(output_value)
00077     Array<Vec> gradient_av; // Array<Vec>(gradient)
00078     int bag_size;
00079 
00080 public:
00082     SumOverBagsVariable();
00092     SumOverBagsVariable(VMat the_vmat, Func the_f, int maxbagsize,
00093                         int nsamples, bool average,
00094                         bool transpose = false, bool call_build_ = true);
00095 
00097     static const int TARGET_COLUMN_FIRST = 1;
00098     static const int TARGET_COLUMN_LAST = 2;
00099     static const int TARGET_COLUMN_SINGLE = 3;  // Beginning == End
00100     static const int TARGET_COLUMN_INTERMEDIATE = 0;
00101 
00102     PLEARN_DECLARE_OBJECT(SumOverBagsVariable);
00103 
00104     virtual void build();
00105 
00106     virtual void recomputeSize(int& l, int& w) const;
00107     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00108     virtual void fprop();
00109     virtual void bprop();
00110     virtual void fbprop();
00111     virtual void fpropOneBag(bool do_bprop=false);
00112     
00113     void printInfo(bool print_gradient);
00114 
00115     static void declareOptions(OptionList& ol);
00116 
00117 protected:
00118     void build_();
00119 };
00120 
00121 DECLARE_OBJECT_PTR(SumOverBagsVariable);
00122 
00124 inline Var sumOverBags(VMat vmat, Func f, int max_bag_size, int nsamples, bool average = false, bool transpose = false)
00125 { return new SumOverBagsVariable(vmat, f, max_bag_size, nsamples, average, transpose); }
00126 
00127 } // end of namespace PLearn
00128 
00129 #endif 
00130 
00131 
00132 /*
00133   Local Variables:
00134   mode:c++
00135   c-basic-offset:4
00136   c-file-style:"stroustrup"
00137   c-file-offsets:((innamespace . 0)(inline-open . 0))
00138   indent-tabs-mode:nil
00139   fill-column:79
00140   End:
00141 */
00142 // 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