YMDDatedVMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2001 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
// Copyright (C) 2002 Pascal Vincent, Julien Keable, Xavier Saint-Mleux
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


/* *******************************************************      
   * $Id: YMDDatedVMatrix.h,v 1.4 2004/04/05 23:12:54 morinf Exp $
   ******************************************************* */


#ifndef YMDDatedVMatrix_INC
#define YMDDatedVMatrix_INC

#include "DatedVMatrix.h"
#include "VMat.h"

namespace PLearn {
using namespace std;
 
class YMDDatedVMatrix: public DatedVMatrix
{
    typedef DatedVMatrix inherited;

public:
  VMat data;
protected:
  Mat years; 
  Mat months; 
  Mat days; 
  Vec pos_of_ith_year; 
  Vec pos_of_ith_month; 
  Vec pos_of_ith_day; 
  Vec day_of_ith_pos; 
  Array< TMat<int> > pos_of_date; 


public:
  // ******************
  // *  Constructors  *
  // ******************
  YMDDatedVMatrix(); 

  YMDDatedVMatrix(VMat data_, Mat years_, Mat months_, Mat days_);

  YMDDatedVMatrix(Mat& YMD_and_data);

  PLEARN_DECLARE_OBJECT(YMDDatedVMatrix);
  static void declareOptions(OptionList &ol);

  virtual void build();

  int nDateFields() { return 3; }

  VMat subDistrRelativeDates(int first, int n, const string& units);
  VMat subDistrRelativeYears(int first_relative_year, int n_years);
  VMat subDistrRelativeMonths(int first_relative_month, int n_months);
  VMat subDistrRelativeDays(int first_relative_day, int n_days);

  VMat subDistrAbsoluteYears(int year, int month, int day, int n_years);
  VMat subDistrAbsoluteMonths(int year, int month, int day, int n_months);
  VMat subDistrAbsoluteDays(int year, int month, int day, int n_days);
  VMat subDistrAbsoluteUnits(int year, int month, int day, int n_units, const string& units);

  int lengthInDates(const string& units);

  int positionOfRelativeDate(int first, const string& units);

  int positionOfDate(int year, int month, int day);

  void copyDatesOfRows(int from_row, int n_rows, Mat& dates);
  
  // added by Julien Keable :
  // returns vector of row at indice 'row'
  // and associated date trough year, month and day
  Vec copyRowDataAndDate(int row, int &year, int &month, int &day);
  void copyDateOfRow(int row, int &year, int &month, int &day);

  virtual void reset_dimensions() { PLERROR("YMDDatedVMatrix::reset_dimensions() not implemented"); }
private:
    void build_();
};

DECLARE_OBJECT_PTR(YMDDatedVMatrix);

} // end of namespace PLearn
#endif

---