PLearn 0.1
TemporalHorizonVMatrix.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // TemporalHorizonVMatrix.h
00004 //
00005 // PLearn (A C++ Machine Learning Library)
00006 // Copyright (C) 2003 Rejean Ducharme, Yoshua Bengio
00007 // Copyright (C) 2003 Pascal Vincent
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: TemporalHorizonVMatrix.h 5557 2006-05-10 20:36:58Z lamblin $
00040  ******************************************************* */
00041 
00042 
00043 
00044 #ifndef TEMPORAL_HORIZON_VMATRIX
00045 #define TEMPORAL_HORIZON_VMATRIX
00046 
00047 #include "VMat.h"
00048 #include "SourceVMatrix.h"
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00055 class TemporalHorizonVMatrix: public SourceVMatrix
00056 {
00057     typedef SourceVMatrix inherited;
00058 
00059 protected:
00060     // DEPRECATED - Use inherited::source instead
00061     // VMat distr;  // the underlying VMat
00062     int horizon;  // the temporal value by which to delay the VMat
00063     int targetsize;  // the number of last entries to delay
00064     TVec<int> row_delay;  // delay for the row index
00065 
00066 public:
00067 
00069     TemporalHorizonVMatrix(bool call_build_ = false);
00070 
00071     TemporalHorizonVMatrix(VMat the_source,
00072                            int the_horizon, int target_size,
00073                            bool call_build_ = false);
00074 
00075     PLEARN_DECLARE_OBJECT(TemporalHorizonVMatrix);
00076 
00077     static void declareOptions(OptionList &ol);
00078 
00079     virtual void build();
00080     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00081 
00082     virtual real get(int i, int j) const;
00083     virtual void put(int i, int j, real value);
00084     virtual real getStringVal(int col, const string & str) const;
00085     virtual string getValString(int col, real val) const;
00086     virtual string getString(int row,int col) const;
00088     virtual const map<string,real>& getStringToRealMapping(int col) const;
00089     virtual const map<real,string>& getRealToStringMapping(int col) const;
00090 
00091     virtual void reset_dimensions()
00092     {
00093         source->reset_dimensions();
00094         width_=source->width();
00095     }
00096 
00097     virtual real dot(int i1, int i2, int inputsize) const;
00098     virtual real dot(int i, const Vec& v) const;
00099 
00100 private:
00101     void build_();
00102 };
00103 
00104 DECLARE_OBJECT_PTR(TemporalHorizonVMatrix);
00105 
00106 
00107 } // end of namespace PLearn
00108 #endif
00109 
00110 
00111 /*
00112   Local Variables:
00113   mode:c++
00114   c-basic-offset:4
00115   c-file-style:"stroustrup"
00116   c-file-offsets:((innamespace . 0)(inline-open . 0))
00117   indent-tabs-mode:nil
00118   fill-column:79
00119   End:
00120 */
00121 // 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