PLearn 0.1
DatedVMatrix.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-2001 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2002 Pascal Vincent, Julien Keable, Xavier Saint-Mleux
00007 //
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions are met:
00010 //
00011 //  1. Redistributions of source code must retain the above copyright
00012 //     notice, this list of conditions and the following disclaimer.
00013 //
00014 //  2. Redistributions in binary form must reproduce the above copyright
00015 //     notice, this list of conditions and the following disclaimer in the
00016 //     documentation and/or other materials provided with the distribution.
00017 //
00018 //  3. The name of the authors may not be used to endorse or promote
00019 //     products derived from this software without specific prior written
00020 //     permission.
00021 //
00022 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00023 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00024 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00025 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00026 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00027 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032 //
00033 // This file is part of the PLearn library. For more information on the PLearn
00034 // library, go to the PLearn Web site at www.plearn.org
00035 
00036 
00037 /* *******************************************************
00038  * $Id: DatedVMatrix.h 8239 2007-11-09 15:35:34Z nouiz $
00039  ******************************************************* */
00040 
00041 
00044 #ifndef DatedVMatrix_INC
00045 #define DatedVMatrix_INC
00046 
00047 #include "VMat.h"
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 
00059 class DatedVMatrix: public VMatrix
00060 {
00061     typedef VMatrix inherited;
00062 
00063 public:
00064     // ******************
00065     // *  Constructors  *
00066     // ******************
00067     DatedVMatrix() {}; 
00068 
00069     DatedVMatrix(int width, int length) : inherited(width,length) {}
00070 
00075     virtual VMat subDistrRelativeDates(int first, int n, const string& units) = 0;
00076 
00081     virtual VMat subDistrAbsoluteUnits(int year, int month, int day, int n_units,
00082                                        const string& units) = 0;
00083 
00085     virtual int lengthInDates(const string& units) = 0;
00086 
00089     virtual int positionOfRelativeDate(int first, const string& units) = 0;
00090 
00092     virtual int nDateFields() = 0;
00093 
00096     virtual void copyDatesOfRows(int from_row, int n_rows, Mat& dates) = 0;
00097 
00098     // added by Julien Keable :
00099     // returns vector of row at indice 'row'
00100     // and associated date trough year, month and day
00101     virtual Vec copyRowDataAndDate(int row, int &year, int &month, int &day)=0;
00102     virtual void copyDateOfRow(int row, int &year, int &month, int &day)=0;
00103 
00104     PLEARN_DECLARE_ABSTRACT_OBJECT(DatedVMatrix);
00105 
00106     static void declareOptions(OptionList &ol);
00107     virtual void build();
00108 private:
00109     void build_();
00110 };
00111 
00112 DECLARE_OBJECT_PTR(DatedVMatrix);
00113 
00114 } // end of namespace PLearn
00115 #endif
00116 
00117 
00118 /*
00119   Local Variables:
00120   mode:c++
00121   c-basic-offset:4
00122   c-file-style:"stroustrup"
00123   c-file-offsets:((innamespace . 0)(inline-open . 0))
00124   indent-tabs-mode:nil
00125   fill-column:79
00126   End:
00127 */
00128 // 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