contrib/mul/mbl/mbl_file_data_wrapper.h

Go to the documentation of this file.

// This is mul/mbl/mbl_file_data_wrapper.h
#ifndef mbl_file_data_wrapper_h
#define mbl_file_data_wrapper_h
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \author Tim Cootes
// \brief A wrapper to provide access to sets of objects

#include <vsl/vsl_binary_io.h>
#include <mbl/mbl_data_wrapper.h>
#include <vcl_string.h>

//: Base class for objects which can return a set of objects, one at a time
//  This is an iterator-like object.  However, unlike STL, generality is
//  obtained by deriving from the class rather than providing a similar
//  interface.
//
//  In particular one can query the object to find out how many examples
//  to expect.
//
//  A typical use is to allow clients to build
//  models from sets of data without having to hold all the data in memory
//  at once.
//
//  Example:
//  \code
//  vnl_vector<double> my_sum(mbl_file_data_wrapper<vnl_vector<double> >& data)
//  {
//    data.reset();
//    vnl_vector<double> sum = data.current();
//    while (data.next())
//      sum += data.current();
//  }
//  \endcode
//
//  Note: It should be fairly simple to provide an iterator type object
//  which steps through the examples in a standard STL way by using this class.

template<class T>
class mbl_file_data_wrapper : public mbl_data_wrapper<T>
{
  // file stream
  vsl_b_ifstream bfs_;

  // path to file holding all data
  vcl_string path_;

  // data
  T d_;

  // current index of data
  unsigned long index_;

  // size of data
    unsigned long size_;

 public:
#if 0
  //: Default constructor
  mbl_file_data_wrapper();
#endif

  // constructors
  mbl_file_data_wrapper(const vcl_string path);

  //: Default destructor
  virtual ~mbl_file_data_wrapper();

  //: count number of data items
  void calc_data_size();

  //: Number of objects available
  virtual unsigned long size() const;

  //: Reset so that current() returns first object
  virtual void reset();

  //: Return current object
  virtual const T& current();

  //: Move to next object, returning true if is valid
  virtual bool next();

  //: Return current index
  //  First example has index 0
  virtual unsigned long index() const;

#if 0
  //: Move to element n
  //  First example has index 0
  virtual void set_index(unsigned long n);
#endif

  //: Create copy on heap and return base pointer
  // This will create an independent iterator on the underlying data.
  // The original data is not copied.
  // Be careful of destruction of underlying data.
  virtual mbl_data_wrapper< T >* clone() const;

  //: Name of the class
  virtual vcl_string is_a() const;

  //: True if this is (or is derived from) class named s
  virtual bool is_class(vcl_string const& s) const;
};

#endif // mbl_file_data_wrapper_h