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 "tree/sparse-tree.cc"

using namespace std;

namespace libpmk {
template class SparseTree<Bin>;


class MultiResolutionHistogram {
public:
  MultiResolutionHistogram() { }

  int size() const { return tree_.size(); }


  Bin* bin(LargeIndex index);


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

  Bin* root() { return tree_.root(); }
  Bin* const root() const { return tree_.root(); }


  Bin* add_bin(const Bin& new_bin);

  // Same as add_bin(), 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* add_bin(const Bin& new_bin, Bin* finger);

  void remove_bin(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:
  SparseTree<Bin> tree_;
};
}  // namespace libpmk
#endif  // HISTOGRAMS_MULTI_RESOLUTION_HISTOGRAM_H

---