multi-resolution-histogram.h

Go to the documentation of this file.

// Copyright 2007, Massachusetts Institute of Technology.
// The use of this code is permitted for research only. There is
// absolutely no warranty for this software.
//
// Author: John Lee (jjl@mit.edu)
//

#ifndef HISTOGRAMS_MULTI_RESOLUTION_HISTOGRAM_H
#define HISTOGRAMS_MULTI_RESOLUTION_HISTOGRAM_H

#include <iostream>
#include "histograms/bin.h"
#include "util/tree.cc"

using namespace std;

namespace libpmk {
template class Tree<Bin>;


class MultiResolutionHistogram {
 public:
   MultiResolutionHistogram() { }

   int GetNumLevels() const;
   int GetNumBins() const;


   Bin* GetBin(LargeIndex index);


   Bin* GetBin(LargeIndex index, Bin* finger);

   Bin* GetRootBin();
   Bin* const GetRootBin() const;


   Bin* AddBin(const Bin& new_bin);

   // Same as AddBin(), except if the user already has a pointer to the
   // parent, use that. If the parent is invalid, NULL is returned and 
   // no bin is added. In order for this to work properly, the parent pointer
   // MUST be a bin which can be accessed through child pointers of
   // root_bin_. In other words, this MultiResolutionHistogram must be the
   // owner of the parent that you pass into it. We do NOT check for this;
   // it is up to the client to make sure of it.

   Bin* AddBin(const Bin& new_bin, Bin* finger);

   void DeleteBin(Bin* finger);


   static vector<MultiResolutionHistogram*>
      ReadFromStream(istream& input_stream);
   

   static vector<MultiResolutionHistogram*>
      ReadFromFile(const char* filename);


   static vector<MultiResolutionHistogram*>
      ReadSelectionFromStream(istream& input_stream,
                              int start, int selection_size);


   static vector<MultiResolutionHistogram*>
      ReadSelectionFromFile(const char* filename, int start,
                            int selection_size);

   static void WriteToStream(ostream& output_stream,
                             const vector<MultiResolutionHistogram*>& hists);


   static void WriteToFile(const char* filename,
                           const vector<MultiResolutionHistogram*>& hists);


   static MultiResolutionHistogram*
      ReadSingleHistogramFromStream(istream& input_stream);

   static void IgnoreSingleHistogramFromStream(istream& input_stream);
   

   static void WriteSingleHistogramToStream(ostream& output_stream,
                                            const MultiResolutionHistogram* h);
   
 private:
   Tree<Bin> tree_;   
}; 
}  // namespace libpmk
#endif  // HISTOGRAMS_MULTI_RESOLUTION_HISTOGRAM_H

---