PLearn 0.1
MatrixSumOfVariable.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: MatrixSumOfVariable.h 9436 2008-09-04 18:48:55Z nouiz $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #ifndef MatrixSumOfVariable_INC
00044 #define MatrixSumOfVariable_INC
00045 
00046 #include "NaryVariable.h"
00047 #include <plearn/math/TMat_maths.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00053 class MatrixSumOfVariable: public NaryVariable
00054 {
00055     typedef NaryVariable inherited;
00056 
00057 public:
00058     //protected:
00059     VMat distr;
00060     Func f;
00061     int nsamples;
00062     int input_size;
00063     int curpos; 
00064     // To avoid allocation/deallocations in fprop/bprop
00065     Vec input_value;
00066     Vec input_gradient;
00067     Vec output_value;
00068     
00069 public:
00071     MatrixSumOfVariable() : distr(), f(), nsamples(), input_size(), curpos() {}
00073     MatrixSumOfVariable(VMat the_distr, Func the_f, int the_nsamples=-1, int the_input_size=-1);
00074     
00075     PLEARN_DECLARE_OBJECT(MatrixSumOfVariable);
00076     static void declareOptions(OptionList &ol);
00077 
00078     virtual void build();
00079 
00080     virtual void recomputeSize(int& l, int& w) const;
00081     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00082     virtual void fprop();
00083     virtual void bprop();
00084     virtual void fbprop();
00085     virtual void symbolicBprop();
00086     virtual void rfprop();
00087     
00088     void printInfo(bool print_gradient);
00089 
00090 protected:
00091     void build_();
00092 };
00093 
00094 DECLARE_OBJECT_PTR(MatrixSumOfVariable);
00095 
00096 // sumOf with matrix as inputs
00097 inline Var sumOf(VMat distr, Func f, int nsamples, int input_size)
00098 { return new MatrixSumOfVariable(distr,f,nsamples,input_size); }
00099 
00100 // meanOf with matrix as inputs
00101 inline Var meanOf(VMat distr, Func f, int nsamples, int input_size)
00102 { return new MatrixSumOfVariable(distr, f/nsamples, nsamples, input_size); }
00103 
00104 } // end of namespace PLearn
00105 
00106 #endif 
00107 
00108 
00109 /*
00110   Local Variables:
00111   mode:c++
00112   c-basic-offset:4
00113   c-file-style:"stroustrup"
00114   c-file-offsets:((innamespace . 0)(inline-open . 0))
00115   indent-tabs-mode:nil
00116   fill-column:79
00117   End:
00118 */
00119 // 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