DiskVMatrix.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: DiskVMatrix.h,v 1.12 2004/07/07 17:30:48 tihocan Exp $
   ******************************************************* */


#ifndef DiskVMatrix_INC
#define DiskVMatrix_INC

#include "RowBufferedVMatrix.h"
#include <cstdio>

namespace PLearn {
using namespace std;
 

class DiskVMatrix: public RowBufferedVMatrix
{
  typedef RowBufferedVMatrix inherited;

protected:
  mutable FILE* indexf;
  mutable TVec<FILE*> dataf;
  bool freshnewfile;
  bool old_format; // is thisfile in the old deprecated format?
  bool swap_endians; // was this file written in the opposite endian order
public:

  // Build options
  string dirname;
  //bool readwritemode;
  double tolerance;    // the error tolerance for storing doubles as floats
  
  DiskVMatrix();

  DiskVMatrix(const string& the_dirname, bool readwrite=false); 

  DiskVMatrix(const string& the_dirname, int the_width, bool write_double_as_float=false);

  virtual void putRow(int i, Vec v);
  virtual void appendRow(Vec v);
  virtual void flush();

  virtual void build();

protected:

  virtual void getNewRow(int i, const Vec& v) const;
  static void declareOptions(OptionList & ol);

public:

  PLEARN_DECLARE_OBJECT(DiskVMatrix);

  
  virtual ~DiskVMatrix();
private:
  void build_();
};

DECLARE_OBJECT_PTR(DiskVMatrix);

} // end of namespace PLearn
#endif

---