JulianizeVMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// JulianizeVMatrix.h
//
// Copyright (C) 2003  Nicolas Chapados 
// 
// 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: JulianizeVMatrix.h,v 1.10 2004/07/09 19:42:23 tihocan Exp $ 
   ******************************************************* */

#ifndef JulianizeVMatrix_INC
#define JulianizeVMatrix_INC

#include <utility>
#include <vector>
#include <algorithm>

#include "RowBufferedVMatrix.h"
#include "VMat.h"

namespace PLearn {
using namespace std;

class JulianizeVMatrix : public RowBufferedVMatrix
{
  typedef RowBufferedVMatrix inherited;

public:
  enum DateCode {
    Date = 0,                                
    DateTime = 1                             
  };

  static int dateCodeWidth(DateCode dc) {
    switch(dc) {
    case Date: return 3;
    case DateTime: return 6;
    }
    PLERROR("JulianizeVMatrix::dateCodeWidth: unknown date code");
    return 0;
  }
  
protected:
  VMat underlying_;                          
  vector< pair<int,DateCode> > cols_codes_;  
  mutable Vec und_row_;                      

public:

  
  // ************************
  // * public build options *
  // ************************

  // ### declare public option fields (such as build options) here
  // ...

  // ****************
  // * Constructors *
  // ****************

  JulianizeVMatrix();

  JulianizeVMatrix(VMat underlying,
                   DateCode date_code = Date,
                   int starting_column = 0);

  // ******************
  // * Object methods *
  // ******************

private: 
  void build_();

protected: 
  static void declareOptions(OptionList& ol);

  virtual void getNewRow(int i, const Vec& v) const;

public:

  // simply calls inherited::build() then build_() 
  virtual void build();

  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

  PLEARN_DECLARE_OBJECT(JulianizeVMatrix);

protected:
  // Return the new number of columns
  static int newWidth(VMat und, DateCode dc) {
    return und->width() - dateCodeWidth(dc) + 1;
  }

  // Set the VMFields in this VMatrix from the underlying field names.  All
  // "date" fields are named "Date", and "date-time" are named "DateTime".
  void setVMFields();
};

DECLARE_OBJECT_PTR(JulianizeVMatrix);

} // end of namespace PLearn
#endif

---