PLearn 0.1
MovingAverageVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // MovingAverageVMatrix.h
00004 //
00005 // Copyright (C) 2004 Yoshua Bengio
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 /* *******************************************************
00036  * $Id: MovingAverageVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00037  ******************************************************* */
00038 
00039 // Authors: Yoshua Bengio
00040 
00044 #ifndef MovingAverageVMatrix_INC
00045 #define MovingAverageVMatrix_INC
00046 
00047 #include "SourceVMatrix.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class MovingAverageVMatrix: public SourceVMatrix
00053 {
00054     typedef SourceVMatrix inherited;
00055 
00056 protected:
00057     // *********************
00058     // * protected options *
00059     // *********************
00060 
00061     Mat sums; // at (i,j), sum from the beginning of the source vmatrix at column j, up to row i
00062     Mat ma;  // moving average of width window_sizes[j] = (sums(i,j)-sums(i-window_sizes[j]))/window_sizes[j]
00063     TMat<int> nnonmissing; // at (i,j): nb of non-missing encountered in the source vmatrix at column j, up to row i
00064     Vec row;
00065     Vec previous_sourcerow;
00066     TVec<int> columns;
00067     int max_window_size;
00068 
00069 public:
00070 
00071     // ************************
00072     // * public build options *
00073     // ************************
00074 
00075     // ### declare public option fields (such as build options) here
00076     TVec<string> columns_to_average;
00077     TVec<int> window_sizes;
00078     bool centered_windows;
00079 
00080     // ****************
00081     // * Constructors *
00082     // ****************
00083 
00084     // Default constructor, make sure the implementation in the .cc
00085     // initializes all fields to reasonable default values.
00086     MovingAverageVMatrix();
00087 
00088     // ******************
00089     // * Object methods *
00090     // ******************
00091 
00092 private:
00094     // (Please implement in .cc)
00095     void build_();
00096 
00097 protected:
00099     // (Please implement in .cc)
00100     static void declareOptions(OptionList& ol);
00101 
00102 public:
00104     virtual void getNewRow(int i, Vec& v) const;
00105 
00106     // simply calls inherited::build() then build_()
00107     virtual void build();
00108 
00110     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00111 
00113     PLEARN_DECLARE_OBJECT(MovingAverageVMatrix);
00114 
00115 };
00116 DECLARE_OBJECT_PTR(MovingAverageVMatrix);
00117 
00118 } // end of namespace PLearn
00119 #endif
00120 
00121 
00122 /*
00123   Local Variables:
00124   mode:c++
00125   c-basic-offset:4
00126   c-file-style:"stroustrup"
00127   c-file-offsets:((innamespace . 0)(inline-open . 0))
00128   indent-tabs-mode:nil
00129   fill-column:79
00130   End:
00131 */
00132 // 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